Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 108.1 >
edited by Илья Крайнов
on 2023/09/27 15:57
To version < 156.3 >
edited by Андрей Калиновский
on 2024/07/19 14:27
>
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,83 @@
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 +Пример ответ от терминала:
1227 +
1228 +
1229 +ID= "" ~/~/ идентификатор произвольного поля
1230 +
1231 +Soft="" ~/~/ версия софта
1232 +
1233 +GPS=4 ~/~/ тип трекера
1234 +
1235 +Time=11:05:43 28.06.24 ~/~/ время запроса
1236 +
1237 +Lat=45.056221 ~/~/ широта
1238 +
1239 +Lon=39.035938 ~/~/ долгота
1240 +
1241 +Speed=0.0 ~/~/ скорость
1242 +
1243 +Course=181.4 ~/~/направление
1244 +
1245 +
1246 +
1247 +(((
1248 +== **Список отправленных объекту команд с ответами** ==
1249 +
1250 +(% class="box infomessage" %)
1251 +(((
1252 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1253 +)))
1254 +
1255 +Идентификатор ТС: vehicleId
1256 +
1257 +
1258 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1259 +
1260 +
1261 +Пример ответа терминала
1262 +
1263 +
1264 +[ 
1265 +
1266 +{   
1267 +
1268 +"id": "", ~/~/ идентификатор пользователя
1269 +
1270 +"commandText": "", ~/~/Текст команды.
1271 +
1272 +"templateId": "", ~/~/Идентификатор шаблона
1273 +
1274 +"updated": "", ~/~/ Время отправки 
1275 +
1276 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1277 +
1278 +"answer": "", ~/~/ Ответ терминала.
1279 +
1280 +"status": "" ~/~/ Статус отправки
1281 +
1282 +}
1283 +
1284 +]
1285 +
1286 +
1287 +)))
1288 +
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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1511 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1237,6 +1237,30 @@
1237 1237  (% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1632 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
1633 +**Отправить команду на терминал**
1634 +
1635 +(% class="box successmessage" %)
1636 +(((
1637 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1638 +)))
1639 +
1640 +Команда для отправки на тс.
1641 +
1642 +
1643 +{ 
1644 +
1645 +"id": "", ~/~/идентификатор произвольного поля
1646 +
1647 +"command": "", ~/~/ Текст команды
1648 +
1649 +"retries": "", ~/~/ Количество попыток
1650 +
1651 +"idTemplate": "" ~/~/ ID шаблона команды
1652 +
1653 +}
1654 +
1655 +
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]]
1909 +(% 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  
1992 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1993 +
1994 +(% class="box infomessage" style="text-align: left;" %)
1995 +(((
1996 +**POST /api/v3/terminalMessages/mapping**
1997 +)))
1998 +
1999 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2000 +
2001 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2002 +
2003 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2004 +
2005 +{
2006 + "protocolType": 0,
2007 + "params": ["string"]
2008 +}
2009 +
2010 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2011 +|protocolType|ID типа протокола
2012 +|params|(((
2013 +Массив наименований параметров в сообщении
2014 +)))
2015 +
2016 +Ответ:
2017 +
2018 +{
2019 + "protocolType": 0,
2020 + "mapping": {
2021 + "additionalProp1": {
2022 + "inputType": 0,
2023 + "inputNumber": 0
2024 + },
2025 + "additionalProp2": {
2026 + "inputType": 0,
2027 + "inputNumber": 0
2028 + }
2029 + }
2030 +}
2031 +
2032 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2033 +|protocolType|Тип протокола
2034 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2035 +|inputNumber|(((
2036 +Номер входа
2037 +)))
2038 +
2039 +(% class="wikigeneratedid" %)
2040 +Перечень 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/]]
2041 +
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  
2066 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2067 +|vehicleId|ID объекта
2068 +|from|Дата и время начала периода запроса
2069 +|to|Дата и время окончания периода запроса
2070 +
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": { ~/~/ список параметров датчиков передаваемых терминалом
2077 + "deviceTime": "2023-11-29T07:40:44.052Z",
2078 + "serverTime": "2023-11-29T07:40:44.052Z",
2079 + "speed": 0,
2080 + "altitude": 0,
2081 + "latitude": 0,
2082 + "longitude": 0,
2083 + "satellites": 0,
2084 + "course": 0,
2085 + "voltage": 0,
2086 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
2091 + "photoCount": 0,
2092 + "lbsCorrectedCoords": true,
2093 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
2099 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2100 +|deviceTime|Время сообщения терминала
2101 +|serverTime|Время когда сообщение поступило на сервер
2102 +|speed|Скорость
2103 +|altitude|Высота над уровнем моря
2104 +|latitude|Широта
2105 +|longitude|Долгота
2106 +|satellites|Кол-во спутников
2107 +|course|Курс
2108 +|voltage|Бортовое напряжение
2109 +|parameters|Список параметров и их значений
2110 +|photoCount|Количество фото
2111 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2112 +|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,129 @@
1810 1810   }
1811 1811  ]
1812 1812  
2247 +
2248 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2249 +
2250 +(% class="box infomessage" %)
2251 +(((
2252 +**POST /api/v3/vehicles/moveStop**
2253 +)))
2254 +
2255 +Метод запроса: **POST**
2256 +
2257 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2258 +
2259 +В заголовках запроса: X-Auth: Токен авторизации
2260 +
2261 +
2262 +Тело запроса:
2263 +
2264 +{
2265 +
2266 + "vehicleIds": [ ], ~/~/ Список ID объектов
2267 +
2268 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2269 +
2270 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2271 +
2272 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2273 +
2274 +}
2275 +
2276 +Ответ:
2277 +
2278 +[
2279 +
2280 + {
2281 +
2282 + "vehicleId": 0, ~/~/ ID объекта
2283 +
2284 + "vehicleName": "string", ~/~/ Имя объекта
2285 +
2286 + "moves": [ ~/~/ Событие движения
2287 +
2288 + {
2289 +
2290 + "mileage": 0, ~/~/ Пробег, км
2291 +
2292 + "eventId": 0, ~/~/ Идентификатор события
2293 +
2294 + "eventName": "string", ~/~/ Название события
2295 +
2296 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2297 +
2298 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2299 +
2300 + "duration": 0 ~/~/ Продолжительность события, секунд
2301 +
2302 + }
2303 +
2304 + ],
2305 +
2306 + "stops": [ ~/~/ События стоянок
2307 +
2308 + {
2309 +
2310 + "address": "string", ~/~/ Адрес события
2311 +
2312 + "eventId": 0, ~/~/ Идентификатор события
2313 +
2314 + "eventName": "string", ~/~/ Название события
2315 +
2316 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2317 +
2318 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2319 +
2320 + "duration": 0 ~/~/ Продолжительность события, секунд
2321 +
2322 +
2323 + }
2324 +
2325 + ]
2326 +
2327 + }
2328 +
2329 +]
2330 +
2331 +
2332 +
2333 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2334 +
2335 +(% class="box infomessage" %)
2336 +(((
2337 +**POST /api/v3/vehicles/getlastdata**
2338 +)))
2339 +
2340 +Метод запроса: **POST**
2341 +
2342 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2343 +
2344 +В заголовках запроса: X-Auth: Токен авторизации
2345 +
2346 +
2347 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2348 +
2349 +Ответ:
2350 + {
2351 + "vehicleId": 0, ~/~/Идентификатор объекта.
2352 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2353 + "vehicleNumber": "string",~/~/Номер объекта.
2354 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2355 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2356 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2357 + "speed": 0,~/~/Скорость объекта.
2358 + "course": 0,~/~/Курс движения [0;360]
2359 + "latitude": 0,~/~/Широта [-90°;90°].
2360 + "longitude": 0,~/~/Долгота [-180°;180°].
2361 + "address": "string",~/~/Адрес.
2362 + "geozones": [ ~/~/Сведения по геозонам.
2363 + {
2364 + "id": 0,
2365 + "name": "string"
2366 + }
2367 +
2368 +
2369 +
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  
3268 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3269 +
3270 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3271 +
3272 +(% class="box infomessage" %)
3273 +(((
3274 +**POST /api/v3/Trailers**
3275 +)))
3276 +
3277 +Пример запроса:
3278 +
3279 +{
3280 + "startDate": "2023-11-14T10:48:03.671Z",
3281 + "endDate": "2023-11-14T10:48:03.671Z",
3282 + "ids": [ 0 ],
3283 + "timezone": 0
3284 +}
3285 +
3286 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3287 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3288 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3289 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3290 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3291 +
3292 +Пример ответа:
3293 +
3294 +[
3295 + {
3296 + "SD": "2023-11-14T10:48:03.717Z",
3297 + "ED": "2023-11-14T10:48:03.717Z", 
3298 + "id": 0,
3299 + "SLat": 0,
3300 + "SLon": 0,
3301 + "ELat": 0,
3302 + "ELon": 0,
3303 + "mileage": 0
3304 + "Duration": 0
3305 + "Address": "string",
3306 + "Address2": "string",
3307 + "name": "string",
3308 + "rid": "string",
3309 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3310 + "trailer": {
3311 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3312 + "Number": "string",
3313 + "Description": "string",
3314 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 + "ExternalID": "string",
3316 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3317 + "CreateTime": "2023-11-14T10:48:03.717Z",
3318 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3319 + "IsDeleted": true
3320 + },
3321 + "filesCount": 0,
3322 + }
3323 +]
3324 +
3325 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3326 +|SD|Дата и время начала события
3327 +|ED|Дата и время окончания события
3328 +|id|ID объекта
3329 +|SLat|Широта начальной координаты
3330 +|SLon|Долгота начальной координаты
3331 +|ELat|Широта конечной координаты
3332 +|ELon|Долгота конечной координаты
3333 +|mileage|Пробег
3334 +|Duration|Продолжительность
3335 +|Address|Адрес начального местоположения
3336 +|Address2|Адрес конечного местоположения
3337 +|name|Имя радиометки
3338 +|rid|Номер радиометки
3339 +|rguid|ID радиометки
3340 +|trailer|Информация об агрегате
3341 +|ModelGuid|ID агрегата
3342 +|Number|Название/номер агрегата
3343 +|Description|Текст примечания агрегата
3344 +
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, ~/~/ Частота трансляции радиометки
3366 + "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  
3372 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3373 +|parentId|ID клиента
3374 +|name|Название карты-метки
3375 +|number|Номер
3376 +|period|Период запросов в секундах (работает только для агрегатов)
3377 +|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, ~/~/ Частота трансляции радиометки
3394 + "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  
3400 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3401 +|name|Название карты-метки
3402 +|number|Номер
3403 +|period|Период запросов в секундах (работает только для агрегатов)
3404 +|id|ID карты-метки
3405 +|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  
3433 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3434 +|name|Название карты-метки
3435 +|number|Номер
3436 +|period|Период запросов в секундах (работает только для агрегатов)
3437 +|id|ID карты-метки
3438 +|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  
3467 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3468 +|name|Название карты-метки
3469 +|number|Номер
3470 +|period|Период запросов в секундах (работает только для агрегатов)
3471 +|id|ID карты-метки
3472 +|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 - идентификатор карты-метки
3481 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,1355 @@
2833 2833  Success
2834 2834  
2835 2835  
3488 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3489 +
3490 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3491 +
3492 +(% class="box infomessage" %)
3493 +(((
3494 +**GET /api/v3/Billing/client/balance/{clientId}**
3495 +)))
3496 +
3497 +Параметр запроса: **clientId **- идентификатор клиента.
3498 +
3499 +Ответ:
3500 +
3501 +{
3502 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3503 + "Balance": 0
3504 +}
3505 +
3506 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3507 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3508 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3509 +
3510 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3511 +
3512 +(% class="box infomessage" %)
3513 +(((
3514 +**GET /api/v3/Billing/client/constraint/{clientId}**
3515 +)))
3516 +
3517 +Параметр запроса: **clientId **- идентификатор клиента.
3518 +
3519 +Ответ:
3520 +
3521 +{
3522 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3523 + "CalculationType": 0,
3524 + "PermissibleBalance": 0,
3525 + "DefermentDays": 0,
3526 + "SendUiNotifications": true,
3527 + "SendEmailNotifications": true,
3528 + "IsPrivate": true,
3529 +}
3530 +
3531 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3532 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3533 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3534 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3535 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3536 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3537 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3538 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3539 +
3540 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3541 +
3542 +(% class="box infomessage" %)
3543 +(((
3544 +**GET /api/v3/Billing/client/plan/{clientId}**
3545 +)))
3546 +
3547 +Параметры запроса:
3548 +
3549 +**clientId **- идентификатор клиента.
3550 +
3551 +**planId **- идентификатор тарифного плана.
3552 +
3553 +Ответ:
3554 +
3555 +{
3556 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3557 + "Plan": { **~/~/ Описание тарифного плана**
3558 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3559 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3560 + "Name": "string",
3561 + "IsArchived": true,
3562 + "Constraint": {
3563 + "CalculationType": 0,
3564 + "PermissibleBalance": 0,
3565 + "DefermentDays": 0
3566 + },
3567 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3568 + {
3569 + "Feature": "string",
3570 + "IsFactual": true,
3571 + "Limit": 0,
3572 + "Price": 0,
3573 + "PeriodValue": 0,
3574 + "PeriodType": 0
3575 + }
3576 + ]
3577 + },
3578 + "DebitDate": "2023-10-18T12:46:24.213Z",
3579 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3580 + {
3581 + "Feature": "string",
3582 + "IsEnabled": true,
3583 + "IsPrivate": true,
3584 + "IsFactual": true,
3585 + "Limit": 0,
3586 + "Price": 0,
3587 + "DebitDate": "2023-10-18T12:46:24.213Z",
3588 + "PeriodValue": 0,
3589 + "PeriodType": 0
3590 + }
3591 + ]
3592 +}
3593 +
3594 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3595 +|ClientId|Идентификатор клиента
3596 +|Id|Идентификатор тарифного плана
3597 +|OwnerId|Идентификатор клиента-владельца
3598 +|Name|Наименование тарифного плана
3599 +|IsArchived|Признак, определяющий архивный тарифный план
3600 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3601 +|PermissibleBalance|Допустимый баланс
3602 +|DefermentDays|Отсрочка, количество дней
3603 +|Feature|Код услуги
3604 +|IsEnabled|Признак, определяющий активирована ли услуга
3605 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3606 +|IsFactual|Признак, определяющий расчёт по факту
3607 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3608 +|Price|Цена за единицу.
3609 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3610 +|PeriodValue|Значение периода.
3611 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3612 +
3613 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3614 +
3615 +(% class="box infomessage" %)
3616 +(((
3617 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3618 +)))
3619 +
3620 +Параметр запроса: **clientId **- идентификатор клиента.
3621 +
3622 +Ответ:
3623 +
3624 +[
3625 + {
3626 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3628 + "Name": "string",
3629 + "IsArchived": true,
3630 + "Constraint": {
3631 + "CalculationType": 0,
3632 + "PermissibleBalance": 0,
3633 + "DefermentDays": 0
3634 + },
3635 + "Features": [
3636 + {
3637 + "Feature": "string",
3638 + "IsFactual": true,
3639 + "Limit": 0,
3640 + "Price": 0,
3641 + "PeriodValue": 0,
3642 + "PeriodType": 0
3643 + }
3644 + ]
3645 + }
3646 +]
3647 +
3648 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3649 +|ClientId|Идентификатор клиента
3650 +|Id|Идентификатор тарифного плана
3651 +|OwnerId|Идентификатор клиента-владельца
3652 +|Name|Наименование тарифного плана
3653 +|IsArchived|Признак, определяющий архивный тарифный план
3654 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3655 +|PermissibleBalance|Допустимый баланс
3656 +|DefermentDays|Отсрочка, количество дней
3657 +|Feature|Код услуги
3658 +|IsFactual|Признак, определяющий расчёт по факту
3659 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3660 +|Price|Цена за единицу.
3661 +|PeriodValue|Значение периода.
3662 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3663 +
3664 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3665 +
3666 +(% class="box infomessage" %)
3667 +(((
3668 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3669 +)))
3670 +
3671 +Параметр запроса: **clientId **- идентификатор клиента.
3672 +
3673 +Ответ:
3674 +
3675 +[
3676 + {
3677 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3678 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3679 + "Name": "string",
3680 + "IsArchived": true,
3681 + "Constraint": {
3682 + "CalculationType": 0,
3683 + "PermissibleBalance": 0,
3684 + "DefermentDays": 0
3685 + },
3686 + "Features": [
3687 + {
3688 + "Feature": "string",
3689 + "IsFactual": true,
3690 + "Limit": 0,
3691 + "Price": 0,
3692 + "PeriodValue": 0,
3693 + "PeriodType": 0
3694 + }
3695 + ]
3696 + }
3697 +]
3698 +
3699 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3700 +|ClientId|Идентификатор клиента
3701 +|Id|Идентификатор тарифного плана
3702 +|OwnerId|Идентификатор клиента-владельца
3703 +|Name|Наименование тарифного плана
3704 +|IsArchived|Признак, определяющий архивный тарифный план
3705 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3706 +|PermissibleBalance|Допустимый баланс
3707 +|DefermentDays|Отсрочка, количество дней
3708 +|Feature|Код услуги
3709 +|IsFactual|Признак, определяющий расчёт по факту
3710 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3711 +|Price|Цена за единицу.
3712 +|PeriodValue|Значение периода.
3713 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3714 +
3715 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3716 +
3717 +(% class="box warningmessage" %)
3718 +(((
3719 +**PUT /api/v3/Billing/client/balance**
3720 +)))
3721 +
3722 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3723 +
3724 +Тело запроса:
3725 +
3726 +{
3727 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3728 + "Balance": 0
3729 +}
3730 +
3731 +Ответ: Success
3732 +
3733 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3734 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3735 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3736 +
3737 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3738 +
3739 +(% class="box warningmessage" %)
3740 +(((
3741 +**PUT /api/v3/billing/client/balance/deposit**
3742 +)))
3743 +
3744 +Создает операцию **Пополнение **с указанной суммой
3745 +
3746 +Тело запроса:
3747 +
3748 +{
3749 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3750 + "Balance": 0
3751 +}
3752 +
3753 +Ответ: Success
3754 +
3755 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3756 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3757 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3758 +
3759 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3760 +
3761 +Создает операцию **Списание **с указанной суммой
3762 +
3763 +(% class="box warningmessage" %)
3764 +(((
3765 +**PUT /api/v3/billing/client/balance/withdraw**
3766 +)))
3767 +
3768 +Тело запроса:
3769 +
3770 +{
3771 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3772 + "Balance": 0
3773 +}
3774 +
3775 +Ответ: Success
3776 +
3777 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3778 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3779 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3780 +
3781 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3782 +
3783 +(% class="box warningmessage" %)
3784 +(((
3785 +**PUT /api/v3/Billing/client/constraint**
3786 +)))
3787 +
3788 +Тело запроса:
3789 +
3790 +{
3791 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3792 + "CalculationType": 0,
3793 + "PermissibleBalance": 0,
3794 + "DefermentDays": 0,
3795 + "SendUiNotifications": true,
3796 + "SendEmailNotifications": true,
3797 + "IsPrivate": true,
3798 +}
3799 +
3800 +Ответ: Success
3801 +
3802 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3803 +|ClientId|Идентификатор клиента
3804 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3805 +|PermissibleBalance|Допустимый баланс
3806 +|DefermentDays|(((
3807 +Отсрочка, количество дней
3808 +)))
3809 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3810 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3811 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3812 +
3813 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3814 +
3815 +(% class="box warningmessage" %)
3816 +(((
3817 +**PUT /api/v3/Billing/client/plan**
3818 +)))
3819 +
3820 +Тело запроса:
3821 +
3822 +{
3823 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3824 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3825 + "Features": [
3826 + {
3827 + "Feature": "string",
3828 + "IsEnabled": true,
3829 + "IsFactual": true,
3830 + "Limit": 0,
3831 + "Price": 0,
3832 + "DebitDate": "2023-10-18T13:26:58.987Z",
3833 + "PeriodValue": 0,
3834 + "PeriodType": 0
3835 + }
3836 + ]
3837 +}
3838 +
3839 +Ответ: Success
3840 +
3841 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3842 +|ClientId|Идентификатор клиента
3843 +|PlanId|Идентификатор тарифного плана
3844 +|Feature|Код услуги
3845 +|IsEnabled|Признак, определяющий активирована ли услуга
3846 +|IsFactual|Признак, определяющий расчёт по факту
3847 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3848 +|Price|Цена за единицу.
3849 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3850 +|PeriodValue|Значение периода.
3851 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3852 +
3853 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3854 +
3855 +(% class="box warningmessage" %)
3856 +(((
3857 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3858 +)))
3859 +
3860 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3861 +
3862 +(% class="box infomessage" %)
3863 +(((
3864 +**POST /api/v3/vehicles/import/{agentId}**
3865 +)))
3866 +
3867 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3868 +
3869 +В пути указывается **agentId** - id клиента.
3870 +
3871 +**Заголовок**
3872 +
3873 +**X-Auth: [токен авторизации]**
3874 +
3875 +**Параметры**
3876 +
3877 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3878 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3879 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3880 +
3881 +В теле использовать тип **form-data,** тип значения** file**
3882 +
3883 +**Ключи**
3884 +
3885 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3886 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3887 +|csv|В значении передаем файл датчиков, формат **csv**
3888 +
3889 +Ответ:
3890 +
3891 +{
3892 + "vehicleId": 0,
3893 + "name": "string",
3894 + "errors": ["string"]
3895 +}
3896 +
3897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3898 +|vehicleId|ID созданного объекта
3899 +|name|Имя созданного объекта
3900 +|errors|Ошибки и их описание
3901 +
3902 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3903 +
3904 +(% class="box infomessage" %)
3905 +(((
3906 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3907 +)))
3908 +
3909 +(% class="wikigeneratedid" %)
3910 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3911 +
3912 +(% class="wikigeneratedid" %)
3913 +В пути указывается **vehicleId **- id объекта.
3914 +
3915 +**Заголовок**
3916 +
3917 +**X-Auth: [токен авторизации]**
3918 +
3919 +В теле использовать тип **form-data.**
3920 +
3921 +Ключи:
3922 +
3923 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3924 +|**history**|В значении передавать файл с историей
3925 +
3926 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3927 +
3928 +Ответ:
3929 +
3930 +{
3931 + "results": [
3932 + {
3933 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3934 + "vehicleId": 0,
3935 + "errors": [
3936 + "string"
3937 + ],
3938 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3939 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3940 + "producedCount": 0,
3941 + "msgCount": 0
3942 + }
3943 + ]
3944 +}
3945 +
3946 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3947 +|results|Результаты импорта в разрезе ТС
3948 +|vehicleGuid|Guid ТС
3949 +|vehicleId|ID ТС
3950 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3951 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3952 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3953 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3954 +|msgCount|Кол-во обработанных сообщений всего
3955 +
3956 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3957 +
3958 +(% class="box infomessage" %)
3959 +(((
3960 +**GET /api/v3/vehicles/import/history/status**
3961 +)))
3962 +
3963 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3964 +
3965 +Ответ:
3966 +
3967 +{
3968 + "activity": true,
3969 + "progress": 0,
3970 + "message": "string"
3971 +}
3972 +
3973 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3974 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3975 +|progress|Guid ТС
3976 +
3977 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3978 +
3979 +(% class="box infomessage" %)
3980 +(((
3981 +**POST /api/v3/vehicles/export**
3982 +)))
3983 +
3984 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3985 +
3986 +Тело запроса:
3987 +
3988 +[
3989 + id
3990 +]
3991 +
3992 +Ответ: Success 200, получаете файлы с настройками.
3993 +
3994 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3995 +
3996 +(% class="box infomessage" %)
3997 +(((
3998 +**POST /api/v3/vehicles/export/history**
3999 +)))
4000 +
4001 +Метод возвращает список сообщений терминала объекта за выбранный период.
4002 +
4003 +Тело запроса:
4004 +
4005 +{
4006 + "vehicleId": 0,
4007 + "asArchive": true,
4008 + "from": "2023-09-27T12:17:45.973Z",
4009 + "to": "2023-09-27T12:17:45.973Z"
4010 +}
4011 +
4012 +Ответ:
4013 +
4014 +Получаете файл. Сообщение: Code 200/Success
4015 +
4016 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4017 +|vehicleId|ID объекта
4018 +|asArchive|true - Архивировать файл, False - не архивировать
4019 +|from|Дата и время начала запроса
4020 +|to|Дата и время окончания запроса
4021 +
4022 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4023 +
4024 +(% class="box infomessage" %)
4025 +(((
4026 +**GET /api/v3/vehicles/export/history/status**
4027 +)))
4028 +
4029 +Метод возвращает список сообщений терминала объекта за выбранный период.
4030 +
4031 +Ответ:
4032 +
4033 +{
4034 + "activity": true,
4035 + "progress": 0,
4036 + "message": "string"
4037 +}
4038 +
4039 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4040 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4041 +|progress|Прогресс экспорта, от 0 до 100%
4042 +|message|Текст описывающий статус
4043 +
4044 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4045 +
4046 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4047 +
4048 +(% class="box infomessage" %)
4049 +(((
4050 +**POST /api/v3/EcoDriving/rating**
4051 +)))
4052 +
4053 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4054 +
4055 +Тело запроса:
4056 +
4057 +{
4058 + "vehicleIds": [vehicleId],
4059 + "from": "2023-11-22T09:29:48.051Z",
4060 + "to": "2023-11-22T09:29:48.051Z"
4061 +}
4062 +
4063 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4064 +|vehicleIds|Массив ID объектов
4065 +|from|Дата начала запроса
4066 +|to|Дата окончания запроса
4067 +
4068 +Ответ:
4069 +
4070 +{
4071 + "items": [
4072 + {
4073 + "from": "2023-11-22T09:29:48.052Z",
4074 + "to": "2023-11-22T09:29:48.052Z",
4075 + "vehicleId": 0,
4076 + "vehicleName": "string",
4077 + "vehicleModel": "string",
4078 + "penalty": 0,
4079 + "score": 0,
4080 + "totalViolations": 0,
4081 + "violationsByType": {
4082 + "overspeedingViolations": 0,
4083 + "accelerationViolations": 0,
4084 + "brakingViolations": 0,
4085 + "turningViolations": 0,
4086 + "dangerousDrivingViolations": 0,
4087 + "sensorViolations": 0
4088 + },
4089 + "moveTime": 0,
4090 + "mileage": 0,
4091 + "tripsCount": 0,
4092 + "trips": [
4093 + {
4094 + "penalty": 0,
4095 + "score": 0,
4096 + "violationsCount": 0,
4097 + "violationsByType": {
4098 + "overspeedingViolations": 0,
4099 + "accelerationViolations": 0,
4100 + "brakingViolations": 0,
4101 + "turningViolations": 0,
4102 + "dangerousDrivingViolations": 0,
4103 + "sensorViolations": 0
4104 + },
4105 + "moveTime": 0,
4106 + "mileage": 0,
4107 + "motohours": 0,
4108 + "maxSpeed": 0,
4109 + "startAddress": "string",
4110 + "endAddress": "string",
4111 + "drivers": [
4112 + {
4113 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4114 + "driverName": "string",
4115 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4116 + }
4117 + ]
4118 + }
4119 + ]
4120 + }
4121 + ]
4122 +}
4123 +
4124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4125 +|from|Дата начала запроса
4126 +|to|Дата  окончания
4127 +|vehicleId|ID объекта
4128 +|vehicleName|Имя объекта
4129 +|vehicleModel|Модель объекта
4130 +|penalty|Сумма штрафных баллов
4131 +|score|Оценка
4132 +|totalViolations|Суммарное количество нарушений
4133 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4134 +|overspeedingViolations|Превышение скорости
4135 +|accelerationViolations|Ускорение
4136 +|brakingViolations|Торможение
4137 +|turningViolations|Резкий поворот
4138 +|dangerousDrivingViolations|Резкое вождение
4139 +|sensorViolations|Нарушение по датчику
4140 +|moveTime|Время в движении
4141 +|mileage|Пробег
4142 +|tripsCount|Количество рейсов
4143 +|motohours|Моточасы
4144 +|maxSpeed|Максимальная скорость
4145 +|startAddress|Адрес начала рейса
4146 +|endAddress|Адрес окончания рейса
4147 +|drivers|Список водителей, которые были на объекте в течениии рейса
4148 +|driverGuid|Guid водителя
4149 +|driverName|Имя водителя
4150 +|driverRfid|Номер Карты-метки
4151 +
4152 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4153 +
4154 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4155 +
4156 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4157 +
4158 +(% class="box infomessage" %)
4159 +(((
4160 +POST /api/v3/fuelcards/transactions
4161 +)))
4162 +
4163 +Метод запроса: POST
4164 +
4165 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4166 +\\В заголовках запроса: X-Auth: Токен авторизации
4167 +
4168 +Параметры в теле запроса (JSON):
4169 +
4170 +{
4171 +
4172 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4173 +
4174 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4175 +
4176 + "ids": [
4177 +
4178 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4179 +
4180 + ],
4181 +
4182 + "timezone": 0 ~/~/Таймзона
4183 +
4184 +}
4185 +
4186 +Ответ:
4187 +
4188 + {
4189 +
4190 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4191 +
4192 + "driver": "string", ~/~/Водители, привязанные к ТК
4193 +
4194 + "object": "string", ~/~/Наименование ТС
4195 +
4196 + "amount": 0, ~/~/Количество топлива
4197 +
4198 + "amountDut": 0, ~/~/Количество по ДУТ
4199 +
4200 + "amountDiff": 0, ~/~/Разница, л
4201 +
4202 + "amountDiffPerc": 0, ~/~/Разница, %
4203 +
4204 + "summa": 0, ~/~/Стоимость, руб
4205 +
4206 + "serviceName": "string", ~/~/Тип топлива
4207 +
4208 + "price": 0, ~/~/Цена за литр, руб
4209 +
4210 + "cardName": "string", ~/~/Наименование ТК
4211 +
4212 + "cardNum": "string", ~/~/Номер ТК
4213 +
4214 + "operator": "string", ~/~/Оператор ТК
4215 +
4216 + "address": "string" ~/~/Адрес АЗС
4217 +
4218 + }
4219 +
4220 +
4221 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4222 +
4223 +
4224 +== **Получение полных данных о ретрансляторе** ==
4225 +
4226 +(% class="box infomessage" %)
4227 +(((
4228 +**GET ** **/api/v3/retranslations/{id}**
4229 +)))
4230 +
4231 +Идентификатор запроса: ID
4232 +
4233 +
4234 +Пример ответа:
4235 +
4236 +{ 
4237 +
4238 +"description": "", ~/~/ Определяет описание
4239 +
4240 +"subscriberId": "", ~/~/ Подписчик
4241 +
4242 +"protocolType": 0, ~/~/ Тип протокола
4243 +
4244 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4245 +
4246 +"address": "string", ~/~/ Адрес события
4247 +
4248 +"objects": [ ~/~/Объекты для ретрансляции
4249 +
4250 +{     
4251 +
4252 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4253 +
4254 +"name": "", ~/~/ Наименование объекта ретрансляции
4255 +
4256 +"imei": "", ~/~/ IMEI объекта 
4257 +
4258 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4259 +
4260 +}
4261 +
4262 + ], 
4263 +
4264 +"id": "", ~/~/ идентификатор пользователя  
4265 +
4266 +"parentId": "", ~/~/Guid родителя
4267 +
4268 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4269 +
4270 +}
4271 +
4272 +
4273 +== **Удаление данных ретранслятора** ==
4274 +
4275 +(% class="box infomessage" %)
4276 +(((
4277 +**DELETE** **/api/v3/retranslations/{id}**
4278 +)))
4279 +
4280 +Параметр запроса: ID
4281 +
4282 +
4283 +== **Создание ретранслятора** ==
4284 +
4285 +(% class="box infomessage" %)
4286 +(((
4287 +**POST ** **/api/v3/retranslations/{id}**
4288 +)))
4289 +
4290 +Запрос:
4291 +
4292 +
4293 +{ 
4294 +
4295 +"description": "", ~/~/ Описание
4296 +
4297 +"subscriberId": "", ~/~/ Подписчик
4298 +
4299 +"protocolType": 0, ~/~/ Тип протокола
4300 +
4301 +"address": "", ~/~/ Адрес ретрансляции
4302 +
4303 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4304 +
4305 +"objects": [ ~/~/Объекты для ретрансляции
4306 +
4307 +{     
4308 +
4309 +"id": "", ~/~/ идентификатор пользователя    
4310 +
4311 +"imei": "", ~/~/IMEI объекта
4312 +
4313 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен 
4314 +
4315 +}
4316 +
4317 + ]
4318 +
4319 +}
4320 +
4321 +
4322 +
4323 +Ответ
4324 +
4325 +{ 
4326 +
4327 +"description": "string", ~/~/ Определяет описание
4328 +
4329 +"subscriberId": "", ~/~/ идентификатор запроса
4330 +
4331 +"protocolType": 0, ~/~/ Тип протокола
4332 +
4333 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4334 +
4335 +"address": "", ~/~/ Адрес события
4336 +
4337 +"objects": [ ~/~/Объекты для ретрансляции
4338 +
4339 +{     
4340 +
4341 +"id": "", ~/~/ идентификатор пользователя   
4342 +
4343 +"name": "string", ~/~/ Название уведомления
4344 +
4345 +"imei": "string", ~/~/IMEI объекта 
4346 +
4347 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 
4348 +
4349 +}
4350 +
4351 + ], 
4352 +
4353 +"id": "", ~/~/ идентификатор пользователя 
4354 +
4355 +"parentId": "", ~/~/ Guid идентификатор родителя
4356 +
4357 +"deleted": true ~/~/ Признак удаления
4358 +
4359 +}
4360 +
4361 +
4362 +== **Редактирование ретранслятора** ==
4363 +
4364 +(% class="box infomessage" %)
4365 +(((
4366 +**PUT** **/api/v3/retranslations**
4367 +)))
4368 +
4369 +Пример запроса:
4370 +
4371 +{ 
4372 +
4373 +"id": "", ~/~/ идентификатор пользователя  
4374 +
4375 +"description": "string", ~/~/ Определяет описание
4376 +
4377 +"subscriberId": "", ~/~/ идентификатор запроса
4378 +
4379 +"protocolType": 0, ~/~/ Тип протокола
4380 +
4381 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 
4382 +
4383 +"address": "string", ~/~/ Адрес события
4384 +
4385 +"objects": ~/~/Объекты для ретрансляции
4386 +
4387 +[   
4388 +
4389 +{     
4390 +
4391 +"id": "",  ~/~/ идентификатор пользователя        
4392 +
4393 +"imei": "", ~/~/IMEI объекта
4394 +
4395 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 
4396 +
4397 +}
4398 +
4399 + ]
4400 +
4401 +}
4402 +
4403 +
4404 +Пример ответа:
4405 +
4406 +{ 
4407 +
4408 +"description": "", ~/~/ Определяет описание
4409 +
4410 +"subscriberId": "", ~/~/ идентификатор запроса
4411 +
4412 +"protocolType": 0, ~/~/ Тип протокола
4413 +
4414 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 
4415 +
4416 +"address": "string", ~/~/ Адрес события
4417 +
4418 +"objects": [ ~/~/Объекты для ретрансляции
4419 +
4420 +{     
4421 +
4422 +"id": "", ~/~/ идентификатор пользователя    
4423 +
4424 +"name": "string", ~/~/ Название уведомления   
4425 +
4426 +"imei": "", ~/~/IMEI объекта
4427 +
4428 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 
4429 +
4430 +}
4431 +
4432 + ],
4433 +
4434 +"id": "", ~/~/ идентификатор пользователя  
4435 +
4436 +"parentId": "", ~/~/ Guid идентификатор родителя
4437 +
4438 +"deleted": true ~/~/ Признак удаления
4439 +
4440 +}
4441 +
4442 +
4443 +
4444 +== **Получение списка ретранслятора клиента** ==
4445 +
4446 +(% class="box infomessage" %)
4447 +(((
4448 +**POST /api/v3/retranslations/find**
4449 +)))
4450 +
4451 +Пример запроса:
4452 +
4453 +
4454 +{ 
4455 +
4456 +"id": "", ~/~/ идентификатор пользователя  
4457 +
4458 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4459 +
4460 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4461 +
4462 +}
4463 +
4464 +
4465 +
4466 +Ответ
4467 +
4468 +
4469 +[ 
4470 +
4471 +{   
4472 +
4473 +"description": "", ~/~/ Определяет описание
4474 +
4475 +"subscriberId": "", ~/~/ идентификатор запроса
4476 +
4477 +"protocolType": 0, ~/~/ Тип протокола
4478 +
4479 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 
4480 +
4481 +"address": "string", ~/~/ Адрес события
4482 +
4483 +"id": "", ~/~/ идентификатор пользователя  
4484 +
4485 +"parentId": "", ~/~/ Guid идентификатор родителя
4486 +
4487 +"deleted": true ~/~/ Признак удаления
4488 +
4489 +}
4490 +
4491 +]
4492 +
4493 +
4494 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
4495 +
4496 +
4497 +== **API для отчета по выгрузке комбайнов** ==
4498 +
4499 +
4500 +(% class="box infomessage" %)
4501 +(((
4502 +POST **/api/v3/Reports/harvesterUnloading**
4503 +)))
4504 +
4505 +Пример запроса:
4506 +
4507 +
4508 +{
4509 +
4510 + "byTime": 0, ~/~/ Объединение событий по времени
4511 +
4512 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4513 +
4514 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4515 +
4516 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4517 +
4518 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4519 +
4520 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4521 +
4522 + 0
4523 +
4524 + ],
4525 +
4526 + "from": "", ~/~/ Дата и время начало запроса
4527 +
4528 + "to": "", ~/~/ Дата и время окончания запроса
4529 +
4530 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4531 +
4532 +}
4533 +
4534 +
4535 +
4536 +Пример ответа:
4537 +
4538 +
4539 +[
4540 +
4541 + {
4542 +
4543 + "harvesterName": "", ~/~/Комбайн, номер
4544 +
4545 + "harvesterId": 0, ~/~/Комбайн, id
4546 +
4547 +"harvesterModel": "", ~/~/ Модель комбайна
4548 +
4549 + "hopperCapacity": 0, ~/~/ Объем бункера м3
4550 +
4551 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4552 +
4553 + "events": [ ~/~/Список событий в разрезе комбайна
4554 +
4555 + {
4556 +
4557 + "driverId": "", ~/~/Идентификатор водителя
4558 +
4559 + "driverName": "", ~/~/Водитель комбайна, ФИО
4560 +
4561 + "RFID": "", ~/~/ идентификатор карты-метки
4562 +
4563 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4564 +
4565 + "vehicleId": 0, ~/~/идентификатор объекта
4566 +
4567 + "vehicleName": "string", ~/~/ Имя объекта
4568 +
4569 + "modelName": "string", ~/~/ Имя модели объекта
4570 +
4571 + "nearestVehicles": [ ~/~/Объекты рядом
4572 +
4573 + {
4574 +
4575 + "vehicleId": 0, ~/~/идентификатор объекта
4576 +
4577 + "vehicleName": "string" ~/~/ Имя объекта
4578 +
4579 + }
4580 +
4581 + ],
4582 +
4583 + "fields": [ ~/~/Поля, где происходила выгрузка
4584 +
4585 + {
4586 +
4587 + "id": 0, ~/~/ идентификатор пользователя
4588 +
4589 + "name": "string" ~/~/ имя пользователя
4590 +
4591 + }
4592 +
4593 + ],
4594 +
4595 + "event": "string", ~/~/Событие
4596 +
4597 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4598 +
4599 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4600 +
4601 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4602 +
4603 + "cultureName": "string", ~/~/ название культуры
4604 +
4605 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4606 +
4607 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4608 +
4609 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4610 +
4611 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4612 +
4613 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4614 +
4615 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4616 +
4617 + "issued": 0, ~/~/Выдано, бункеров
4618 +
4619 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4620 +
4621 + "latitude": 0, ~/~/Широта
4622 +
4623 + "longitude": 0, ~/~/ Долгота
4624 +
4625 + "litresAway": 0, ~/~/Отдано, л
4626 +
4627 + "m3Away": 0 ~/~/Отдано, м3
4628 +
4629 + }
4630 +
4631 + ]
4632 +
4633 + }
4634 +
4635 +]
4636 +
4637 +
4638 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4639 +
4640 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4641 +
4642 +
4643 +(% class="box infomessage" %)
4644 +(((
4645 +GET api/v3/Vehicles/recyclebin/all
4646 +)))
4647 +
4648 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4649 +
4650 +Параметр запроса: {parentId} - идентификатор агента
4651 +
4652 +В заголовках запроса: X-Auth: Токен авторизации
4653 +
4654 +Ответ:
4655 +
4656 +[
4657 +
4658 + {
4659 +
4660 + "recordTime": "", ~/~/Время записи
4661 +
4662 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4663 +
4664 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4665 +
4666 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4667 +
4668 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4669 +
4670 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4671 +
4672 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4673 +
4674 + "items": [ ~/~/ [
4675 +
4676 +nullable: true ~/~/Детали
4677 +
4678 + {
4679 +
4680 + "name": "string", ~/~/наименование столбца
4681 +
4682 + "value": "string" ~/~/содержание столбца
4683 +
4684 + }
4685 +
4686 + ]
4687 +
4688 + },
4689 +
4690 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4691 +
4692 + "string"
4693 +
4694 + ]
4695 +
4696 + }
4697 +
4698 +]
4699 +
4700 +
4701 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4702 +
4703 +(% class="box infomessage" %)
4704 +(((
4705 +POST/api/v3/Vehicles/recyclebin/erase
4706 +)))
4707 +
4708 +В заголовках запроса: X-Auth: Токен авторизации
4709 +
4710 +Пример запроса:
4711 +
4712 +
4713 +[
4714 +
4715 + 0
4716 +
4717 +]
4718 +
4719 +
4720 +Пример ответа:
4721 +
4722 +[
4723 +
4724 + {
4725 +
4726 + "recordTime": "", ~/~/Время записи
4727 +
4728 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4729 +
4730 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4731 +
4732 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4733 +
4734 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4735 +
4736 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4737 +
4738 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4739 +
4740 + "items": [ ~/~/Детали
4741 +
4742 + {
4743 +
4744 + "name": "", ~/~/Имя свойства
4745 +
4746 + "value": "" ~/~/Значение свойства
4747 +
4748 + }
4749 +
4750 + ]
4751 +
4752 + },
4753 +
4754 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4755 +
4756 + ""
4757 +
4758 + ]
4759 +
4760 + }
4761 +
4762 +]
4763 +
4764 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4765 +
4766 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4767 +
4768 +(% class="box infomessage" %)
4769 +(((
4770 +POST/api/v3/Vehicles/recyclebin/restore
4771 +)))
4772 +
4773 +В заголовках запроса: X-Auth: Токен авторизации
4774 +
4775 +Параметры в теле запроса (JSON):
4776 +
4777 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4778 +
4779 +В заголовках запроса: X-Auth: Токен авторизации
4780 +
4781 +
4782 +Пример запроса:
4783 +
4784 +[
4785 +
4786 + 0
4787 +
4788 +]
4789 +
4790 +
4791 +Пример ответа:
4792 +
4793 +[
4794 +
4795 + {
4796 +
4797 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4798 +
4799 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4800 +
4801 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4802 +
4803 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4804 +
4805 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4806 +
4807 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4808 +
4809 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4810 +
4811 + "items": [ ~/~/Детали
4812 +
4813 + {
4814 +
4815 + "name": "string", ~/~/Имя свойства
4816 +
4817 + "value": "string" ~/~/Значение свойства
4818 +
4819 + }
4820 +
4821 + ]
4822 +
4823 + },
4824 +
4825 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4826 +
4827 + "string"
4828 +
4829 + ]
4830 +
4831 + }
4832 +
4833 +]
4834 +
4835 +
4836 +
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 г.