Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 105.1 >
edited by Илья Крайнов
on 2023/08/09 17:59
To version < 158.1 >
edited by Андрей Калиновский
on 2024/07/19 15:49
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,7 +40,6 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,6 +55,15 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 +
63 +(% class="wikigeneratedid" %)
64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
65 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
105 + "agentId": "",  (%%)
106 + "parentId": "",
107 + "parentName": "string",
108 + "name": "string",
109 + "fullName": "string",
110 + "agentInfoType": 0,
111 + "isForeign": true/false,
112 + "district": "string", 
113 + "region": "string",
114 + "city": "string",
115 + "inn": "string",
116 + "kpp": "string",
117 + "address": "string",
118 + "addressFact": "string",
119 + "email": "string",
120 + "director": "string",
121 + "bankName": "string",
122 + "bankBIK": "string",
123 + "bankRS": "string",
124 + "bankKS": "string"
118 118   }
119 119  
127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
128 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
129 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
130 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
131 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
132 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
133 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
134 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
135 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
136 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
137 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
138 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
139 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
140 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
141 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
142 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
143 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
144 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
145 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
146 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
147 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
148 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
162 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
177 + "agentId": "",(% style="color:#000000" %)   (%%)
178 + "parentId": "",
179 + "name": "string",
180 + "fullName": "string",
181 + "agentInfoType": 0,
182 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
185 +
186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
187 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
188 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
189 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
190 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
191 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
192 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
193 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 +
220 220  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 +
362 +(% class="box warningmessage" %)
363 +(((
364 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 +)))
366 +
367 +Метод позволяет изменить статус клиента, указанного в запросе.
368 +
369 +В пути указывается GUID клиента и статус клиента.
370 +
371 +**status **- значение 0 - заблокирован, 1 - активен.
372 +
373 +Ответ: Code 204
374 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -363,7 +363,6 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 369  
... ... @@ -392,6 +392,7 @@
392 392  (% style="text-align:left" %)
393 393  (% style="color:#000000; font-weight:normal" %)}
394 394  
466 +
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
397 397  (% class="box infomessage" %)
... ... @@ -682,6 +682,249 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
757 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
758 +
759 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
760 +
761 +(% class="box infomessage" %)
762 +(((
763 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
764 +)))
765 +
766 +Метод возвращает полную информацию о модели объекта.
767 +
768 +(% style="color:#000000" %)Метод запроса: **GET**
769 +
770 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
771 +
772 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
773 +
774 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
775 +
776 +(% style="color:#000000" %)Ответ:
777 +
778 +(% style="color:#000000" %){
779 + "parentName": "string",
780 + "name": "string",
781 + "picture": "string",
782 + "minspeed": 0,
783 + "maxspeed": 0,
784 + "width": 0,
785 + "imbeddedtrailer": true,
786 + "hoppercapacity": 0,
787 + "hopperdischargespeed": 0,
788 + "modelType": 0,
789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
791 + "deleted": true
792 +}
793 +
794 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
795 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
796 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
797 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
798 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
799 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
800 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
801 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
802 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
804 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
805 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
806 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
807 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
808 +
809 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
810 +
811 +(% class="box successmessage" %)
812 +(((
813 +(% lang="en-US" %)**POST /api/v3/models/find**
814 +)))
815 +
816 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
817 +
818 +(% style="color:#000000" %)Метод запроса: **POST**
819 +
820 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
821 +
822 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
823 +
824 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
825 +
826 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
827 +}
828 +
829 +(% style="color:#000000" %)Ответ:
830 +
831 +(% style="color:#000000" %)[
832 + {
833 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
834 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
835 + "parentName": "string",
836 + "name": "string",
837 + "modelType": 0
838 + }
839 +]
840 +
841 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
842 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
844 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
845 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
846 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
847 +
848 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
849 +
850 +(% class="box successmessage" %)
851 +(((
852 +(% lang="en-US" %)**POST /api/v3/models**
853 +)))
854 +
855 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
856 +
857 +(% style="color:#000000" %)Метод запроса: **POST**
858 +
859 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
860 +
861 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
862 +
863 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
864 +
865 +{
866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
868 + "deleted": true,
869 + "extId": "string",
870 + "name": "string",
871 + "picture": "string",
872 + "minspeed": 0,
873 + "maxspeed": 0,
874 + "width": 0,
875 + "imbeddedtrailer": true,
876 + "fueloutlay": 0,
877 + "hoppercapacity": 0,
878 + "hopperdischargespeed": 0,
879 + "modelType": 0
880 +}
881 +
882 +Ответ:
883 +
884 +{
885 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
887 + "deleted": true,
888 + "extId": "string",
889 + "name": "string",
890 + "picture": "string",
891 + "minspeed": 0,
892 + "maxspeed": 0,
893 + "width": 0,
894 + "imbeddedtrailer": true,
895 + "hoppercapacity": 0,
896 + "hopperdischargespeed": 0,
897 + "modelType": 0
898 +}
899 +
900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
913 +
914 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
915 +
916 +(% class="box warningmessage" %)
917 +(((
918 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
919 +)))
920 +
921 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
922 +
923 +(% style="color:#000000" %)Метод запроса: **PUT**
924 +
925 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
926 +
927 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
928 +
929 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
930 +
931 +{
932 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
934 + "deleted": true,
935 + "extId": "string",
936 + "name": "string",
937 + "picture": "string",
938 + "minspeed": 0,
939 + "maxspeed": 0,
940 + "width": 0,
941 + "imbeddedtrailer": true,
942 + "fueloutlay": 0,
943 + "hoppercapacity": 0,
944 + "hopperdischargespeed": 0,
945 + "modelType": 0
946 +}
947 +
948 +Ответ:
949 +
950 +{
951 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
952 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
953 + "deleted": true,
954 + "extId": "string",
955 + "name": "string",
956 + "picture": "string",
957 + "minspeed": 0,
958 + "maxspeed": 0,
959 + "width": 0,
960 + "imbeddedtrailer": true,
961 + "fueloutlay": 0,
962 + "hoppercapacity": 0,
963 + "hopperdischargespeed": 0,
964 + "modelType": 0
965 +}
966 +
967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 +
981 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
982 +
983 +(% class="box errormessage" %)
984 +(((
985 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
986 +)))
987 +
988 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
989 +
990 +(% style="color:#000000" %)Метод запроса: **DELETE**
991 +
992 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
993 +
994 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
995 +
996 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
997 +
998 +Ответ: В случае успеха **Success 200**
999 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -894,6 +894,58 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
1212 +
1213 +== **Получить ответ на отправленную на ТС команду** ==
1214 +
1215 +(% class="box infomessage" %)
1216 +(((
1217 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1218 +)))
1219 +
1220 +Идентификатор команды: cmdid
1221 +
1222 +Запрос от терминала на ответ команды
1223 +
1224 +Пример ответ от терминала:
1225 +
1226 +ID= "" ~/~/ идентификатор произвольного поля
1227 +Soft="" ~/~/ версия софта
1228 +GPS=4 ~/~/ тип трекера
1229 +Time=11:05:43 28.06.24 ~/~/ время запроса
1230 +Lat=45.056221 ~/~/ широта
1231 +Lon=39.035938 ~/~/ долгота
1232 +Speed=0.0 ~/~/ скорость
1233 +Course=181.4 ~/~/направление
1234 +
1235 +(((
1236 +== **Список отправленных объекту команд с ответами** ==
1237 +
1238 +(% class="box infomessage" %)
1239 +(((
1240 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1241 +)))
1242 +
1243 +Идентификатор ТС: vehicleId
1244 +
1245 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1246 +
1247 +Пример ответа терминала
1248 +
1249 +[ 
1250 +{    
1251 +"id": "", ~/~/ идентификатор пользователя
1252 +"commandText": "", ~/~/Текст команды.
1253 +"templateId": "", ~/~/Идентификатор шаблона
1254 +"updated": "", ~/~/ Время отправки  
1255 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1256 +"answer": "", ~/~/ Ответ терминала.
1257 +"status": "" ~/~/ Статус отправки
1258 +}
1259 +]
1260 +
1261 +
1262 +)))
1263 +
897 897  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
898 898  
899 899  (% class="box successmessage" %)
... ... @@ -1116,7 +1116,7 @@
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1486 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1237,6 +1237,24 @@
1237 1237  (% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1607 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
1608 +**Отправить команду на терминал**
1609 +
1610 +(% class="box successmessage" %)
1611 +(((
1612 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1613 +)))
1614 +
1615 +Команда для отправки на тс.
1616 +
1617 +{  
1618 +"id": "", ~/~/идентификатор произвольного поля
1619 +"command": "", ~/~/ Текст команды
1620 +"retries": "", ~/~/ Количество попыток
1621 +"idTemplate": "" ~/~/ ID шаблона команды
1622 +}
1623 +
1624 +
1240 1240  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1241 1241  
1242 1242  (% class="box warningmessage" %)
... ... @@ -1490,7 +1490,7 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1878 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
1961 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1962 +
1963 +(% class="box infomessage" style="text-align: left;" %)
1964 +(((
1965 +**POST /api/v3/terminalMessages/mapping**
1966 +)))
1967 +
1968 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1969 +
1970 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1971 +
1972 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1973 +
1974 +{
1975 + "protocolType": 0,
1976 + "params": ["string"]
1977 +}
1978 +
1979 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1980 +|protocolType|ID типа протокола
1981 +|params|(((
1982 +Массив наименований параметров в сообщении
1983 +)))
1984 +
1985 +Ответ:
1986 +
1987 +{
1988 + "protocolType": 0,
1989 + "mapping": {
1990 + "additionalProp1": {
1991 + "inputType": 0,
1992 + "inputNumber": 0
1993 + },
1994 + "additionalProp2": {
1995 + "inputType": 0,
1996 + "inputNumber": 0
1997 + }
1998 + }
1999 +}
2000 +
2001 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2002 +|protocolType|Тип протокола
2003 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2004 +|inputNumber|(((
2005 +Номер входа
2006 +)))
2007 +
2008 +(% class="wikigeneratedid" %)
2009 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2010 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
2035 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2036 +|vehicleId|ID объекта
2037 +|from|Дата и время начала периода запроса
2038 +|to|Дата и время окончания периода запроса
2039 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,27 +1603,45 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
2046 + "deviceTime": "2023-11-29T07:40:44.052Z",
2047 + "serverTime": "2023-11-29T07:40:44.052Z",
2048 + "speed": 0,
2049 + "altitude": 0,
2050 + "latitude": 0,
2051 + "longitude": 0,
2052 + "satellites": 0,
2053 + "course": 0,
2054 + "voltage": 0,
2055 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
2060 + "photoCount": 0,
2061 + "lbsCorrectedCoords": true,
2062 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных о объекте за период**(%%) =
2068 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2069 +|deviceTime|Время сообщения терминала
2070 +|serverTime|Время когда сообщение поступило на сервер
2071 +|speed|Скорость
2072 +|altitude|Высота над уровнем моря
2073 +|latitude|Широта
2074 +|longitude|Долгота
2075 +|satellites|Кол-во спутников
2076 +|course|Курс
2077 +|voltage|Бортовое напряжение
2078 +|parameters|Список параметров и их значений
2079 +|photoCount|Количество фото
2080 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2081 +|protocolType|ID типа протокола
1626 1626  
2083 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2084 +
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1628 1628  
1629 1629  (% class="box infomessage" %)
... ... @@ -1755,6 +1755,97 @@
1755 1755   }
1756 1756  ]
1757 1757  
2216 +
2217 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2218 +
2219 +(% class="box infomessage" %)
2220 +(((
2221 +**POST /api/v3/vehicles/moveStop**
2222 +)))
2223 +
2224 +Метод запроса: **POST**
2225 +
2226 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2227 +
2228 +В заголовках запроса: X-Auth: Токен авторизации
2229 +
2230 +
2231 +Тело запроса:
2232 +
2233 +{
2234 + "vehicleIds": [ ], ~/~/ Список ID объектов
2235 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2236 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2237 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2238 +}
2239 +
2240 +Ответ:
2241 +
2242 +[ 
2243 + {
2244 + "vehicleId": 0, ~/~/ ID объекта
2245 + "vehicleName": "string", ~/~/ Имя объекта
2246 + "moves": [ ~/~/ Событие движения
2247 + {
2248 + "mileage": 0, ~/~/ Пробег, км
2249 + "eventId": 0, ~/~/ Идентификатор события
2250 + "eventName": "string", ~/~/ Название события
2251 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2252 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2253 + "duration": 0 ~/~/ Продолжительность события, секунд
2254 + }
2255 + ],
2256 + "stops": [ ~/~/ События стоянок
2257 + {
2258 + "address": "string", ~/~/ Адрес события
2259 + "eventId": 0, ~/~/ Идентификатор события
2260 + "eventName": "string", ~/~/ Название события
2261 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2262 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2263 + "duration": 0 ~/~/ Продолжительность события, секунд
2264 + }
2265 + ]
2266 + }
2267 +]
2268 +
2269 +
2270 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2271 +
2272 +(% class="box infomessage" %)
2273 +(((
2274 +**POST /api/v3/vehicles/getlastdata**
2275 +)))
2276 +
2277 +Метод запроса: **POST**
2278 +
2279 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2280 +
2281 +В заголовках запроса: X-Auth: Токен авторизации
2282 +
2283 +
2284 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2285 +
2286 +Ответ:
2287 + {
2288 + "vehicleId": 0, ~/~/Идентификатор объекта.
2289 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2290 + "vehicleNumber": "string",~/~/Номер объекта.
2291 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2292 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2293 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2294 + "speed": 0,~/~/Скорость объекта.
2295 + "course": 0,~/~/Курс движения [0;360]
2296 + "latitude": 0,~/~/Широта [-90°;90°].
2297 + "longitude": 0,~/~/Долгота [-180°;180°].
2298 + "address": "string",~/~/Адрес.
2299 + "geozones": [ ~/~/Сведения по геозонам.
2300 + {
2301 + "id": 0,
2302 + "name": "string"
2303 + }
2304 +
2305 +
2306 +
1758 1758  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1759 1759  
1760 1760  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -1768,7 +1768,7 @@
1768 1768  
1769 1769  (% style="color:#000000" %)Метод запроса: **POST**
1770 1770  
1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
2320 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
1772 1772  
1773 1773  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1774 1774  
... ... @@ -2653,6 +2653,83 @@
2653 2653  Success
2654 2654  
2655 2655  
3205 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3206 +
3207 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3208 +
3209 +(% class="box infomessage" %)
3210 +(((
3211 +**POST /api/v3/Trailers**
3212 +)))
3213 +
3214 +Пример запроса:
3215 +
3216 +{
3217 + "startDate": "2023-11-14T10:48:03.671Z",
3218 + "endDate": "2023-11-14T10:48:03.671Z",
3219 + "ids": [ 0 ],
3220 + "timezone": 0
3221 +}
3222 +
3223 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3224 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3225 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3226 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3227 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3228 +
3229 +Пример ответа:
3230 +
3231 +[
3232 + {
3233 + "SD": "2023-11-14T10:48:03.717Z",
3234 + "ED": "2023-11-14T10:48:03.717Z", 
3235 + "id": 0,
3236 + "SLat": 0,
3237 + "SLon": 0,
3238 + "ELat": 0,
3239 + "ELon": 0,
3240 + "mileage": 0
3241 + "Duration": 0
3242 + "Address": "string",
3243 + "Address2": "string",
3244 + "name": "string",
3245 + "rid": "string",
3246 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 + "trailer": {
3248 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3249 + "Number": "string",
3250 + "Description": "string",
3251 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3252 + "ExternalID": "string",
3253 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3254 + "CreateTime": "2023-11-14T10:48:03.717Z",
3255 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3256 + "IsDeleted": true
3257 + },
3258 + "filesCount": 0,
3259 + }
3260 +]
3261 +
3262 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3263 +|SD|Дата и время начала события
3264 +|ED|Дата и время окончания события
3265 +|id|ID объекта
3266 +|SLat|Широта начальной координаты
3267 +|SLon|Долгота начальной координаты
3268 +|ELat|Широта конечной координаты
3269 +|ELon|Долгота конечной координаты
3270 +|mileage|Пробег
3271 +|Duration|Продолжительность
3272 +|Address|Адрес начального местоположения
3273 +|Address2|Адрес конечного местоположения
3274 +|name|Имя радиометки
3275 +|rid|Номер радиометки
3276 +|rguid|ID радиометки
3277 +|trailer|Информация об агрегате
3278 +|ModelGuid|ID агрегата
3279 +|Number|Название/номер агрегата
3280 +|Description|Текст примечания агрегата
3281 +
2656 2656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2657 2657  
2658 2658  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2674,13 +2674,18 @@
2674 2674   {
2675 2675   "name": "string",
2676 2676   "number": 0,
2677 - "period": 0, ~/~/ Частота трансляции радиометки
3303 + "period": 0,
2678 2678   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2679 2679   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 - "deleted": true
2681 2681   }
2682 2682  ]
2683 2683  
3309 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3310 +|parentId|ID клиента
3311 +|name|Название карты-метки
3312 +|number|Номер
3313 +|period|Период запросов в секундах (работает только для агрегатов)
3314 +|id|ID карты-метки
2684 2684  
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
... ... @@ -2697,13 +2697,18 @@
2697 2697   {
2698 2698   "name": "string",
2699 2699   "number": 0,
2700 - "period": 0, ~/~/ Частота трансляции радиометки
3331 + "period": 0,
2701 2701   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 2702   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 - "deleted": true
2704 2704   }
2705 2705  ]
2706 2706  
3337 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3338 +|name|Название карты-метки
3339 +|number|Номер
3340 +|period|Период запросов в секундах (работает только для агрегатов)
3341 +|id|ID карты-метки
3342 +|parentId|ID клиента
2707 2707  
2708 2708  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2709 2709  
... ... @@ -2719,7 +2719,6 @@
2719 2719   "number": 0,
2720 2720   "period": 0,
2721 2721   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "deleted": true
2723 2723  }
2724 2724  
2725 2725  Ответ:
... ... @@ -2730,9 +2730,14 @@
2730 2730   "period": 0,
2731 2731   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2732 2732   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 - "deleted": true
2734 2734  }
2735 2735  
3370 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3371 +|name|Название карты-метки
3372 +|number|Номер
3373 +|period|Период запросов в секундах (работает только для агрегатов)
3374 +|id|ID карты-метки
3375 +|parentId|ID клиента
2736 2736  
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
... ... @@ -2749,7 +2749,6 @@
2749 2749   "period": 0,
2750 2750   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 2751   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "deleted": true
2753 2753  }
2754 2754  
2755 2755  Ответ:
... ... @@ -2760,9 +2760,14 @@
2760 2760   "period": 0,
2761 2761   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 2762   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 - "deleted": true
2764 2764  }
2765 2765  
3404 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3405 +|name|Название карты-метки
3406 +|number|Номер
3407 +|period|Период запросов в секундах (работает только для агрегатов)
3408 +|id|ID карты-метки
3409 +|parentId|ID клиента
2766 2766  
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
... ... @@ -2771,7 +2771,7 @@
2771 2771  **DELETE /api/v3/Rfids/{rfidGuid}**
2772 2772  )))
2773 2773  
2774 -Передаем параметр rfidGuid - идентификатор карты-метки
3418 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2775 2775  
2776 2776  Ответ:
2777 2777  
... ... @@ -2778,6 +2778,1108 @@
2778 2778  Success
2779 2779  
2780 2780  
3425 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3426 +
3427 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3428 +
3429 +(% class="box infomessage" %)
3430 +(((
3431 +**GET /api/v3/Billing/client/balance/{clientId}**
3432 +)))
3433 +
3434 +Параметр запроса: **clientId **- идентификатор клиента.
3435 +
3436 +Ответ:
3437 +
3438 +{
3439 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3440 + "Balance": 0
3441 +}
3442 +
3443 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3444 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3445 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3446 +
3447 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3448 +
3449 +(% class="box infomessage" %)
3450 +(((
3451 +**GET /api/v3/Billing/client/constraint/{clientId}**
3452 +)))
3453 +
3454 +Параметр запроса: **clientId **- идентификатор клиента.
3455 +
3456 +Ответ:
3457 +
3458 +{
3459 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3460 + "CalculationType": 0,
3461 + "PermissibleBalance": 0,
3462 + "DefermentDays": 0,
3463 + "SendUiNotifications": true,
3464 + "SendEmailNotifications": true,
3465 + "IsPrivate": true,
3466 +}
3467 +
3468 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3469 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3470 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3471 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3472 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3473 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3474 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3475 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3476 +
3477 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3478 +
3479 +(% class="box infomessage" %)
3480 +(((
3481 +**GET /api/v3/Billing/client/plan/{clientId}**
3482 +)))
3483 +
3484 +Параметры запроса:
3485 +
3486 +**clientId **- идентификатор клиента.
3487 +
3488 +**planId **- идентификатор тарифного плана.
3489 +
3490 +Ответ:
3491 +
3492 +{
3493 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3494 + "Plan": { **~/~/ Описание тарифного плана**
3495 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3496 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497 + "Name": "string",
3498 + "IsArchived": true,
3499 + "Constraint": {
3500 + "CalculationType": 0,
3501 + "PermissibleBalance": 0,
3502 + "DefermentDays": 0
3503 + },
3504 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3505 + {
3506 + "Feature": "string",
3507 + "IsFactual": true,
3508 + "Limit": 0,
3509 + "Price": 0,
3510 + "PeriodValue": 0,
3511 + "PeriodType": 0
3512 + }
3513 + ]
3514 + },
3515 + "DebitDate": "2023-10-18T12:46:24.213Z",
3516 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3517 + {
3518 + "Feature": "string",
3519 + "IsEnabled": true,
3520 + "IsPrivate": true,
3521 + "IsFactual": true,
3522 + "Limit": 0,
3523 + "Price": 0,
3524 + "DebitDate": "2023-10-18T12:46:24.213Z",
3525 + "PeriodValue": 0,
3526 + "PeriodType": 0
3527 + }
3528 + ]
3529 +}
3530 +
3531 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3532 +|ClientId|Идентификатор клиента
3533 +|Id|Идентификатор тарифного плана
3534 +|OwnerId|Идентификатор клиента-владельца
3535 +|Name|Наименование тарифного плана
3536 +|IsArchived|Признак, определяющий архивный тарифный план
3537 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3538 +|PermissibleBalance|Допустимый баланс
3539 +|DefermentDays|Отсрочка, количество дней
3540 +|Feature|Код услуги
3541 +|IsEnabled|Признак, определяющий активирована ли услуга
3542 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3543 +|IsFactual|Признак, определяющий расчёт по факту
3544 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3545 +|Price|Цена за единицу.
3546 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3547 +|PeriodValue|Значение периода.
3548 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3549 +
3550 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3551 +
3552 +(% class="box infomessage" %)
3553 +(((
3554 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3555 +)))
3556 +
3557 +Параметр запроса: **clientId **- идентификатор клиента.
3558 +
3559 +Ответ:
3560 +
3561 +[
3562 + {
3563 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3564 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3565 + "Name": "string",
3566 + "IsArchived": true,
3567 + "Constraint": {
3568 + "CalculationType": 0,
3569 + "PermissibleBalance": 0,
3570 + "DefermentDays": 0
3571 + },
3572 + "Features": [
3573 + {
3574 + "Feature": "string",
3575 + "IsFactual": true,
3576 + "Limit": 0,
3577 + "Price": 0,
3578 + "PeriodValue": 0,
3579 + "PeriodType": 0
3580 + }
3581 + ]
3582 + }
3583 +]
3584 +
3585 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3586 +|ClientId|Идентификатор клиента
3587 +|Id|Идентификатор тарифного плана
3588 +|OwnerId|Идентификатор клиента-владельца
3589 +|Name|Наименование тарифного плана
3590 +|IsArchived|Признак, определяющий архивный тарифный план
3591 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3592 +|PermissibleBalance|Допустимый баланс
3593 +|DefermentDays|Отсрочка, количество дней
3594 +|Feature|Код услуги
3595 +|IsFactual|Признак, определяющий расчёт по факту
3596 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3597 +|Price|Цена за единицу.
3598 +|PeriodValue|Значение периода.
3599 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3600 +
3601 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3602 +
3603 +(% class="box infomessage" %)
3604 +(((
3605 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3606 +)))
3607 +
3608 +Параметр запроса: **clientId **- идентификатор клиента.
3609 +
3610 +Ответ:
3611 +
3612 +[
3613 + {
3614 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3615 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3616 + "Name": "string",
3617 + "IsArchived": true,
3618 + "Constraint": {
3619 + "CalculationType": 0,
3620 + "PermissibleBalance": 0,
3621 + "DefermentDays": 0
3622 + },
3623 + "Features": [
3624 + {
3625 + "Feature": "string",
3626 + "IsFactual": true,
3627 + "Limit": 0,
3628 + "Price": 0,
3629 + "PeriodValue": 0,
3630 + "PeriodType": 0
3631 + }
3632 + ]
3633 + }
3634 +]
3635 +
3636 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3637 +|ClientId|Идентификатор клиента
3638 +|Id|Идентификатор тарифного плана
3639 +|OwnerId|Идентификатор клиента-владельца
3640 +|Name|Наименование тарифного плана
3641 +|IsArchived|Признак, определяющий архивный тарифный план
3642 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3643 +|PermissibleBalance|Допустимый баланс
3644 +|DefermentDays|Отсрочка, количество дней
3645 +|Feature|Код услуги
3646 +|IsFactual|Признак, определяющий расчёт по факту
3647 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3648 +|Price|Цена за единицу.
3649 +|PeriodValue|Значение периода.
3650 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3651 +
3652 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3653 +
3654 +(% class="box warningmessage" %)
3655 +(((
3656 +**PUT /api/v3/Billing/client/balance**
3657 +)))
3658 +
3659 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3660 +
3661 +Тело запроса:
3662 +
3663 +{
3664 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3665 + "Balance": 0
3666 +}
3667 +
3668 +Ответ: Success
3669 +
3670 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3672 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3673 +
3674 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3675 +
3676 +(% class="box warningmessage" %)
3677 +(((
3678 +**PUT /api/v3/billing/client/balance/deposit**
3679 +)))
3680 +
3681 +Создает операцию **Пополнение **с указанной суммой
3682 +
3683 +Тело запроса:
3684 +
3685 +{
3686 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3687 + "Balance": 0
3688 +}
3689 +
3690 +Ответ: Success
3691 +
3692 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3693 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3694 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3695 +
3696 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3697 +
3698 +Создает операцию **Списание **с указанной суммой
3699 +
3700 +(% class="box warningmessage" %)
3701 +(((
3702 +**PUT /api/v3/billing/client/balance/withdraw**
3703 +)))
3704 +
3705 +Тело запроса:
3706 +
3707 +{
3708 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3709 + "Balance": 0
3710 +}
3711 +
3712 +Ответ: Success
3713 +
3714 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3715 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3716 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3717 +
3718 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3719 +
3720 +(% class="box warningmessage" %)
3721 +(((
3722 +**PUT /api/v3/Billing/client/constraint**
3723 +)))
3724 +
3725 +Тело запроса:
3726 +
3727 +{
3728 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3729 + "CalculationType": 0,
3730 + "PermissibleBalance": 0,
3731 + "DefermentDays": 0,
3732 + "SendUiNotifications": true,
3733 + "SendEmailNotifications": true,
3734 + "IsPrivate": true,
3735 +}
3736 +
3737 +Ответ: Success
3738 +
3739 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3740 +|ClientId|Идентификатор клиента
3741 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3742 +|PermissibleBalance|Допустимый баланс
3743 +|DefermentDays|(((
3744 +Отсрочка, количество дней
3745 +)))
3746 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3747 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3748 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3749 +
3750 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3751 +
3752 +(% class="box warningmessage" %)
3753 +(((
3754 +**PUT /api/v3/Billing/client/plan**
3755 +)))
3756 +
3757 +Тело запроса:
3758 +
3759 +{
3760 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3761 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3762 + "Features": [
3763 + {
3764 + "Feature": "string",
3765 + "IsEnabled": true,
3766 + "IsFactual": true,
3767 + "Limit": 0,
3768 + "Price": 0,
3769 + "DebitDate": "2023-10-18T13:26:58.987Z",
3770 + "PeriodValue": 0,
3771 + "PeriodType": 0
3772 + }
3773 + ]
3774 +}
3775 +
3776 +Ответ: Success
3777 +
3778 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3779 +|ClientId|Идентификатор клиента
3780 +|PlanId|Идентификатор тарифного плана
3781 +|Feature|Код услуги
3782 +|IsEnabled|Признак, определяющий активирована ли услуга
3783 +|IsFactual|Признак, определяющий расчёт по факту
3784 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3785 +|Price|Цена за единицу.
3786 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3787 +|PeriodValue|Значение периода.
3788 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3789 +
3790 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3791 +
3792 +(% class="box warningmessage" %)
3793 +(((
3794 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3795 +)))
3796 +
3797 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3798 +
3799 +(% class="box infomessage" %)
3800 +(((
3801 +**POST /api/v3/vehicles/import/{agentId}**
3802 +)))
3803 +
3804 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3805 +
3806 +В пути указывается **agentId** - id клиента.
3807 +
3808 +**Заголовок**
3809 +
3810 +**X-Auth: [токен авторизации]**
3811 +
3812 +**Параметры**
3813 +
3814 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3815 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3816 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3817 +
3818 +В теле использовать тип **form-data,** тип значения** file**
3819 +
3820 +**Ключи**
3821 +
3822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3823 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3824 +|csv|В значении передаем файл датчиков, формат **csv**
3825 +
3826 +Ответ:
3827 +
3828 +{
3829 + "vehicleId": 0,
3830 + "name": "string",
3831 + "errors": ["string"]
3832 +}
3833 +
3834 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3835 +|vehicleId|ID созданного объекта
3836 +|name|Имя созданного объекта
3837 +|errors|Ошибки и их описание
3838 +
3839 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3840 +
3841 +(% class="box infomessage" %)
3842 +(((
3843 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3844 +)))
3845 +
3846 +(% class="wikigeneratedid" %)
3847 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3848 +
3849 +(% class="wikigeneratedid" %)
3850 +В пути указывается **vehicleId **- id объекта.
3851 +
3852 +**Заголовок**
3853 +
3854 +**X-Auth: [токен авторизации]**
3855 +
3856 +В теле использовать тип **form-data.**
3857 +
3858 +Ключи:
3859 +
3860 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3861 +|**history**|В значении передавать файл с историей
3862 +
3863 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3864 +
3865 +Ответ:
3866 +
3867 +{
3868 + "results": [
3869 + {
3870 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3871 + "vehicleId": 0,
3872 + "errors": [
3873 + "string"
3874 + ],
3875 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3876 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3877 + "producedCount": 0,
3878 + "msgCount": 0
3879 + }
3880 + ]
3881 +}
3882 +
3883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3884 +|results|Результаты импорта в разрезе ТС
3885 +|vehicleGuid|Guid ТС
3886 +|vehicleId|ID ТС
3887 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3888 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3889 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3890 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3891 +|msgCount|Кол-во обработанных сообщений всего
3892 +
3893 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3894 +
3895 +(% class="box infomessage" %)
3896 +(((
3897 +**GET /api/v3/vehicles/import/history/status**
3898 +)))
3899 +
3900 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3901 +
3902 +Ответ:
3903 +
3904 +{
3905 + "activity": true,
3906 + "progress": 0,
3907 + "message": "string"
3908 +}
3909 +
3910 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3911 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3912 +|progress|Guid ТС
3913 +
3914 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3915 +
3916 +(% class="box infomessage" %)
3917 +(((
3918 +**POST /api/v3/vehicles/export**
3919 +)))
3920 +
3921 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3922 +
3923 +Тело запроса:
3924 +
3925 +[
3926 + id
3927 +]
3928 +
3929 +Ответ: Success 200, получаете файлы с настройками.
3930 +
3931 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3932 +
3933 +(% class="box infomessage" %)
3934 +(((
3935 +**POST /api/v3/vehicles/export/history**
3936 +)))
3937 +
3938 +Метод возвращает список сообщений терминала объекта за выбранный период.
3939 +
3940 +Тело запроса:
3941 +
3942 +{
3943 + "vehicleId": 0,
3944 + "asArchive": true,
3945 + "from": "2023-09-27T12:17:45.973Z",
3946 + "to": "2023-09-27T12:17:45.973Z"
3947 +}
3948 +
3949 +Ответ:
3950 +
3951 +Получаете файл. Сообщение: Code 200/Success
3952 +
3953 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3954 +|vehicleId|ID объекта
3955 +|asArchive|true - Архивировать файл, False - не архивировать
3956 +|from|Дата и время начала запроса
3957 +|to|Дата и время окончания запроса
3958 +
3959 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3960 +
3961 +(% class="box infomessage" %)
3962 +(((
3963 +**GET /api/v3/vehicles/export/history/status**
3964 +)))
3965 +
3966 +Метод возвращает список сообщений терминала объекта за выбранный период.
3967 +
3968 +Ответ:
3969 +
3970 +{
3971 + "activity": true,
3972 + "progress": 0,
3973 + "message": "string"
3974 +}
3975 +
3976 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3977 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3978 +|progress|Прогресс экспорта, от 0 до 100%
3979 +|message|Текст описывающий статус
3980 +
3981 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3982 +
3983 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3984 +
3985 +(% class="box infomessage" %)
3986 +(((
3987 +**POST /api/v3/EcoDriving/rating**
3988 +)))
3989 +
3990 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3991 +
3992 +Тело запроса:
3993 +
3994 +{
3995 + "vehicleIds": [vehicleId],
3996 + "from": "2023-11-22T09:29:48.051Z",
3997 + "to": "2023-11-22T09:29:48.051Z"
3998 +}
3999 +
4000 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4001 +|vehicleIds|Массив ID объектов
4002 +|from|Дата начала запроса
4003 +|to|Дата окончания запроса
4004 +
4005 +Ответ:
4006 +
4007 +{
4008 + "items": [
4009 + {
4010 + "from": "2023-11-22T09:29:48.052Z",
4011 + "to": "2023-11-22T09:29:48.052Z",
4012 + "vehicleId": 0,
4013 + "vehicleName": "string",
4014 + "vehicleModel": "string",
4015 + "penalty": 0,
4016 + "score": 0,
4017 + "totalViolations": 0,
4018 + "violationsByType": {
4019 + "overspeedingViolations": 0,
4020 + "accelerationViolations": 0,
4021 + "brakingViolations": 0,
4022 + "turningViolations": 0,
4023 + "dangerousDrivingViolations": 0,
4024 + "sensorViolations": 0
4025 + },
4026 + "moveTime": 0,
4027 + "mileage": 0,
4028 + "tripsCount": 0,
4029 + "trips": [
4030 + {
4031 + "penalty": 0,
4032 + "score": 0,
4033 + "violationsCount": 0,
4034 + "violationsByType": {
4035 + "overspeedingViolations": 0,
4036 + "accelerationViolations": 0,
4037 + "brakingViolations": 0,
4038 + "turningViolations": 0,
4039 + "dangerousDrivingViolations": 0,
4040 + "sensorViolations": 0
4041 + },
4042 + "moveTime": 0,
4043 + "mileage": 0,
4044 + "motohours": 0,
4045 + "maxSpeed": 0,
4046 + "startAddress": "string",
4047 + "endAddress": "string",
4048 + "drivers": [
4049 + {
4050 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4051 + "driverName": "string",
4052 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4053 + }
4054 + ]
4055 + }
4056 + ]
4057 + }
4058 + ]
4059 +}
4060 +
4061 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4062 +|from|Дата начала запроса
4063 +|to|Дата  окончания
4064 +|vehicleId|ID объекта
4065 +|vehicleName|Имя объекта
4066 +|vehicleModel|Модель объекта
4067 +|penalty|Сумма штрафных баллов
4068 +|score|Оценка
4069 +|totalViolations|Суммарное количество нарушений
4070 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4071 +|overspeedingViolations|Превышение скорости
4072 +|accelerationViolations|Ускорение
4073 +|brakingViolations|Торможение
4074 +|turningViolations|Резкий поворот
4075 +|dangerousDrivingViolations|Резкое вождение
4076 +|sensorViolations|Нарушение по датчику
4077 +|moveTime|Время в движении
4078 +|mileage|Пробег
4079 +|tripsCount|Количество рейсов
4080 +|motohours|Моточасы
4081 +|maxSpeed|Максимальная скорость
4082 +|startAddress|Адрес начала рейса
4083 +|endAddress|Адрес окончания рейса
4084 +|drivers|Список водителей, которые были на объекте в течениии рейса
4085 +|driverGuid|Guid водителя
4086 +|driverName|Имя водителя
4087 +|driverRfid|Номер Карты-метки
4088 +
4089 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4090 +
4091 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4092 +
4093 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4094 +
4095 +(% class="box infomessage" %)
4096 +(((
4097 +POST /api/v3/fuelcards/transactions
4098 +)))
4099 +
4100 +Метод запроса: POST
4101 +
4102 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4103 +\\В заголовках запроса: X-Auth: Токен авторизации
4104 +
4105 +Параметры в теле запроса (JSON):
4106 +
4107 +{
4108 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4109 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4110 + "ids": [ 
4111 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4112 + ],
4113 + "timezone": 0 ~/~/Таймзона
4114 +}
4115 +
4116 +
4117 +Ответ:
4118 + {
4119 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4120 + "driver": "string", ~/~/Водители, привязанные к ТК
4121 + "object": "string", ~/~/Наименование ТС
4122 + "amount": 0, ~/~/Количество топлива
4123 + "amountDut": 0, ~/~/Количество по ДУТ
4124 + "amountDiff": 0, ~/~/Разница, л
4125 + "amountDiffPerc": 0, ~/~/Разница, %
4126 + "summa": 0, ~/~/Стоимость, руб
4127 + "serviceName": "string", ~/~/Тип топлива
4128 + "price": 0, ~/~/Цена за литр, руб
4129 + "cardName": "string", ~/~/Наименование ТК
4130 + "cardNum": "string", ~/~/Номер ТК
4131 + "operator": "string", ~/~/Оператор ТК
4132 + "address": "string" ~/~/Адрес АЗС
4133 + }
4134 +
4135 +
4136 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4137 +
4138 +
4139 +== **Получение полных данных о ретрансляторе** ==
4140 +
4141 +(% class="box infomessage" %)
4142 +(((
4143 +**GET ** **/api/v3/retranslations/{id}**
4144 +)))
4145 +
4146 +Идентификатор запроса: ID
4147 +
4148 +
4149 +Пример ответа:
4150 +
4151 +{  
4152 +"description": "", ~/~/ Определяет описание
4153 +"subscriberId": "", ~/~/ Подписчик
4154 +"protocolType": 0, ~/~/ Тип протокола
4155 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4156 +"address": "string", ~/~/ Адрес события
4157 +"objects": [ ~/~/Объекты для ретрансляции
4158 +{      
4159 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4160 +"name": "", ~/~/ Наименование объекта ретрансляции
4161 +"imei": "", ~/~/ IMEI объекта  
4162 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4163 +}
4164 + ],  
4165 +"id": "", ~/~/ идентификатор пользователя   
4166 +"parentId": "", ~/~/Guid родителя
4167 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4168 +}
4169 +
4170 +
4171 +== **Удаление данных ретранслятора** ==
4172 +
4173 +(% class="box infomessage" %)
4174 +(((
4175 +**DELETE** **/api/v3/retranslations/{id}**
4176 +)))
4177 +
4178 +Параметр запроса: ID
4179 +
4180 +
4181 +== **Создание ретранслятора** ==
4182 +
4183 +(% class="box infomessage" %)
4184 +(((
4185 +**POST ** **/api/v3/retranslations/{id}**
4186 +)))
4187 +
4188 +Запрос:
4189 +
4190 +{  
4191 +"description": "", ~/~/ Описание
4192 +"subscriberId": "", ~/~/ Подписчик
4193 +"protocolType": 0, ~/~/ Тип протокола
4194 +"address": "", ~/~/ Адрес ретрансляции
4195 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4196 +"objects": [ ~/~/Объекты для ретрансляции
4197 +{      
4198 +"id": "", ~/~/ идентификатор пользователя     
4199 +"imei": "", ~/~/IMEI объекта
4200 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4201 +}
4202 + ]
4203 +}
4204 +
4205 +
4206 +Ответ:
4207 +
4208 +{  
4209 +"description": "string", ~/~/ Определяет описание
4210 +"subscriberId": "", ~/~/ идентификатор запроса
4211 +"protocolType": 0, ~/~/ Тип протокола
4212 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4213 +"address": "", ~/~/ Адрес события
4214 +"objects": [ ~/~/Объекты для ретрансляции
4215 +{      
4216 +"id": "", ~/~/ идентификатор пользователя    
4217 +"name": "string", ~/~/ Название уведомления
4218 +"imei": "string", ~/~/IMEI объекта  
4219 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4220 +}
4221 + ],  
4222 +"id": "", ~/~/ идентификатор пользователя  
4223 +"parentId": "", ~/~/ Guid идентификатор родителя
4224 +"deleted": true ~/~/ Признак удаления
4225 +}
4226 +
4227 +
4228 +== **Редактирование ретранслятора** ==
4229 +
4230 +(% class="box infomessage" %)
4231 +(((
4232 +**PUT** **/api/v3/retranslations**
4233 +)))
4234 +
4235 +Пример запроса:
4236 +
4237 +{  
4238 +"id": "", ~/~/ идентификатор пользователя   
4239 +"description": "string", ~/~/ Определяет описание
4240 +"subscriberId": "", ~/~/ идентификатор запроса
4241 +"protocolType": 0, ~/~/ Тип протокола
4242 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4243 +"address": "string", ~/~/ Адрес события
4244 +"objects": ~/~/Объекты для ретрансляции
4245 +[    
4246 +{      
4247 +"id": "",  ~/~/ идентификатор пользователя         
4248 +"imei": "", ~/~/IMEI объекта
4249 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4250 +}
4251 + ]
4252 +}
4253 +
4254 +
4255 +Пример ответа:
4256 +
4257 +{  
4258 +"description": "", ~/~/ Определяет описание
4259 +"subscriberId": "", ~/~/ идентификатор запроса
4260 +"protocolType": 0, ~/~/ Тип протокола
4261 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4262 +"address": "string", ~/~/ Адрес события
4263 +"objects": [ ~/~/Объекты для ретрансляции
4264 +{      
4265 +"id": "", ~/~/ идентификатор пользователя     
4266 +"name": "string", ~/~/ Название уведомления    
4267 +"imei": "", ~/~/IMEI объекта
4268 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4269 +}
4270 + ],
4271 +"id": "", ~/~/ идентификатор пользователя   
4272 +"parentId": "", ~/~/ Guid идентификатор родителя
4273 +"deleted": true ~/~/ Признак удаления
4274 +}
4275 +
4276 +
4277 +== **Получение списка ретранслятора клиента** ==
4278 +
4279 +(% class="box infomessage" %)
4280 +(((
4281 +**POST /api/v3/retranslations/find**
4282 +)))
4283 +
4284 +Пример запроса:
4285 +
4286 +{  
4287 +"id": "", ~/~/ идентификатор пользователя   
4288 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4289 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4290 +}
4291 +
4292 +Ответ
4293 +
4294 +[ 
4295 +{    
4296 +"description": "", ~/~/ Определяет описание
4297 +"subscriberId": "", ~/~/ идентификатор запроса
4298 +"protocolType": 0, ~/~/ Тип протокола
4299 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4300 +"address": "string", ~/~/ Адрес события
4301 +"id": "", ~/~/ идентификатор пользователя   
4302 +"parentId": "", ~/~/ Guid идентификатор родителя
4303 +"deleted": true ~/~/ Признак удаления
4304 +}
4305 +]
4306 +
4307 +
4308 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
4309 +
4310 +== **API для отчета по выгрузке комбайнов** ==
4311 +
4312 +(% class="box infomessage" %)
4313 +(((
4314 +POST **/api/v3/Reports/harvesterUnloading**
4315 +)))
4316 +
4317 +Пример запроса:
4318 +
4319 +{
4320 + "byTime": 0, ~/~/ Объединение событий по времени
4321 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4322 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4323 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4324 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4325 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4326 + 0
4327 + ],
4328 + "from": "", ~/~/ Дата и время начало запроса
4329 + "to": "", ~/~/ Дата и время окончания запроса
4330 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4331 +}
4332 +
4333 +Пример ответа:
4334 +
4335 +[ 
4336 + {
4337 + "harvesterName": "", ~/~/Комбайн, номер
4338 + "harvesterId": 0, ~/~/Комбайн, id
4339 +"harvesterModel": "", ~/~/ Модель комбайна
4340 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4341 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4342 + "events": [ ~/~/Список событий в разрезе комбайна
4343 + {
4344 + "driverId": "", ~/~/Идентификатор водителя
4345 + "driverName": "", ~/~/Водитель комбайна, ФИО
4346 + "RFID": "", ~/~/ идентификатор карты-метки
4347 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4348 + "vehicleId": 0, ~/~/идентификатор объекта
4349 + "vehicleName": "string", ~/~/ Имя объекта
4350 + "modelName": "string", ~/~/ Имя модели объекта
4351 + "nearestVehicles": [ ~/~/Объекты рядом
4352 + {
4353 + "vehicleId": 0, ~/~/идентификатор объекта
4354 + "vehicleName": "string" ~/~/ Имя объекта
4355 + }
4356 + ],
4357 + "fields": [ ~/~/Поля, где происходила выгрузка
4358 + {
4359 + "id": 0, ~/~/ идентификатор пользователя 
4360 + "name": "string" ~/~/ имя пользователя 
4361 + }
4362 + ],
4363 + "event": "string", ~/~/Событие
4364 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4365 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4366 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4367 + "cultureName": "string", ~/~/ название культуры
4368 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4369 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4370 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4371 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4372 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4373 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4374 + "issued": 0, ~/~/Выдано, бункеров
4375 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4376 + "latitude": 0, ~/~/Широта
4377 + "longitude": 0, ~/~/ Долгота
4378 + "litresAway": 0, ~/~/Отдано, л
4379 + "m3Away": 0 ~/~/Отдано, м3
4380 + }
4381 + ]
4382 + }
4383 +]
4384 +
4385 +
4386 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4387 +
4388 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4389 +
4390 +
4391 +(% class="box infomessage" %)
4392 +(((
4393 +GET api/v3/Vehicles/recyclebin/all
4394 +)))
4395 +
4396 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4397 +
4398 +Параметр запроса: {parentId} - идентификатор агента
4399 +
4400 +В заголовках запроса: X-Auth: Токен авторизации
4401 +
4402 +Ответ:
4403 +
4404 +[ 
4405 + {
4406 + "recordTime": "", ~/~/Время записи
4407 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4408 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4409 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4410 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4411 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4412 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4413 + "items": [ ~/~/ 
4414 +nullable: true ~/~/Детали
4415 + {
4416 + "name": "string", ~/~/наименование столбца
4417 + "value": "string" ~/~/содержание столбца
4418 + }
4419 + ]
4420 + },
4421 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4422 + "string"
4423 + ]
4424 + }
4425 +]
4426 +
4427 +
4428 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4429 +
4430 +(% class="box infomessage" %)
4431 +(((
4432 +POST/api/v3/Vehicles/recyclebin/erase
4433 +)))
4434 +
4435 +В заголовках запроса: X-Auth: Токен авторизации
4436 +
4437 +Пример запроса:
4438 +
4439 +[
4440 +0
4441 +]
4442 +
4443 +
4444 +Пример ответа:
4445 +
4446 +[ 
4447 +{
4448 + "recordTime": "", ~/~/Время записи
4449 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4450 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4451 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4452 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4453 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4454 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4455 + "items": [ ~/~/Детали
4456 + {
4457 + "name": "", ~/~/Имя свойства
4458 + "value": "" ~/~/Значение свойства
4459 + }
4460 + ]
4461 + },
4462 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4463 + ""
4464 + ]
4465 + }
4466 +]
4467 +
4468 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4469 +
4470 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4471 +
4472 +(% class="box infomessage" %)
4473 +(((
4474 +POST/api/v3/Vehicles/recyclebin/restore
4475 +)))
4476 +
4477 +В заголовках запроса: X-Auth: Токен авторизации
4478 +
4479 +Параметры в теле запроса (JSON):
4480 +
4481 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4482 +
4483 +В заголовках запроса: X-Auth: Токен авторизации
4484 +
4485 +
4486 +Пример запроса:
4487 +
4488 +(((
4489 +[
4490 +)))
4491 +
4492 +(((
4493 + 0
4494 +)))
4495 +
4496 +(((
4497 +]
4498 +)))
4499 +
4500 +
4501 +Пример ответа:
4502 +
4503 +[
4504 +{
4505 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4506 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4507 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4508 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4509 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4510 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4511 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4512 + "items": [ ~/~/Детали
4513 + {
4514 + "name": "string", ~/~/Имя свойства
4515 + "value": "string" ~/~/Значение свойства
4516 + }
4517 + ]
4518 + },
4519 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4520 + "string"
4521 + ]
4522 + }
4523 +]
4524 +
4525 +
4526 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% 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 г.