Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 108.1 >
edited by Илья Крайнов
on 2023/09/27 15:57
To version < 158.2 >
edited by Андрей Калиновский
on 2024/07/19 15:59
>
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" %)**Получение информации об объекте**(%%) ==
... ... @@ -825,31 +825,19 @@
825 825   },
826 826  
827 827  ~/~/ Характерные для произвольного:
828 -
829 829  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 831  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 833  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 835  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 837  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 839  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 841  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 843  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 845  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 847  ~/~/ "ValueOn": "Вкл.",
848 -
849 849  ~/~/ "ValueOff": "Выкл."
850 850   "summaryMaxValue": 0 ~/~/ Макс. значение
851 851   }
852 -
853 853   "drivers": [ ~/~/ Водители
854 854   {
855 855   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -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  
1200 +
1201 +== **Получить ответ на отправленную на ТС команду** ==
1202 +
1203 +(% class="box infomessage" %)
1204 +(((
1205 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1206 +)))
1207 +
1208 +Идентификатор команды: cmdid
1209 +
1210 +Запрос от терминала на ответ команды
1211 +
1212 +Пример ответ от терминала:
1213 +
1214 +ID= "" ~/~/ идентификатор произвольного поля
1215 +Soft="" ~/~/ версия софта
1216 +GPS=4 ~/~/ тип трекера
1217 +Time=11:05:43 28.06.24 ~/~/ время запроса
1218 +Lat=45.056221 ~/~/ широта
1219 +Lon=39.035938 ~/~/ долгота
1220 +Speed=0.0 ~/~/ скорость
1221 +Course=181.4 ~/~/направление
1222 +
1223 +(((
1224 +== **Список отправленных объекту команд с ответами** ==
1225 +
1226 +(% class="box infomessage" %)
1227 +(((
1228 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1229 +)))
1230 +
1231 +Идентификатор ТС: vehicleId
1232 +
1233 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1234 +
1235 +Пример ответа терминала
1236 +
1237 +[ 
1238 +{    
1239 +"id": "", ~/~/ идентификатор пользователя
1240 +"commandText": "", ~/~/Текст команды.
1241 +"templateId": "", ~/~/Идентификатор шаблона
1242 +"updated": "", ~/~/ Время отправки  
1243 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1244 +"answer": "", ~/~/ Ответ терминала.
1245 +"status": "" ~/~/ Статус отправки
1246 +}
1247 +]
1248 +
1249 +
1250 +)))
1251 +
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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1474 +(% 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  
1595 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
1596 +**Отправить команду на терминал**
1597 +
1598 +(% class="box successmessage" %)
1599 +(((
1600 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1601 +)))
1602 +
1603 +Команда для отправки на тс.
1604 +
1605 +{  
1606 +"id": "", ~/~/идентификатор произвольного поля
1607 +"command": "", ~/~/ Текст команды
1608 +"retries": "", ~/~/ Количество попыток
1609 +"idTemplate": "" ~/~/ ID шаблона команды
1610 +}
1611 +
1612 +
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]]
1866 +(% 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  
... ... @@ -1523,13 +1523,10 @@
1523 1523  
1524 1524  (% style="color:#000000" %)Ответ:
1525 1525  
1526 -(% style="color:#000000" %){
1527 -
1899 +(% style="color:#000000" %){(%%)
1528 1528   "id": "", ~/~/ ID типа датчика 
1529 1529   "name": "", ~/~/ Название
1530 1530   "description": "", ~/~/ Описание
1531 -
1532 -(% style="text-align:left" %)
1533 1533  (% style="color:#000000" %)}
1534 1534  
1535 1535  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
1946 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1947 +
1948 +(% class="box infomessage" style="text-align: left;" %)
1949 +(((
1950 +**POST /api/v3/terminalMessages/mapping**
1951 +)))
1952 +
1953 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1954 +
1955 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1956 +
1957 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1958 +
1959 +{
1960 + "protocolType": 0,
1961 + "params": ["string"]
1962 +}
1963 +
1964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1965 +|protocolType|ID типа протокола
1966 +|params|(((
1967 +Массив наименований параметров в сообщении
1968 +)))
1969 +
1970 +Ответ:
1971 +
1972 +{
1973 + "protocolType": 0,
1974 + "mapping": {
1975 + "additionalProp1": {
1976 + "inputType": 0,
1977 + "inputNumber": 0
1978 + },
1979 + "additionalProp2": {
1980 + "inputType": 0,
1981 + "inputNumber": 0
1982 + }
1983 + }
1984 +}
1985 +
1986 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1987 +|protocolType|Тип протокола
1988 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1989 +|inputNumber|(((
1990 +Номер входа
1991 +)))
1992 +
1993 +(% class="wikigeneratedid" %)
1994 +Перечень 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/]]
1995 +
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  
2020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2021 +|vehicleId|ID объекта
2022 +|from|Дата и время начала периода запроса
2023 +|to|Дата и время окончания периода запроса
2024 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,80 +1603,43 @@
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": { ~/~/ список параметров датчиков передаваемых терминалом
2031 + "deviceTime": "2023-11-29T07:40:44.052Z",
2032 + "serverTime": "2023-11-29T07:40:44.052Z",
2033 + "speed": 0,
2034 + "altitude": 0,
2035 + "latitude": 0,
2036 + "longitude": 0,
2037 + "satellites": 0,
2038 + "course": 0,
2039 + "voltage": 0,
2040 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
2045 + "photoCount": 0,
2046 + "lbsCorrectedCoords": true,
2047 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
2053 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2054 +|deviceTime|Время сообщения терминала
2055 +|serverTime|Время когда сообщение поступило на сервер
2056 +|speed|Скорость
2057 +|altitude|Высота над уровнем моря
2058 +|latitude|Широта
2059 +|longitude|Долгота
2060 +|satellites|Кол-во спутников
2061 +|course|Курс
2062 +|voltage|Бортовое напряжение
2063 +|parameters|Список параметров и их значений
2064 +|photoCount|Количество фото
2065 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2066 +|protocolType|ID типа протокола
1626 1626  
1627 -(% class="box infomessage" %)
1628 -(((
1629 -**POST /api/v3/vehicles/export/history**
1630 -)))
1631 -
1632 -Метод возвращает список сообщений терминала объекта за выбранный период.
1633 -
1634 -(% style="text-align: left;" %)
1635 -Метод запроса **POST**
1636 -
1637 -(% style="text-align: left;" %)
1638 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1639 -
1640 -(% style="text-align: left;" %)
1641 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1642 -
1643 -{
1644 - "vehicleId": 0, ~/~/ ID объекта
1645 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1646 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1647 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1648 -}
1649 -
1650 -Ответ:
1651 -
1652 -Получаете файл. Сообщение: Code 200/Success
1653 -
1654 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/vehicles/export/history/status**
1659 -)))
1660 -
1661 -Метод возвращает список сообщений терминала объекта за выбранный период.
1662 -
1663 -(% style="text-align: left;" %)
1664 -Метод запроса **GET**
1665 -
1666 -(% style="text-align: left;" %)
1667 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1668 -
1669 -(% style="text-align: left;" %)
1670 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1671 -
1672 -Ответ:
1673 -
1674 -{
1675 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1676 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1677 - "message": "string" ~/~/ текст описывающий статус.
1678 -}
1679 -
1680 1680  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1681 1681  
1682 1682  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1810,6 +1810,97 @@
1810 1810   }
1811 1811  ]
1812 1812  
2201 +
2202 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2203 +
2204 +(% class="box infomessage" %)
2205 +(((
2206 +**POST /api/v3/vehicles/moveStop**
2207 +)))
2208 +
2209 +Метод запроса: **POST**
2210 +
2211 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2212 +
2213 +В заголовках запроса: X-Auth: Токен авторизации
2214 +
2215 +
2216 +Тело запроса:
2217 +
2218 +{
2219 + "vehicleIds": [ ], ~/~/ Список ID объектов
2220 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2221 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2222 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2223 +}
2224 +
2225 +Ответ:
2226 +
2227 +[ 
2228 + {
2229 + "vehicleId": 0, ~/~/ ID объекта
2230 + "vehicleName": "string", ~/~/ Имя объекта
2231 + "moves": [ ~/~/ Событие движения
2232 + {
2233 + "mileage": 0, ~/~/ Пробег, км
2234 + "eventId": 0, ~/~/ Идентификатор события
2235 + "eventName": "string", ~/~/ Название события
2236 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2237 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2238 + "duration": 0 ~/~/ Продолжительность события, секунд
2239 + }
2240 + ],
2241 + "stops": [ ~/~/ События стоянок
2242 + {
2243 + "address": "string", ~/~/ Адрес события
2244 + "eventId": 0, ~/~/ Идентификатор события
2245 + "eventName": "string", ~/~/ Название события
2246 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2247 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2248 + "duration": 0 ~/~/ Продолжительность события, секунд
2249 + }
2250 + ]
2251 + }
2252 +]
2253 +
2254 +
2255 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2256 +
2257 +(% class="box infomessage" %)
2258 +(((
2259 +**POST /api/v3/vehicles/getlastdata**
2260 +)))
2261 +
2262 +Метод запроса: **POST**
2263 +
2264 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2265 +
2266 +В заголовках запроса: X-Auth: Токен авторизации
2267 +
2268 +
2269 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2270 +
2271 +Ответ:
2272 + {
2273 + "vehicleId": 0, ~/~/Идентификатор объекта.
2274 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2275 + "vehicleNumber": "string",~/~/Номер объекта.
2276 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2277 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2278 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2279 + "speed": 0,~/~/Скорость объекта.
2280 + "course": 0,~/~/Курс движения [0;360]
2281 + "latitude": 0,~/~/Широта [-90°;90°].
2282 + "longitude": 0,~/~/Долгота [-180°;180°].
2283 + "address": "string",~/~/Адрес.
2284 + "geozones": [ ~/~/Сведения по геозонам.
2285 + {
2286 + "id": 0,
2287 + "name": "string"
2288 + }
2289 +
2290 +
2291 +
1813 1813  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1814 1814  
1815 1815  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2708,6 +2708,83 @@
2708 2708  Success
2709 2709  
2710 2710  
3190 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3191 +
3192 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3193 +
3194 +(% class="box infomessage" %)
3195 +(((
3196 +**POST /api/v3/Trailers**
3197 +)))
3198 +
3199 +Пример запроса:
3200 +
3201 +{
3202 + "startDate": "2023-11-14T10:48:03.671Z",
3203 + "endDate": "2023-11-14T10:48:03.671Z",
3204 + "ids": [ 0 ],
3205 + "timezone": 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" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3210 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3211 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3212 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3213 +
3214 +Пример ответа:
3215 +
3216 +[
3217 + {
3218 + "SD": "2023-11-14T10:48:03.717Z",
3219 + "ED": "2023-11-14T10:48:03.717Z", 
3220 + "id": 0,
3221 + "SLat": 0,
3222 + "SLon": 0,
3223 + "ELat": 0,
3224 + "ELon": 0,
3225 + "mileage": 0
3226 + "Duration": 0
3227 + "Address": "string",
3228 + "Address2": "string",
3229 + "name": "string",
3230 + "rid": "string",
3231 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3232 + "trailer": {
3233 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3234 + "Number": "string",
3235 + "Description": "string",
3236 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3237 + "ExternalID": "string",
3238 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3239 + "CreateTime": "2023-11-14T10:48:03.717Z",
3240 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3241 + "IsDeleted": true
3242 + },
3243 + "filesCount": 0,
3244 + }
3245 +]
3246 +
3247 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3248 +|SD|Дата и время начала события
3249 +|ED|Дата и время окончания события
3250 +|id|ID объекта
3251 +|SLat|Широта начальной координаты
3252 +|SLon|Долгота начальной координаты
3253 +|ELat|Широта конечной координаты
3254 +|ELon|Долгота конечной координаты
3255 +|mileage|Пробег
3256 +|Duration|Продолжительность
3257 +|Address|Адрес начального местоположения
3258 +|Address2|Адрес конечного местоположения
3259 +|name|Имя радиометки
3260 +|rid|Номер радиометки
3261 +|rguid|ID радиометки
3262 +|trailer|Информация об агрегате
3263 +|ModelGuid|ID агрегата
3264 +|Number|Название/номер агрегата
3265 +|Description|Текст примечания агрегата
3266 +
2711 2711  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2712 2712  
2713 2713  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2729,13 +2729,18 @@
2729 2729   {
2730 2730   "name": "string",
2731 2731   "number": 0,
2732 - "period": 0, ~/~/ Частота трансляции радиометки
3288 + "period": 0,
2733 2733   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2734 2734   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2735 - "deleted": true
2736 2736   }
2737 2737  ]
2738 2738  
3294 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3295 +|parentId|ID клиента
3296 +|name|Название карты-метки
3297 +|number|Номер
3298 +|period|Период запросов в секундах (работает только для агрегатов)
3299 +|id|ID карты-метки
2739 2739  
2740 2740  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2741 2741  
... ... @@ -2752,13 +2752,18 @@
2752 2752   {
2753 2753   "name": "string",
2754 2754   "number": 0,
2755 - "period": 0, ~/~/ Частота трансляции радиометки
3316 + "period": 0,
2756 2756   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2757 2757   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2758 - "deleted": true
2759 2759   }
2760 2760  ]
2761 2761  
3322 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3323 +|name|Название карты-метки
3324 +|number|Номер
3325 +|period|Период запросов в секундах (работает только для агрегатов)
3326 +|id|ID карты-метки
3327 +|parentId|ID клиента
2762 2762  
2763 2763  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2764 2764  
... ... @@ -2774,7 +2774,6 @@
2774 2774   "number": 0,
2775 2775   "period": 0,
2776 2776   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 - "deleted": true
2778 2778  }
2779 2779  
2780 2780  Ответ:
... ... @@ -2785,9 +2785,14 @@
2785 2785   "period": 0,
2786 2786   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 2787   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 - "deleted": true
2789 2789  }
2790 2790  
3355 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3356 +|name|Название карты-метки
3357 +|number|Номер
3358 +|period|Период запросов в секундах (работает только для агрегатов)
3359 +|id|ID карты-метки
3360 +|parentId|ID клиента
2791 2791  
2792 2792  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2793 2793  
... ... @@ -2804,7 +2804,6 @@
2804 2804   "period": 0,
2805 2805   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2806 2806   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2807 - "deleted": true
2808 2808  }
2809 2809  
2810 2810  Ответ:
... ... @@ -2815,9 +2815,14 @@
2815 2815   "period": 0,
2816 2816   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2817 2817   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2818 - "deleted": true
2819 2819  }
2820 2820  
3389 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3390 +|name|Название карты-метки
3391 +|number|Номер
3392 +|period|Период запросов в секундах (работает только для агрегатов)
3393 +|id|ID карты-метки
3394 +|parentId|ID клиента
2821 2821  
2822 2822  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2823 2823  
... ... @@ -2826,7 +2826,7 @@
2826 2826  **DELETE /api/v3/Rfids/{rfidGuid}**
2827 2827  )))
2828 2828  
2829 -Передаем параметр rfidGuid - идентификатор карты-метки
3403 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,1108 @@
2833 2833  Success
2834 2834  
2835 2835  
3410 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3411 +
3412 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3413 +
3414 +(% class="box infomessage" %)
3415 +(((
3416 +**GET /api/v3/Billing/client/balance/{clientId}**
3417 +)))
3418 +
3419 +Параметр запроса: **clientId **- идентификатор клиента.
3420 +
3421 +Ответ:
3422 +
3423 +{
3424 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3425 + "Balance": 0
3426 +}
3427 +
3428 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3429 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3430 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3431 +
3432 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3433 +
3434 +(% class="box infomessage" %)
3435 +(((
3436 +**GET /api/v3/Billing/client/constraint/{clientId}**
3437 +)))
3438 +
3439 +Параметр запроса: **clientId **- идентификатор клиента.
3440 +
3441 +Ответ:
3442 +
3443 +{
3444 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3445 + "CalculationType": 0,
3446 + "PermissibleBalance": 0,
3447 + "DefermentDays": 0,
3448 + "SendUiNotifications": true,
3449 + "SendEmailNotifications": true,
3450 + "IsPrivate": true,
3451 +}
3452 +
3453 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3454 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3455 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3456 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3457 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3458 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3459 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3460 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3461 +
3462 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3463 +
3464 +(% class="box infomessage" %)
3465 +(((
3466 +**GET /api/v3/Billing/client/plan/{clientId}**
3467 +)))
3468 +
3469 +Параметры запроса:
3470 +
3471 +**clientId **- идентификатор клиента.
3472 +
3473 +**planId **- идентификатор тарифного плана.
3474 +
3475 +Ответ:
3476 +
3477 +{
3478 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3479 + "Plan": { **~/~/ Описание тарифного плана**
3480 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3481 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3482 + "Name": "string",
3483 + "IsArchived": true,
3484 + "Constraint": {
3485 + "CalculationType": 0,
3486 + "PermissibleBalance": 0,
3487 + "DefermentDays": 0
3488 + },
3489 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3490 + {
3491 + "Feature": "string",
3492 + "IsFactual": true,
3493 + "Limit": 0,
3494 + "Price": 0,
3495 + "PeriodValue": 0,
3496 + "PeriodType": 0
3497 + }
3498 + ]
3499 + },
3500 + "DebitDate": "2023-10-18T12:46:24.213Z",
3501 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3502 + {
3503 + "Feature": "string",
3504 + "IsEnabled": true,
3505 + "IsPrivate": true,
3506 + "IsFactual": true,
3507 + "Limit": 0,
3508 + "Price": 0,
3509 + "DebitDate": "2023-10-18T12:46:24.213Z",
3510 + "PeriodValue": 0,
3511 + "PeriodType": 0
3512 + }
3513 + ]
3514 +}
3515 +
3516 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3517 +|ClientId|Идентификатор клиента
3518 +|Id|Идентификатор тарифного плана
3519 +|OwnerId|Идентификатор клиента-владельца
3520 +|Name|Наименование тарифного плана
3521 +|IsArchived|Признак, определяющий архивный тарифный план
3522 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3523 +|PermissibleBalance|Допустимый баланс
3524 +|DefermentDays|Отсрочка, количество дней
3525 +|Feature|Код услуги
3526 +|IsEnabled|Признак, определяющий активирована ли услуга
3527 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3528 +|IsFactual|Признак, определяющий расчёт по факту
3529 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3530 +|Price|Цена за единицу.
3531 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3532 +|PeriodValue|Значение периода.
3533 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3534 +
3535 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3536 +
3537 +(% class="box infomessage" %)
3538 +(((
3539 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3540 +)))
3541 +
3542 +Параметр запроса: **clientId **- идентификатор клиента.
3543 +
3544 +Ответ:
3545 +
3546 +[
3547 + {
3548 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3550 + "Name": "string",
3551 + "IsArchived": true,
3552 + "Constraint": {
3553 + "CalculationType": 0,
3554 + "PermissibleBalance": 0,
3555 + "DefermentDays": 0
3556 + },
3557 + "Features": [
3558 + {
3559 + "Feature": "string",
3560 + "IsFactual": true,
3561 + "Limit": 0,
3562 + "Price": 0,
3563 + "PeriodValue": 0,
3564 + "PeriodType": 0
3565 + }
3566 + ]
3567 + }
3568 +]
3569 +
3570 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3571 +|ClientId|Идентификатор клиента
3572 +|Id|Идентификатор тарифного плана
3573 +|OwnerId|Идентификатор клиента-владельца
3574 +|Name|Наименование тарифного плана
3575 +|IsArchived|Признак, определяющий архивный тарифный план
3576 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3577 +|PermissibleBalance|Допустимый баланс
3578 +|DefermentDays|Отсрочка, количество дней
3579 +|Feature|Код услуги
3580 +|IsFactual|Признак, определяющий расчёт по факту
3581 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3582 +|Price|Цена за единицу.
3583 +|PeriodValue|Значение периода.
3584 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3585 +
3586 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3587 +
3588 +(% class="box infomessage" %)
3589 +(((
3590 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3591 +)))
3592 +
3593 +Параметр запроса: **clientId **- идентификатор клиента.
3594 +
3595 +Ответ:
3596 +
3597 +[
3598 + {
3599 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3600 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3601 + "Name": "string",
3602 + "IsArchived": true,
3603 + "Constraint": {
3604 + "CalculationType": 0,
3605 + "PermissibleBalance": 0,
3606 + "DefermentDays": 0
3607 + },
3608 + "Features": [
3609 + {
3610 + "Feature": "string",
3611 + "IsFactual": true,
3612 + "Limit": 0,
3613 + "Price": 0,
3614 + "PeriodValue": 0,
3615 + "PeriodType": 0
3616 + }
3617 + ]
3618 + }
3619 +]
3620 +
3621 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3622 +|ClientId|Идентификатор клиента
3623 +|Id|Идентификатор тарифного плана
3624 +|OwnerId|Идентификатор клиента-владельца
3625 +|Name|Наименование тарифного плана
3626 +|IsArchived|Признак, определяющий архивный тарифный план
3627 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3628 +|PermissibleBalance|Допустимый баланс
3629 +|DefermentDays|Отсрочка, количество дней
3630 +|Feature|Код услуги
3631 +|IsFactual|Признак, определяющий расчёт по факту
3632 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3633 +|Price|Цена за единицу.
3634 +|PeriodValue|Значение периода.
3635 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3636 +
3637 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3638 +
3639 +(% class="box warningmessage" %)
3640 +(((
3641 +**PUT /api/v3/Billing/client/balance**
3642 +)))
3643 +
3644 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3645 +
3646 +Тело запроса:
3647 +
3648 +{
3649 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3650 + "Balance": 0
3651 +}
3652 +
3653 +Ответ: Success
3654 +
3655 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3656 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3657 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3658 +
3659 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3660 +
3661 +(% class="box warningmessage" %)
3662 +(((
3663 +**PUT /api/v3/billing/client/balance/deposit**
3664 +)))
3665 +
3666 +Создает операцию **Пополнение **с указанной суммой
3667 +
3668 +Тело запроса:
3669 +
3670 +{
3671 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3672 + "Balance": 0
3673 +}
3674 +
3675 +Ответ: Success
3676 +
3677 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3678 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3679 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3680 +
3681 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3682 +
3683 +Создает операцию **Списание **с указанной суммой
3684 +
3685 +(% class="box warningmessage" %)
3686 +(((
3687 +**PUT /api/v3/billing/client/balance/withdraw**
3688 +)))
3689 +
3690 +Тело запроса:
3691 +
3692 +{
3693 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3694 + "Balance": 0
3695 +}
3696 +
3697 +Ответ: Success
3698 +
3699 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3700 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3701 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3702 +
3703 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3704 +
3705 +(% class="box warningmessage" %)
3706 +(((
3707 +**PUT /api/v3/Billing/client/constraint**
3708 +)))
3709 +
3710 +Тело запроса:
3711 +
3712 +{
3713 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3714 + "CalculationType": 0,
3715 + "PermissibleBalance": 0,
3716 + "DefermentDays": 0,
3717 + "SendUiNotifications": true,
3718 + "SendEmailNotifications": true,
3719 + "IsPrivate": true,
3720 +}
3721 +
3722 +Ответ: Success
3723 +
3724 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3725 +|ClientId|Идентификатор клиента
3726 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3727 +|PermissibleBalance|Допустимый баланс
3728 +|DefermentDays|(((
3729 +Отсрочка, количество дней
3730 +)))
3731 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3732 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3733 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3734 +
3735 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3736 +
3737 +(% class="box warningmessage" %)
3738 +(((
3739 +**PUT /api/v3/Billing/client/plan**
3740 +)))
3741 +
3742 +Тело запроса:
3743 +
3744 +{
3745 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3746 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3747 + "Features": [
3748 + {
3749 + "Feature": "string",
3750 + "IsEnabled": true,
3751 + "IsFactual": true,
3752 + "Limit": 0,
3753 + "Price": 0,
3754 + "DebitDate": "2023-10-18T13:26:58.987Z",
3755 + "PeriodValue": 0,
3756 + "PeriodType": 0
3757 + }
3758 + ]
3759 +}
3760 +
3761 +Ответ: Success
3762 +
3763 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3764 +|ClientId|Идентификатор клиента
3765 +|PlanId|Идентификатор тарифного плана
3766 +|Feature|Код услуги
3767 +|IsEnabled|Признак, определяющий активирована ли услуга
3768 +|IsFactual|Признак, определяющий расчёт по факту
3769 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3770 +|Price|Цена за единицу.
3771 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3772 +|PeriodValue|Значение периода.
3773 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3774 +
3775 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3776 +
3777 +(% class="box warningmessage" %)
3778 +(((
3779 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3780 +)))
3781 +
3782 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3783 +
3784 +(% class="box infomessage" %)
3785 +(((
3786 +**POST /api/v3/vehicles/import/{agentId}**
3787 +)))
3788 +
3789 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3790 +
3791 +В пути указывается **agentId** - id клиента.
3792 +
3793 +**Заголовок**
3794 +
3795 +**X-Auth: [токен авторизации]**
3796 +
3797 +**Параметры**
3798 +
3799 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3800 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3801 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3802 +
3803 +В теле использовать тип **form-data,** тип значения** file**
3804 +
3805 +**Ключи**
3806 +
3807 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3808 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3809 +|csv|В значении передаем файл датчиков, формат **csv**
3810 +
3811 +Ответ:
3812 +
3813 +{
3814 + "vehicleId": 0,
3815 + "name": "string",
3816 + "errors": ["string"]
3817 +}
3818 +
3819 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3820 +|vehicleId|ID созданного объекта
3821 +|name|Имя созданного объекта
3822 +|errors|Ошибки и их описание
3823 +
3824 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3825 +
3826 +(% class="box infomessage" %)
3827 +(((
3828 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3829 +)))
3830 +
3831 +(% class="wikigeneratedid" %)
3832 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3833 +
3834 +(% class="wikigeneratedid" %)
3835 +В пути указывается **vehicleId **- id объекта.
3836 +
3837 +**Заголовок**
3838 +
3839 +**X-Auth: [токен авторизации]**
3840 +
3841 +В теле использовать тип **form-data.**
3842 +
3843 +Ключи:
3844 +
3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 +|**history**|В значении передавать файл с историей
3847 +
3848 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3849 +
3850 +Ответ:
3851 +
3852 +{
3853 + "results": [
3854 + {
3855 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3856 + "vehicleId": 0,
3857 + "errors": [
3858 + "string"
3859 + ],
3860 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3861 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3862 + "producedCount": 0,
3863 + "msgCount": 0
3864 + }
3865 + ]
3866 +}
3867 +
3868 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3869 +|results|Результаты импорта в разрезе ТС
3870 +|vehicleGuid|Guid ТС
3871 +|vehicleId|ID ТС
3872 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3873 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3874 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3875 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3876 +|msgCount|Кол-во обработанных сообщений всего
3877 +
3878 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3879 +
3880 +(% class="box infomessage" %)
3881 +(((
3882 +**GET /api/v3/vehicles/import/history/status**
3883 +)))
3884 +
3885 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3886 +
3887 +Ответ:
3888 +
3889 +{
3890 + "activity": true,
3891 + "progress": 0,
3892 + "message": "string"
3893 +}
3894 +
3895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3896 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3897 +|progress|Guid ТС
3898 +
3899 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3900 +
3901 +(% class="box infomessage" %)
3902 +(((
3903 +**POST /api/v3/vehicles/export**
3904 +)))
3905 +
3906 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3907 +
3908 +Тело запроса:
3909 +
3910 +[
3911 + id
3912 +]
3913 +
3914 +Ответ: Success 200, получаете файлы с настройками.
3915 +
3916 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3917 +
3918 +(% class="box infomessage" %)
3919 +(((
3920 +**POST /api/v3/vehicles/export/history**
3921 +)))
3922 +
3923 +Метод возвращает список сообщений терминала объекта за выбранный период.
3924 +
3925 +Тело запроса:
3926 +
3927 +{
3928 + "vehicleId": 0,
3929 + "asArchive": true,
3930 + "from": "2023-09-27T12:17:45.973Z",
3931 + "to": "2023-09-27T12:17:45.973Z"
3932 +}
3933 +
3934 +Ответ:
3935 +
3936 +Получаете файл. Сообщение: Code 200/Success
3937 +
3938 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3939 +|vehicleId|ID объекта
3940 +|asArchive|true - Архивировать файл, False - не архивировать
3941 +|from|Дата и время начала запроса
3942 +|to|Дата и время окончания запроса
3943 +
3944 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3945 +
3946 +(% class="box infomessage" %)
3947 +(((
3948 +**GET /api/v3/vehicles/export/history/status**
3949 +)))
3950 +
3951 +Метод возвращает список сообщений терминала объекта за выбранный период.
3952 +
3953 +Ответ:
3954 +
3955 +{
3956 + "activity": true,
3957 + "progress": 0,
3958 + "message": "string"
3959 +}
3960 +
3961 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3962 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3963 +|progress|Прогресс экспорта, от 0 до 100%
3964 +|message|Текст описывающий статус
3965 +
3966 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3967 +
3968 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3969 +
3970 +(% class="box infomessage" %)
3971 +(((
3972 +**POST /api/v3/EcoDriving/rating**
3973 +)))
3974 +
3975 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3976 +
3977 +Тело запроса:
3978 +
3979 +{
3980 + "vehicleIds": [vehicleId],
3981 + "from": "2023-11-22T09:29:48.051Z",
3982 + "to": "2023-11-22T09:29:48.051Z"
3983 +}
3984 +
3985 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3986 +|vehicleIds|Массив ID объектов
3987 +|from|Дата начала запроса
3988 +|to|Дата окончания запроса
3989 +
3990 +Ответ:
3991 +
3992 +{
3993 + "items": [
3994 + {
3995 + "from": "2023-11-22T09:29:48.052Z",
3996 + "to": "2023-11-22T09:29:48.052Z",
3997 + "vehicleId": 0,
3998 + "vehicleName": "string",
3999 + "vehicleModel": "string",
4000 + "penalty": 0,
4001 + "score": 0,
4002 + "totalViolations": 0,
4003 + "violationsByType": {
4004 + "overspeedingViolations": 0,
4005 + "accelerationViolations": 0,
4006 + "brakingViolations": 0,
4007 + "turningViolations": 0,
4008 + "dangerousDrivingViolations": 0,
4009 + "sensorViolations": 0
4010 + },
4011 + "moveTime": 0,
4012 + "mileage": 0,
4013 + "tripsCount": 0,
4014 + "trips": [
4015 + {
4016 + "penalty": 0,
4017 + "score": 0,
4018 + "violationsCount": 0,
4019 + "violationsByType": {
4020 + "overspeedingViolations": 0,
4021 + "accelerationViolations": 0,
4022 + "brakingViolations": 0,
4023 + "turningViolations": 0,
4024 + "dangerousDrivingViolations": 0,
4025 + "sensorViolations": 0
4026 + },
4027 + "moveTime": 0,
4028 + "mileage": 0,
4029 + "motohours": 0,
4030 + "maxSpeed": 0,
4031 + "startAddress": "string",
4032 + "endAddress": "string",
4033 + "drivers": [
4034 + {
4035 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4036 + "driverName": "string",
4037 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4038 + }
4039 + ]
4040 + }
4041 + ]
4042 + }
4043 + ]
4044 +}
4045 +
4046 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4047 +|from|Дата начала запроса
4048 +|to|Дата  окончания
4049 +|vehicleId|ID объекта
4050 +|vehicleName|Имя объекта
4051 +|vehicleModel|Модель объекта
4052 +|penalty|Сумма штрафных баллов
4053 +|score|Оценка
4054 +|totalViolations|Суммарное количество нарушений
4055 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4056 +|overspeedingViolations|Превышение скорости
4057 +|accelerationViolations|Ускорение
4058 +|brakingViolations|Торможение
4059 +|turningViolations|Резкий поворот
4060 +|dangerousDrivingViolations|Резкое вождение
4061 +|sensorViolations|Нарушение по датчику
4062 +|moveTime|Время в движении
4063 +|mileage|Пробег
4064 +|tripsCount|Количество рейсов
4065 +|motohours|Моточасы
4066 +|maxSpeed|Максимальная скорость
4067 +|startAddress|Адрес начала рейса
4068 +|endAddress|Адрес окончания рейса
4069 +|drivers|Список водителей, которые были на объекте в течениии рейса
4070 +|driverGuid|Guid водителя
4071 +|driverName|Имя водителя
4072 +|driverRfid|Номер Карты-метки
4073 +
4074 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4075 +
4076 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4077 +
4078 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4079 +
4080 +(% class="box infomessage" %)
4081 +(((
4082 +POST /api/v3/fuelcards/transactions
4083 +)))
4084 +
4085 +Метод запроса: POST
4086 +
4087 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4088 +\\В заголовках запроса: X-Auth: Токен авторизации
4089 +
4090 +Параметры в теле запроса (JSON):
4091 +
4092 +{
4093 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4094 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4095 + "ids": [ 
4096 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4097 + ],
4098 + "timezone": 0 ~/~/Таймзона
4099 +}
4100 +
4101 +
4102 +Ответ:
4103 + {
4104 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4105 + "driver": "string", ~/~/Водители, привязанные к ТК
4106 + "object": "string", ~/~/Наименование ТС
4107 + "amount": 0, ~/~/Количество топлива
4108 + "amountDut": 0, ~/~/Количество по ДУТ
4109 + "amountDiff": 0, ~/~/Разница, л
4110 + "amountDiffPerc": 0, ~/~/Разница, %
4111 + "summa": 0, ~/~/Стоимость, руб
4112 + "serviceName": "string", ~/~/Тип топлива
4113 + "price": 0, ~/~/Цена за литр, руб
4114 + "cardName": "string", ~/~/Наименование ТК
4115 + "cardNum": "string", ~/~/Номер ТК
4116 + "operator": "string", ~/~/Оператор ТК
4117 + "address": "string" ~/~/Адрес АЗС
4118 + }
4119 +
4120 +
4121 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4122 +
4123 +
4124 +== **Получение полных данных о ретрансляторе** ==
4125 +
4126 +(% class="box infomessage" %)
4127 +(((
4128 +**GET ** **/api/v3/retranslations/{id}**
4129 +)))
4130 +
4131 +Идентификатор запроса: ID
4132 +
4133 +
4134 +Пример ответа:
4135 +
4136 +{  
4137 +"description": "", ~/~/ Определяет описание
4138 +"subscriberId": "", ~/~/ Подписчик
4139 +"protocolType": 0, ~/~/ Тип протокола
4140 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4141 +"address": "string", ~/~/ Адрес события
4142 +"objects": [ ~/~/Объекты для ретрансляции
4143 +{      
4144 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4145 +"name": "", ~/~/ Наименование объекта ретрансляции
4146 +"imei": "", ~/~/ IMEI объекта  
4147 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4148 +}
4149 + ],  
4150 +"id": "", ~/~/ идентификатор пользователя   
4151 +"parentId": "", ~/~/Guid родителя
4152 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4153 +}
4154 +
4155 +
4156 +== **Удаление данных ретранслятора** ==
4157 +
4158 +(% class="box infomessage" %)
4159 +(((
4160 +**DELETE** **/api/v3/retranslations/{id}**
4161 +)))
4162 +
4163 +Параметр запроса: ID
4164 +
4165 +
4166 +== **Создание ретранслятора** ==
4167 +
4168 +(% class="box infomessage" %)
4169 +(((
4170 +**POST ** **/api/v3/retranslations/{id}**
4171 +)))
4172 +
4173 +Запрос:
4174 +
4175 +{  
4176 +"description": "", ~/~/ Описание
4177 +"subscriberId": "", ~/~/ Подписчик
4178 +"protocolType": 0, ~/~/ Тип протокола
4179 +"address": "", ~/~/ Адрес ретрансляции
4180 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4181 +"objects": [ ~/~/Объекты для ретрансляции
4182 +{      
4183 +"id": "", ~/~/ идентификатор пользователя     
4184 +"imei": "", ~/~/IMEI объекта
4185 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4186 +}
4187 + ]
4188 +}
4189 +
4190 +
4191 +Ответ:
4192 +
4193 +{  
4194 +"description": "string", ~/~/ Определяет описание
4195 +"subscriberId": "", ~/~/ идентификатор запроса
4196 +"protocolType": 0, ~/~/ Тип протокола
4197 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4198 +"address": "", ~/~/ Адрес события
4199 +"objects": [ ~/~/Объекты для ретрансляции
4200 +{      
4201 +"id": "", ~/~/ идентификатор пользователя    
4202 +"name": "string", ~/~/ Название уведомления
4203 +"imei": "string", ~/~/IMEI объекта  
4204 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4205 +}
4206 + ],  
4207 +"id": "", ~/~/ идентификатор пользователя  
4208 +"parentId": "", ~/~/ Guid идентификатор родителя
4209 +"deleted": true ~/~/ Признак удаления
4210 +}
4211 +
4212 +
4213 +== **Редактирование ретранслятора** ==
4214 +
4215 +(% class="box infomessage" %)
4216 +(((
4217 +**PUT** **/api/v3/retranslations**
4218 +)))
4219 +
4220 +Пример запроса:
4221 +
4222 +{  
4223 +"id": "", ~/~/ идентификатор пользователя   
4224 +"description": "string", ~/~/ Определяет описание
4225 +"subscriberId": "", ~/~/ идентификатор запроса
4226 +"protocolType": 0, ~/~/ Тип протокола
4227 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4228 +"address": "string", ~/~/ Адрес события
4229 +"objects": ~/~/Объекты для ретрансляции
4230 +[    
4231 +{      
4232 +"id": "",  ~/~/ идентификатор пользователя         
4233 +"imei": "", ~/~/IMEI объекта
4234 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4235 +}
4236 + ]
4237 +}
4238 +
4239 +
4240 +Пример ответа:
4241 +
4242 +{  
4243 +"description": "", ~/~/ Определяет описание
4244 +"subscriberId": "", ~/~/ идентификатор запроса
4245 +"protocolType": 0, ~/~/ Тип протокола
4246 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4247 +"address": "string", ~/~/ Адрес события
4248 +"objects": [ ~/~/Объекты для ретрансляции
4249 +{      
4250 +"id": "", ~/~/ идентификатор пользователя     
4251 +"name": "string", ~/~/ Название уведомления    
4252 +"imei": "", ~/~/IMEI объекта
4253 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4254 +}
4255 + ],
4256 +"id": "", ~/~/ идентификатор пользователя   
4257 +"parentId": "", ~/~/ Guid идентификатор родителя
4258 +"deleted": true ~/~/ Признак удаления
4259 +}
4260 +
4261 +
4262 +== **Получение списка ретранслятора клиента** ==
4263 +
4264 +(% class="box infomessage" %)
4265 +(((
4266 +**POST /api/v3/retranslations/find**
4267 +)))
4268 +
4269 +Пример запроса:
4270 +
4271 +{  
4272 +"id": "", ~/~/ идентификатор пользователя   
4273 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4274 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4275 +}
4276 +
4277 +Ответ
4278 +
4279 +[ 
4280 +{    
4281 +"description": "", ~/~/ Определяет описание
4282 +"subscriberId": "", ~/~/ идентификатор запроса
4283 +"protocolType": 0, ~/~/ Тип протокола
4284 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4285 +"address": "string", ~/~/ Адрес события
4286 +"id": "", ~/~/ идентификатор пользователя   
4287 +"parentId": "", ~/~/ Guid идентификатор родителя
4288 +"deleted": true ~/~/ Признак удаления
4289 +}
4290 +]
4291 +
4292 +
4293 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
4294 +
4295 +== **API для отчета по выгрузке комбайнов** ==
4296 +
4297 +(% class="box infomessage" %)
4298 +(((
4299 +POST **/api/v3/Reports/harvesterUnloading**
4300 +)))
4301 +
4302 +Пример запроса:
4303 +
4304 +{
4305 + "byTime": 0, ~/~/ Объединение событий по времени
4306 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4307 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4308 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4309 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4310 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4311 + 0
4312 + ],
4313 + "from": "", ~/~/ Дата и время начало запроса
4314 + "to": "", ~/~/ Дата и время окончания запроса
4315 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4316 +}
4317 +
4318 +Пример ответа:
4319 +
4320 +[ 
4321 + {
4322 + "harvesterName": "", ~/~/Комбайн, номер
4323 + "harvesterId": 0, ~/~/Комбайн, id
4324 +"harvesterModel": "", ~/~/ Модель комбайна
4325 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4326 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4327 + "events": [ ~/~/Список событий в разрезе комбайна
4328 + {
4329 + "driverId": "", ~/~/Идентификатор водителя
4330 + "driverName": "", ~/~/Водитель комбайна, ФИО
4331 + "RFID": "", ~/~/ идентификатор карты-метки
4332 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4333 + "vehicleId": 0, ~/~/идентификатор объекта
4334 + "vehicleName": "string", ~/~/ Имя объекта
4335 + "modelName": "string", ~/~/ Имя модели объекта
4336 + "nearestVehicles": [ ~/~/Объекты рядом
4337 + {
4338 + "vehicleId": 0, ~/~/идентификатор объекта
4339 + "vehicleName": "string" ~/~/ Имя объекта
4340 + }
4341 + ],
4342 + "fields": [ ~/~/Поля, где происходила выгрузка
4343 + {
4344 + "id": 0, ~/~/ идентификатор пользователя 
4345 + "name": "string" ~/~/ имя пользователя 
4346 + }
4347 + ],
4348 + "event": "string", ~/~/Событие
4349 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4350 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4351 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4352 + "cultureName": "string", ~/~/ название культуры
4353 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4354 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4355 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4356 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4357 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4358 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4359 + "issued": 0, ~/~/Выдано, бункеров
4360 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4361 + "latitude": 0, ~/~/Широта
4362 + "longitude": 0, ~/~/ Долгота
4363 + "litresAway": 0, ~/~/Отдано, л
4364 + "m3Away": 0 ~/~/Отдано, м3
4365 + }
4366 + ]
4367 + }
4368 +]
4369 +
4370 +
4371 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4372 +
4373 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4374 +
4375 +
4376 +(% class="box infomessage" %)
4377 +(((
4378 +GET api/v3/Vehicles/recyclebin/all
4379 +)))
4380 +
4381 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4382 +
4383 +Параметр запроса: {parentId} - идентификатор агента
4384 +
4385 +В заголовках запроса: X-Auth: Токен авторизации
4386 +
4387 +Ответ:
4388 +
4389 +[ 
4390 + {
4391 + "recordTime": "", ~/~/Время записи
4392 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4393 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4394 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4395 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4396 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4397 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4398 + "items": [ ~/~/ 
4399 +nullable: true ~/~/Детали
4400 + {
4401 + "name": "string", ~/~/наименование столбца
4402 + "value": "string" ~/~/содержание столбца
4403 + }
4404 + ]
4405 + },
4406 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4407 + "string"
4408 + ]
4409 + }
4410 +]
4411 +
4412 +
4413 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4414 +
4415 +(% class="box infomessage" %)
4416 +(((
4417 +POST/api/v3/Vehicles/recyclebin/erase
4418 +)))
4419 +
4420 +В заголовках запроса: X-Auth: Токен авторизации
4421 +
4422 +Пример запроса:
4423 +
4424 +[
4425 +0
4426 +]
4427 +
4428 +
4429 +Пример ответа:
4430 +
4431 +[ 
4432 +{
4433 + "recordTime": "", ~/~/Время записи
4434 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4435 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4436 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4437 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4438 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4439 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4440 + "items": [ ~/~/Детали
4441 + {
4442 + "name": "", ~/~/Имя свойства
4443 + "value": "" ~/~/Значение свойства
4444 + }
4445 + ]
4446 + },
4447 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4448 + ""
4449 + ]
4450 + }
4451 +]
4452 +
4453 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4454 +
4455 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4456 +
4457 +(% class="box infomessage" %)
4458 +(((
4459 +POST/api/v3/Vehicles/recyclebin/restore
4460 +)))
4461 +
4462 +В заголовках запроса: X-Auth: Токен авторизации
4463 +
4464 +Параметры в теле запроса (JSON):
4465 +
4466 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4467 +
4468 +В заголовках запроса: X-Auth: Токен авторизации
4469 +
4470 +
4471 +Пример запроса:
4472 +
4473 +(((
4474 +[
4475 +)))
4476 +
4477 +(((
4478 + 0
4479 +)))
4480 +
4481 +(((
4482 +]
4483 +)))
4484 +
4485 +
4486 +Пример ответа:
4487 +
4488 +[
4489 +{
4490 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4491 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4492 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4493 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4494 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4495 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4496 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4497 + "items": [ ~/~/Детали
4498 + {
4499 + "name": "string", ~/~/Имя свойства
4500 + "value": "string" ~/~/Значение свойства
4501 + }
4502 + ]
4503 + },
4504 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4505 + "string"
4506 + ]
4507 + }
4508 +]
4509 +
4510 +
4511 +
2836 2836  (% class="box" lang="en-US" style="text-align: center;" %)
2837 2837  (((
2838 2838  (% 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 г.