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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,12 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -98,51 +98,30 @@
98 98  Запрос должен содержать данные параметра "**agentId**"
99 99  
100 100  (% style="color:#000000" %)Ответ:
96 +А
101 101  {
102 - "agentId": "",  (%%)
103 - "parentId": "",
104 - "parentName": "string",
105 - "name": "string",
106 - "fullName": "string",
107 - "agentInfoType": 0,
108 - "isForeign": true/false,
109 - "district": "string", 
110 - "region": "string",
111 - "city": "string",
112 - "inn": "string",
113 - "kpp": "string",
114 - "address": "string",
115 - "addressFact": "string",
116 - "email": "string",
117 - "director": "string",
118 - "bankName": "string",
119 - "bankBIK": "string",
120 - "bankRS": "string",
121 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
122 122   }
123 123  
124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 -
146 146  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 147  
148 148  (% class="box infomessage" %)
... ... @@ -156,7 +156,7 @@
156 156  
157 157  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158 158  
159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **POST**
162 162  
... ... @@ -171,23 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "name": "string",
177 - "fullName": "string",
178 - "agentInfoType": 0,
179 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
180 180  }
181 181  
182 -
183 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 -
191 191  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
192 192  
193 193  (% class="box successmessage" %)
... ... @@ -206,7 +206,7 @@
206 206  Параметры в теле запроса (JSON):
207 207  
208 208  {
209 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
210 210   "name": "string", ~/~/ имя
211 211   "fullName": "string", ~/~/ полное наименование
212 212   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -251,28 +251,6 @@
251 251   "bankKS": "string" ~/~/ корр. счёт
252 252  }
253 253  
254 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275 -
276 276  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
277 277  
278 278  (% class="box warningmessage" %)
... ... @@ -288,6 +288,7 @@
288 288  
289 289  В заголовках запроса: X-Auth: Токен авторизации
290 290  
235 +
291 291  Параметры в теле запроса (JSON):
292 292  
293 293  {
... ... @@ -312,6 +312,7 @@
312 312   "bankKS": "string" ~/~/ корр. счёт
313 313  }
314 314  
260 +
315 315  Ответ:
316 316  
317 317  {
... ... @@ -354,21 +354,6 @@
354 354  
355 355  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
356 356  
357 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358 -
359 -(% class="box warningmessage" %)
360 -(((
361 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 -)))
363 -
364 -Метод позволяет изменить статус клиента, указанного в запросе.
365 -
366 -В пути указывается GUID клиента и статус клиента.
367 -
368 -**status **- значение 0 - заблокирован, 1 - активен.
369 -
370 -Ответ: Code 204
371 -
372 372  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
373 373  
374 374  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -432,6 +432,7 @@
432 432   "password": "string",
433 433   "email": "string",
434 434  
366 +
435 435  (% style="text-align:left" %)
436 436  (% style="color:#000000; font-weight:normal" %)Ответ:
437 437  
... ... @@ -460,7 +460,6 @@
460 460  (% style="text-align:left" %)
461 461  (% style="color:#000000; font-weight:normal" %)}
462 462  
463 -
464 464  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 465  
466 466  (% class="box infomessage" %)
... ... @@ -751,249 +751,6 @@
751 751  (% style="text-align:left" %)
752 752  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
753 753  
754 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
755 -
756 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
757 -
758 -(% class="box infomessage" %)
759 -(((
760 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
761 -)))
762 -
763 -Метод возвращает полную информацию о модели объекта.
764 -
765 -(% style="color:#000000" %)Метод запроса: **GET**
766 -
767 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
768 -
769 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
770 -
771 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
772 -
773 -(% style="color:#000000" %)Ответ:
774 -
775 -(% style="color:#000000" %){
776 - "parentName": "string",
777 - "name": "string",
778 - "picture": "string",
779 - "minspeed": 0,
780 - "maxspeed": 0,
781 - "width": 0,
782 - "imbeddedtrailer": true,
783 - "hoppercapacity": 0,
784 - "hopperdischargespeed": 0,
785 - "modelType": 0,
786 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
787 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788 - "deleted": true
789 -}
790 -
791 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
792 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
793 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
794 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
795 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
796 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
799 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
801 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
804 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
805 -
806 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
807 -
808 -(% class="box successmessage" %)
809 -(((
810 -(% lang="en-US" %)**POST /api/v3/models/find**
811 -)))
812 -
813 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
814 -
815 -(% style="color:#000000" %)Метод запроса: **POST**
816 -
817 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
818 -
819 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
820 -
821 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
822 -
823 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
824 -}
825 -
826 -(% style="color:#000000" %)Ответ:
827 -
828 -(% style="color:#000000" %)[
829 - {
830 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 - "parentName": "string",
833 - "name": "string",
834 - "modelType": 0
835 - }
836 -]
837 -
838 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
839 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
840 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
841 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
842 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
843 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
844 -
845 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
846 -
847 -(% class="box successmessage" %)
848 -(((
849 -(% lang="en-US" %)**POST /api/v3/models**
850 -)))
851 -
852 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
853 -
854 -(% style="color:#000000" %)Метод запроса: **POST**
855 -
856 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
857 -
858 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
859 -
860 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
861 -
862 -{
863 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 - "deleted": true,
866 - "extId": "string",
867 - "name": "string",
868 - "picture": "string",
869 - "minspeed": 0,
870 - "maxspeed": 0,
871 - "width": 0,
872 - "imbeddedtrailer": true,
873 - "fueloutlay": 0,
874 - "hoppercapacity": 0,
875 - "hopperdischargespeed": 0,
876 - "modelType": 0
877 -}
878 -
879 -Ответ:
880 -
881 -{
882 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
883 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
884 - "deleted": true,
885 - "extId": "string",
886 - "name": "string",
887 - "picture": "string",
888 - "minspeed": 0,
889 - "maxspeed": 0,
890 - "width": 0,
891 - "imbeddedtrailer": true,
892 - "hoppercapacity": 0,
893 - "hopperdischargespeed": 0,
894 - "modelType": 0
895 -}
896 -
897 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 -
911 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 -
913 -(% class="box warningmessage" %)
914 -(((
915 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
916 -)))
917 -
918 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
919 -
920 -(% style="color:#000000" %)Метод запроса: **PUT**
921 -
922 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
923 -
924 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
925 -
926 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
927 -
928 -{
929 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
930 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 - "deleted": true,
932 - "extId": "string",
933 - "name": "string",
934 - "picture": "string",
935 - "minspeed": 0,
936 - "maxspeed": 0,
937 - "width": 0,
938 - "imbeddedtrailer": true,
939 - "fueloutlay": 0,
940 - "hoppercapacity": 0,
941 - "hopperdischargespeed": 0,
942 - "modelType": 0
943 -}
944 -
945 -Ответ:
946 -
947 -{
948 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
950 - "deleted": true,
951 - "extId": "string",
952 - "name": "string",
953 - "picture": "string",
954 - "minspeed": 0,
955 - "maxspeed": 0,
956 - "width": 0,
957 - "imbeddedtrailer": true,
958 - "fueloutlay": 0,
959 - "hoppercapacity": 0,
960 - "hopperdischargespeed": 0,
961 - "modelType": 0
962 -}
963 -
964 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 -
978 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 -
980 -(% class="box errormessage" %)
981 -(((
982 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
983 -)))
984 -
985 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
986 -
987 -(% style="color:#000000" %)Метод запроса: **DELETE**
988 -
989 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
990 -
991 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
992 -
993 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
994 -
995 -Ответ: В случае успеха **Success 200**
996 -
997 997  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
998 998  
999 999  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1802,7 +1802,7 @@
1802 1802  
1803 1803  (% style="color:#000000" %)Метод запроса: **GET**
1804 1804  
1805 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
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]]
1806 1806  
1807 1807  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1808 1808  
... ... @@ -1816,411 +1816,7 @@
1816 1816  (% style="text-align:left" %)
1817 1817  (% style="color:#000000" %)}
1818 1818  
1819 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1820 1820  
1821 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1822 -
1823 -(% class="box infomessage" %)
1824 -(((
1825 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1826 -)))
1827 -
1828 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1829 -
1830 -(% style="color:#000000" %)Метод запроса: **GET**
1831 -
1832 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1833 -
1834 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1835 -
1836 -(% style="color:#000000" %)Ответ:
1837 -
1838 -(% style="color:#000000" %){
1839 -
1840 - "id": "", ~/~/ ID типа датчика 
1841 - "name": "", ~/~/ Название
1842 - "description": "", ~/~/ Описание
1843 -
1844 -(% style="text-align:left" %)
1845 -(% style="color:#000000" %)}
1846 -
1847 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1848 -
1849 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1850 -
1851 -(% class="box infomessage" style="text-align: left;" %)
1852 -(((
1853 -**POST /api/v3/terminalMessages/count**
1854 -)))
1855 -
1856 -(% style="text-align: left;" %)
1857 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1858 -
1859 -(% style="text-align: left;" %)
1860 -Метод запроса **POST**
1861 -
1862 -(% style="text-align: left;" %)
1863 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1864 -
1865 -(% style="text-align: left;" %)
1866 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1867 -
1868 -(% style="text-align: left;" %)
1869 -{
1870 - "vehicleIds": [
1871 - id ~/~/ здесь передается список идентификаторов объектов
1872 - ],
1873 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1874 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1875 -}
1876 -
1877 -(% style="text-align: left;" %)
1878 -Ответ:
1879 -
1880 -(% style="text-align: left;" %)
1881 -[
1882 - {
1883 - "vehicleId": 0, ~/~/ идентификатор объекта
1884 - "count": 0 ~/~/ количество сообщений за период
1885 - }
1886 -]
1887 -
1888 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 -
1890 -(% class="box infomessage" style="text-align: left;" %)
1891 -(((
1892 -**POST /api/v3/terminalMessages/mapping**
1893 -)))
1894 -
1895 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 -
1897 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 -
1899 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 -
1901 -{
1902 - "protocolType": 0,
1903 - "params": ["string"]
1904 -}
1905 -
1906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 -|protocolType|ID типа протокола
1908 -|params|(((
1909 -Массив наименований параметров в сообщении
1910 -)))
1911 -
1912 -Ответ:
1913 -
1914 -{
1915 - "protocolType": 0,
1916 - "mapping": {
1917 - "additionalProp1": {
1918 - "inputType": 0,
1919 - "inputNumber": 0
1920 - },
1921 - "additionalProp2": {
1922 - "inputType": 0,
1923 - "inputNumber": 0
1924 - }
1925 - }
1926 -}
1927 -
1928 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 -|protocolType|Тип протокола
1930 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 -|inputNumber|Номер входа
1932 -
1933 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934 -
1935 -(% class="box infomessage" %)
1936 -(((
1937 -**POST /api/v3/terminalMessages**
1938 -)))
1939 -
1940 -Метод возвращает список сообщений терминала объекта за выбранный период.
1941 -
1942 -(% style="text-align: left;" %)
1943 -Метод запроса **POST**
1944 -
1945 -(% style="text-align: left;" %)
1946 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1947 -
1948 -(% style="text-align: left;" %)
1949 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1950 -
1951 -{
1952 - "vehicleId": 0, ~/~/ id объекта
1953 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1954 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 -}
1956 -
1957 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 -|vehicleId|ID объекта
1959 -|from|Дата и время начала периода запроса
1960 -|to|Дата и время окончания периода запроса
1961 -
1962 -Ответ:
1963 -
1964 -[
1965 - {
1966 - "messages": [
1967 - {
1968 - "deviceTime": "2023-11-29T07:40:44.052Z",
1969 - "serverTime": "2023-11-29T07:40:44.052Z",
1970 - "speed": 0,
1971 - "altitude": 0,
1972 - "latitude": 0,
1973 - "longitude": 0,
1974 - "satellites": 0,
1975 - "course": 0,
1976 - "voltage": 0,
1977 - "parameters": {
1978 - "additionalProp1": "string",
1979 - "additionalProp2": "string",
1980 - "additionalProp3": "string"
1981 - },
1982 - "photoCount": 0,
1983 - "lbsCorrectedCoords": true,
1984 - "protocolType": 0
1985 - }
1986 - ]
1987 - }
1988 -]
1989 -
1990 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 -|deviceTime|Время сообщения терминала
1992 -|serverTime|Время когда сообщение поступило на сервер
1993 -|speed|Скорость
1994 -|altitude|Высота над уровнем моря
1995 -|latitude|Широта
1996 -|longitude|Долгота
1997 -|satellites|Кол-во спутников
1998 -|course|Курс
1999 -|voltage|Бортовое напряжение
2000 -|parameters|Список параметров и их значений
2001 -|photoCount|Количество фото
2002 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 -|protocolType|ID типа протокола
2004 -
2005 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 -
2007 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2008 -
2009 -(% class="box infomessage" %)
2010 -(((
2011 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2012 -)))
2013 -
2014 -(% style="color:#000000" %)Метод запроса: **POST**
2015 -
2016 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2017 -
2018 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2019 -
2020 -(% style="text-align:left" %)
2021 -Тело запроса:
2022 -
2023 -{
2024 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2025 - "vehicleIds": [0], ~/~/ Список ID объектов
2026 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2027 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2028 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2029 -}
2030 -
2031 -Ответ:
2032 -
2033 -[
2034 - {
2035 - "vehicleId": 0, ~/~/ ID объекта
2036 - "name": "string", ~/~/ Имя ТС
2037 - "periods": [ ~/~/ Периоды
2038 - {
2039 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2040 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2041 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2042 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2043 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2044 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2045 - }
2046 - ]
2047 - }
2048 -]
2049 -
2050 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2051 -
2052 -(% class="box infomessage" %)
2053 -(((
2054 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2055 -)))
2056 -
2057 -(% style="color:#000000" %)Метод запроса: **POST**
2058 -
2059 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2060 -
2061 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2062 -
2063 -(% style="text-align:left" %)
2064 -Тело запроса:
2065 -
2066 -{
2067 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2068 - "vehicleIds": [0], ~/~/ Список ID объектов
2069 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2070 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2071 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2072 -}
2073 -
2074 -Ответ:
2075 -
2076 -[
2077 - {
2078 - "vehicleId": 0, ~/~/ ID объекта
2079 - "name": "string", ~/~/ Имя ТС
2080 - "periods": [ ~/~/ Периоды
2081 - {
2082 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2083 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2084 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2085 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2086 - "fuelConsumption": 0, ~/~/ Расход топлива
2087 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2088 - }
2089 - ]
2090 - }
2091 -]
2092 -
2093 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2094 -
2095 -(% class="box infomessage" %)
2096 -(((
2097 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 -)))
2099 -
2100 -(% style="color:#000000" %)Метод запроса: **POST**
2101 -
2102 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2103 -
2104 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2105 -
2106 -(% style="text-align:left" %)
2107 -Тело запроса:
2108 -
2109 -{
2110 - "vehicleIds": [0], ~/~/ Список ID объектов
2111 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 -}
2115 -
2116 -Ответ:
2117 -
2118 -[
2119 - {
2120 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 - "vehicleId": 0, ~/~/ ID объекта
2123 - "name": "string", ~/~/ Имя объекта
2124 - "model": "string", ~/~/ Модель объекта
2125 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 - {
2127 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 - "valueFuel": 0, ~/~/ Количество
2131 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 - }
2134 - ]
2135 - }
2136 -]
2137 -
2138 -
2139 -(% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**
2140 -
2141 -
2142 -(% class="box infomessage" %)
2143 -(((
2144 -**POST/api/v3/vehicles/moveStop**
2145 -)))
2146 -
2147 -Метод запроса: **POST**
2148 -
2149 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/moveStop]]
2150 -
2151 -В заголовках запроса: X-Auth: Токен авторизации
2152 -
2153 -
2154 -Тело запроса:
2155 -
2156 -{
2157 -
2158 - "vehicleIds": [ ], ~/~/ Список ID объектов
2159 -
2160 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2161 -
2162 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2163 -
2164 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2165 -
2166 -}
2167 -
2168 -
2169 -Ответ:
2170 -
2171 -[
2172 -
2173 - {
2174 -
2175 - "vehicleId": 0, ~/~/ ID объекта
2176 -
2177 - "vehicleName": "string", ~/~/ Имя объекта
2178 -
2179 - "moves": [ ~/~/ Событие движения
2180 -
2181 - {
2182 -
2183 - "mileage": 0, ~/~/ Пробег, км
2184 -
2185 - "eventId": 0, ~/~/ Идентификатор события
2186 -
2187 - "eventName": "string", ~/~/ Название события
2188 -
2189 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2190 -
2191 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2192 -
2193 - "duration": 0 ~/~/ Продолжительность события, секунд
2194 -
2195 - }
2196 -
2197 - ],
2198 -
2199 - "stops": [ ~/~/ События стоянок
2200 -
2201 - {
2202 -
2203 - "address": "string", ~/~/ Адрес события
2204 -
2205 - "eventId": 0, ~/~/ Идентификатор события
2206 -
2207 - "eventName": "string", ~/~/ Название события
2208 -
2209 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2210 -
2211 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2212 -
2213 - "duration": 0 ~/~/ Продолжительность события, секунд
2214 -
2215 -
2216 - }
2217 -
2218 - ]
2219 -
2220 - }
2221 -
2222 -]
2223 -
2224 2224  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2225 2225  
2226 2226  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2234,7 +2234,7 @@
2234 2234  
2235 2235  (% style="color:#000000" %)Метод запроса: **POST**
2236 2236  
2237 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
1521 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
2238 2238  
2239 2239  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2240 2240  
... ... @@ -2349,6 +2349,124 @@
2349 2349   }
2350 2350  ]
2351 2351  
1636 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1637 +
1638 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1639 +
1640 +(% class="box infomessage" %)
1641 +(((
1642 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1643 +)))
1644 +
1645 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1646 +
1647 +(% style="color:#000000" %)Метод запроса: **GET**
1648 +
1649 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1650 +
1651 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1652 +
1653 +(% style="color:#000000" %)Ответ:
1654 +
1655 +(% style="color:#000000" %){
1656 +
1657 + "id": "", ~/~/ ID типа датчика 
1658 + "name": "", ~/~/ Название
1659 + "description": "", ~/~/ Описание
1660 +
1661 +(% style="text-align:left" %)
1662 +(% style="color:#000000" %)}
1663 +
1664 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1665 +
1666 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1667 +
1668 +(% class="box infomessage" style="text-align: left;" %)
1669 +(((
1670 +**POST /api/v3/terminalMessages/count**
1671 +)))
1672 +
1673 +(% style="text-align: left;" %)
1674 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1675 +
1676 +(% style="text-align: left;" %)
1677 +Метод запроса **POST**
1678 +
1679 +(% style="text-align: left;" %)
1680 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1681 +
1682 +(% style="text-align: left;" %)
1683 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1684 +
1685 +(% style="text-align: left;" %)
1686 +{
1687 + "vehicleIds": [
1688 + id ~/~/ здесь передается список идентификаторов объектов
1689 + ],
1690 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1691 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1692 +}
1693 +
1694 +(% style="text-align: left;" %)
1695 +Ответ:
1696 +
1697 +(% style="text-align: left;" %)
1698 +[
1699 + {
1700 + "vehicleId": 0, ~/~/ идентификатор объекта
1701 + "count": 0 ~/~/ количество сообщений за период
1702 + }
1703 +]
1704 +
1705 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1706 +
1707 +(% class="box infomessage" %)
1708 +(((
1709 +**POST /api/v3/terminalMessages**
1710 +)))
1711 +
1712 +Метод возвращает список сообщений терминала объекта за выбранный период.
1713 +
1714 +(% style="text-align: left;" %)
1715 +Метод запроса **POST**
1716 +
1717 +(% style="text-align: left;" %)
1718 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1719 +
1720 +(% style="text-align: left;" %)
1721 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1722 +
1723 +{
1724 + "vehicleId": 0, ~/~/ id объекта
1725 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1726 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1727 +}
1728 +
1729 +Ответ:
1730 +
1731 +[
1732 + {
1733 + "messages": [
1734 + {
1735 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1736 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1737 + "speed": 0, ~/~/ Скорость, км/ч
1738 + "altitude": 0, ~/~/ Высота, м
1739 + "latitude": 0, ~/~/ Широта [-90°;90°]
1740 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1741 + "satellites": 0, ~/~/ Кол-во спутников
1742 + "voltage": 0, ~/~/ Напряжение
1743 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1744 + "additionalProp1": "string",
1745 + "additionalProp2": "string",
1746 + "additionalProp3": "string"
1747 + },
1748 + "photoCount": 0 ~/~/ Кол-во фото
1749 + }
1750 + ]
1751 + }
1752 +]
1753 +
2352 2352  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2353 2353  
2354 2354  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -3119,83 +3119,6 @@
3119 3119  Success
3120 3120  
3121 3121  
3122 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3123 -
3124 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3125 -
3126 -(% class="box infomessage" %)
3127 -(((
3128 -**POST /api/v3/Trailers**
3129 -)))
3130 -
3131 -Пример запроса:
3132 -
3133 -{
3134 - "startDate": "2023-11-14T10:48:03.671Z",
3135 - "endDate": "2023-11-14T10:48:03.671Z",
3136 - "ids": [ 0 ],
3137 - "timezone": 0
3138 -}
3139 -
3140 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3141 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3142 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3143 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3144 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3145 -
3146 -Пример ответа:
3147 -
3148 -[
3149 - {
3150 - "SD": "2023-11-14T10:48:03.717Z",
3151 - "ED": "2023-11-14T10:48:03.717Z", 
3152 - "id": 0,
3153 - "SLat": 0,
3154 - "SLon": 0,
3155 - "ELat": 0,
3156 - "ELon": 0,
3157 - "mileage": 0
3158 - "Duration": 0
3159 - "Address": "string",
3160 - "Address2": "string",
3161 - "name": "string",
3162 - "rid": "string",
3163 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3164 - "trailer": {
3165 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3166 - "Number": "string",
3167 - "Description": "string",
3168 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3169 - "ExternalID": "string",
3170 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3171 - "CreateTime": "2023-11-14T10:48:03.717Z",
3172 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3173 - "IsDeleted": true
3174 - },
3175 - "filesCount": 0,
3176 - }
3177 -]
3178 -
3179 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3180 -|SD|Дата и время начала события
3181 -|ED|Дата и время окончания события
3182 -|id|ID объекта
3183 -|SLat|Широта начальной координаты
3184 -|SLon|Долгота начальной координаты
3185 -|ELat|Широта конечной координаты
3186 -|ELon|Долгота конечной координаты
3187 -|mileage|Пробег
3188 -|Duration|Продолжительность
3189 -|Address|Адрес начального местоположения
3190 -|Address2|Адрес конечного местоположения
3191 -|name|Имя радиометки
3192 -|rid|Номер радиометки
3193 -|rguid|ID радиометки
3194 -|trailer|Информация об агрегате
3195 -|ModelGuid|ID агрегата
3196 -|Number|Название/номер агрегата
3197 -|Description|Текст примечания агрегата
3198 -
3199 3199  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3200 3200  
3201 3201  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3217,18 +3217,13 @@
3217 3217   {
3218 3218   "name": "string",
3219 3219   "number": 0,
3220 - "period": 0,
2545 + "period": 0, ~/~/ Частота трансляции радиометки
3221 3221   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3222 3222   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2548 + "deleted": true
3223 3223   }
3224 3224  ]
3225 3225  
3226 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3227 -|parentId|ID клиента
3228 -|name|Название карты-метки
3229 -|number|Номер
3230 -|period|Период запросов в секундах (работает только для агрегатов)
3231 -|id|ID карты-метки
3232 3232  
3233 3233  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3234 3234  
... ... @@ -3245,18 +3245,13 @@
3245 3245   {
3246 3246   "name": "string",
3247 3247   "number": 0,
3248 - "period": 0,
2568 + "period": 0, ~/~/ Частота трансляции радиометки
3249 3249   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3250 3250   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2571 + "deleted": true
3251 3251   }
3252 3252  ]
3253 3253  
3254 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3255 -|name|Название карты-метки
3256 -|number|Номер
3257 -|period|Период запросов в секундах (работает только для агрегатов)
3258 -|id|ID карты-метки
3259 -|parentId|ID клиента
3260 3260  
3261 3261  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3262 3262  
... ... @@ -3272,6 +3272,7 @@
3272 3272   "number": 0,
3273 3273   "period": 0,
3274 3274   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2590 + "deleted": true
3275 3275  }
3276 3276  
3277 3277  Ответ:
... ... @@ -3282,14 +3282,9 @@
3282 3282   "period": 0,
3283 3283   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3284 3284   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2601 + "deleted": true
3285 3285  }
3286 3286  
3287 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3288 -|name|Название карты-метки
3289 -|number|Номер
3290 -|period|Период запросов в секундах (работает только для агрегатов)
3291 -|id|ID карты-метки
3292 -|parentId|ID клиента
3293 3293  
3294 3294  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3295 3295  
... ... @@ -3306,6 +3306,7 @@
3306 3306   "period": 0,
3307 3307   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3308 3308   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2620 + "deleted": true
3309 3309  }
3310 3310  
3311 3311  Ответ:
... ... @@ -3316,14 +3316,9 @@
3316 3316   "period": 0,
3317 3317   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3318 3318   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2631 + "deleted": true
3319 3319  }
3320 3320  
3321 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3322 -|name|Название карты-метки
3323 -|number|Номер
3324 -|period|Период запросов в секундах (работает только для агрегатов)
3325 -|id|ID карты-метки
3326 -|parentId|ID клиента
3327 3327  
3328 3328  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3329 3329  
... ... @@ -3332,7 +3332,7 @@
3332 3332  **DELETE /api/v3/Rfids/{rfidGuid}**
3333 3333  )))
3334 3334  
3335 -Передаем параметр **rfidGuid** - идентификатор карты-метки
2642 +Передаем параметр rfidGuid - идентификатор карты-метки
3336 3336  
3337 3337  Ответ:
3338 3338  
... ... @@ -3339,670 +3339,6 @@
3339 3339  Success
3340 3340  
3341 3341  
3342 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3343 -
3344 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3345 -
3346 -(% class="box infomessage" %)
3347 -(((
3348 -**GET /api/v3/Billing/client/balance/{clientId}**
3349 -)))
3350 -
3351 -Параметр запроса: **clientId **- идентификатор клиента.
3352 -
3353 -Ответ:
3354 -
3355 -{
3356 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3357 - "Balance": 0
3358 -}
3359 -
3360 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3361 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3362 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3363 -
3364 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3365 -
3366 -(% class="box infomessage" %)
3367 -(((
3368 -**GET /api/v3/Billing/client/constraint/{clientId}**
3369 -)))
3370 -
3371 -Параметр запроса: **clientId **- идентификатор клиента.
3372 -
3373 -Ответ:
3374 -
3375 -{
3376 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3377 - "CalculationType": 0,
3378 - "PermissibleBalance": 0,
3379 - "DefermentDays": 0,
3380 - "SendUiNotifications": true,
3381 - "SendEmailNotifications": true,
3382 - "IsPrivate": true,
3383 -}
3384 -
3385 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3386 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3387 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3388 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3389 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3390 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3391 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3392 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3393 -
3394 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3395 -
3396 -(% class="box infomessage" %)
3397 -(((
3398 -**GET /api/v3/Billing/client/plan/{clientId}**
3399 -)))
3400 -
3401 -Параметры запроса:
3402 -
3403 -**clientId **- идентификатор клиента.
3404 -
3405 -**planId **- идентификатор тарифного плана.
3406 -
3407 -Ответ:
3408 -
3409 -{
3410 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 - "Plan": { **~/~/ Описание тарифного плана**
3412 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 - "Name": "string",
3415 - "IsArchived": true,
3416 - "Constraint": {
3417 - "CalculationType": 0,
3418 - "PermissibleBalance": 0,
3419 - "DefermentDays": 0
3420 - },
3421 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3422 - {
3423 - "Feature": "string",
3424 - "IsFactual": true,
3425 - "Limit": 0,
3426 - "Price": 0,
3427 - "PeriodValue": 0,
3428 - "PeriodType": 0
3429 - }
3430 - ]
3431 - },
3432 - "DebitDate": "2023-10-18T12:46:24.213Z",
3433 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3434 - {
3435 - "Feature": "string",
3436 - "IsEnabled": true,
3437 - "IsPrivate": true,
3438 - "IsFactual": true,
3439 - "Limit": 0,
3440 - "Price": 0,
3441 - "DebitDate": "2023-10-18T12:46:24.213Z",
3442 - "PeriodValue": 0,
3443 - "PeriodType": 0
3444 - }
3445 - ]
3446 -}
3447 -
3448 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3449 -|ClientId|Идентификатор клиента
3450 -|Id|Идентификатор тарифного плана
3451 -|OwnerId|Идентификатор клиента-владельца
3452 -|Name|Наименование тарифного плана
3453 -|IsArchived|Признак, определяющий архивный тарифный план
3454 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3455 -|PermissibleBalance|Допустимый баланс
3456 -|DefermentDays|Отсрочка, количество дней
3457 -|Feature|Код услуги
3458 -|IsEnabled|Признак, определяющий активирована ли услуга
3459 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3460 -|IsFactual|Признак, определяющий расчёт по факту
3461 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3462 -|Price|Цена за единицу.
3463 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3464 -|PeriodValue|Значение периода.
3465 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3466 -
3467 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3468 -
3469 -(% class="box infomessage" %)
3470 -(((
3471 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3472 -)))
3473 -
3474 -Параметр запроса: **clientId **- идентификатор клиента.
3475 -
3476 -Ответ:
3477 -
3478 -[
3479 - {
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 -]
3501 -
3502 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 -|ClientId|Идентификатор клиента
3504 -|Id|Идентификатор тарифного плана
3505 -|OwnerId|Идентификатор клиента-владельца
3506 -|Name|Наименование тарифного плана
3507 -|IsArchived|Признак, определяющий архивный тарифный план
3508 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3509 -|PermissibleBalance|Допустимый баланс
3510 -|DefermentDays|Отсрочка, количество дней
3511 -|Feature|Код услуги
3512 -|IsFactual|Признак, определяющий расчёт по факту
3513 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3514 -|Price|Цена за единицу.
3515 -|PeriodValue|Значение периода.
3516 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3517 -
3518 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3519 -
3520 -(% class="box infomessage" %)
3521 -(((
3522 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3523 -)))
3524 -
3525 -Параметр запроса: **clientId **- идентификатор клиента.
3526 -
3527 -Ответ:
3528 -
3529 -[
3530 - {
3531 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3533 - "Name": "string",
3534 - "IsArchived": true,
3535 - "Constraint": {
3536 - "CalculationType": 0,
3537 - "PermissibleBalance": 0,
3538 - "DefermentDays": 0
3539 - },
3540 - "Features": [
3541 - {
3542 - "Feature": "string",
3543 - "IsFactual": true,
3544 - "Limit": 0,
3545 - "Price": 0,
3546 - "PeriodValue": 0,
3547 - "PeriodType": 0
3548 - }
3549 - ]
3550 - }
3551 -]
3552 -
3553 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3554 -|ClientId|Идентификатор клиента
3555 -|Id|Идентификатор тарифного плана
3556 -|OwnerId|Идентификатор клиента-владельца
3557 -|Name|Наименование тарифного плана
3558 -|IsArchived|Признак, определяющий архивный тарифный план
3559 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3560 -|PermissibleBalance|Допустимый баланс
3561 -|DefermentDays|Отсрочка, количество дней
3562 -|Feature|Код услуги
3563 -|IsFactual|Признак, определяющий расчёт по факту
3564 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3565 -|Price|Цена за единицу.
3566 -|PeriodValue|Значение периода.
3567 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3568 -
3569 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3570 -
3571 -(% class="box warningmessage" %)
3572 -(((
3573 -**PUT /api/v3/Billing/client/balance**
3574 -)))
3575 -
3576 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3577 -
3578 -Тело запроса:
3579 -
3580 -{
3581 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3582 - "Balance": 0
3583 -}
3584 -
3585 -Ответ: Success
3586 -
3587 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3588 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3589 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3590 -
3591 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3592 -
3593 -(% class="box warningmessage" %)
3594 -(((
3595 -**PUT /api/v3/billing/client/balance/deposit**
3596 -)))
3597 -
3598 -Создает операцию **Пополнение **с указанной суммой
3599 -
3600 -Тело запроса:
3601 -
3602 -{
3603 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3604 - "Balance": 0
3605 -}
3606 -
3607 -Ответ: Success
3608 -
3609 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3610 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3611 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3612 -
3613 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3614 -
3615 -Создает операцию **Списание **с указанной суммой
3616 -
3617 -(% class="box warningmessage" %)
3618 -(((
3619 -**PUT /api/v3/billing/client/balance/withdraw**
3620 -)))
3621 -
3622 -Тело запроса:
3623 -
3624 -{
3625 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3626 - "Balance": 0
3627 -}
3628 -
3629 -Ответ: Success
3630 -
3631 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3632 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3633 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3634 -
3635 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3636 -
3637 -(% class="box warningmessage" %)
3638 -(((
3639 -**PUT /api/v3/Billing/client/constraint**
3640 -)))
3641 -
3642 -Тело запроса:
3643 -
3644 -{
3645 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3646 - "CalculationType": 0,
3647 - "PermissibleBalance": 0,
3648 - "DefermentDays": 0,
3649 - "SendUiNotifications": true,
3650 - "SendEmailNotifications": true,
3651 - "IsPrivate": true,
3652 -}
3653 -
3654 -Ответ: Success
3655 -
3656 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3657 -|ClientId|Идентификатор клиента
3658 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3659 -|PermissibleBalance|Допустимый баланс
3660 -|DefermentDays|(((
3661 -Отсрочка, количество дней
3662 -)))
3663 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3664 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3665 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3666 -
3667 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3668 -
3669 -(% class="box warningmessage" %)
3670 -(((
3671 -**PUT /api/v3/Billing/client/plan**
3672 -)))
3673 -
3674 -Тело запроса:
3675 -
3676 -{
3677 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3678 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3679 - "Features": [
3680 - {
3681 - "Feature": "string",
3682 - "IsEnabled": true,
3683 - "IsFactual": true,
3684 - "Limit": 0,
3685 - "Price": 0,
3686 - "DebitDate": "2023-10-18T13:26:58.987Z",
3687 - "PeriodValue": 0,
3688 - "PeriodType": 0
3689 - }
3690 - ]
3691 -}
3692 -
3693 -Ответ: Success
3694 -
3695 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3696 -|ClientId|Идентификатор клиента
3697 -|PlanId|Идентификатор тарифного плана
3698 -|Feature|Код услуги
3699 -|IsEnabled|Признак, определяющий активирована ли услуга
3700 -|IsFactual|Признак, определяющий расчёт по факту
3701 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3702 -|Price|Цена за единицу.
3703 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3704 -|PeriodValue|Значение периода.
3705 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3706 -
3707 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3708 -
3709 -(% class="box warningmessage" %)
3710 -(((
3711 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3712 -)))
3713 -
3714 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3715 -
3716 -(% class="box infomessage" %)
3717 -(((
3718 -**POST /api/v3/vehicles/import/{agentId}**
3719 -)))
3720 -
3721 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3722 -
3723 -В пути указывается **agentId** - id клиента.
3724 -
3725 -**Заголовок**
3726 -
3727 -**X-Auth: [токен авторизации]**
3728 -
3729 -**Параметры**
3730 -
3731 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3732 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3733 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3734 -
3735 -В теле использовать тип **form-data,** тип значения** file**
3736 -
3737 -**Ключи**
3738 -
3739 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3740 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3741 -|csv|В значении передаем файл датчиков, формат **csv**
3742 -
3743 -Ответ:
3744 -
3745 -{
3746 - "vehicleId": 0,
3747 - "name": "string",
3748 - "errors": ["string"]
3749 -}
3750 -
3751 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3752 -|vehicleId|ID созданного объекта
3753 -|name|Имя созданного объекта
3754 -|errors|Ошибки и их описание
3755 -
3756 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3757 -
3758 -(% class="box infomessage" %)
3759 -(((
3760 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3761 -)))
3762 -
3763 -(% class="wikigeneratedid" %)
3764 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3765 -
3766 -(% class="wikigeneratedid" %)
3767 -В пути указывается **vehicleId **- id объекта.
3768 -
3769 -**Заголовок**
3770 -
3771 -**X-Auth: [токен авторизации]**
3772 -
3773 -В теле использовать тип **form-data.**
3774 -
3775 -Ключи:
3776 -
3777 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3778 -|**history**|В значении передавать файл с историей
3779 -
3780 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3781 -
3782 -Ответ:
3783 -
3784 -{
3785 - "results": [
3786 - {
3787 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3788 - "vehicleId": 0,
3789 - "errors": [
3790 - "string"
3791 - ],
3792 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3793 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3794 - "producedCount": 0,
3795 - "msgCount": 0
3796 - }
3797 - ]
3798 -}
3799 -
3800 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3801 -|results|Результаты импорта в разрезе ТС
3802 -|vehicleGuid|Guid ТС
3803 -|vehicleId|ID ТС
3804 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3805 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3806 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3807 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3808 -|msgCount|Кол-во обработанных сообщений всего
3809 -
3810 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3811 -
3812 -(% class="box infomessage" %)
3813 -(((
3814 -**GET /api/v3/vehicles/import/history/status**
3815 -)))
3816 -
3817 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3818 -
3819 -Ответ:
3820 -
3821 -{
3822 - "activity": true,
3823 - "progress": 0,
3824 - "message": "string"
3825 -}
3826 -
3827 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3828 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3829 -|progress|Guid ТС
3830 -
3831 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3832 -
3833 -(% class="box infomessage" %)
3834 -(((
3835 -**POST /api/v3/vehicles/export**
3836 -)))
3837 -
3838 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3839 -
3840 -Тело запроса:
3841 -
3842 -[
3843 - id
3844 -]
3845 -
3846 -Ответ: Success 200, получаете файлы с настройками.
3847 -
3848 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3849 -
3850 -(% class="box infomessage" %)
3851 -(((
3852 -**POST /api/v3/vehicles/export/history**
3853 -)))
3854 -
3855 -Метод возвращает список сообщений терминала объекта за выбранный период.
3856 -
3857 -Тело запроса:
3858 -
3859 -{
3860 - "vehicleId": 0,
3861 - "asArchive": true,
3862 - "from": "2023-09-27T12:17:45.973Z",
3863 - "to": "2023-09-27T12:17:45.973Z"
3864 -}
3865 -
3866 -Ответ:
3867 -
3868 -Получаете файл. Сообщение: Code 200/Success
3869 -
3870 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3871 -|vehicleId|ID объекта
3872 -|asArchive|true - Архивировать файл, False - не архивировать
3873 -|from|Дата и время начала запроса
3874 -|to|Дата и время окончания запроса
3875 -
3876 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3877 -
3878 -(% class="box infomessage" %)
3879 -(((
3880 -**GET /api/v3/vehicles/export/history/status**
3881 -)))
3882 -
3883 -Метод возвращает список сообщений терминала объекта за выбранный период.
3884 -
3885 -Ответ:
3886 -
3887 -{
3888 - "activity": true,
3889 - "progress": 0,
3890 - "message": "string"
3891 -}
3892 -
3893 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3894 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3895 -|progress|Прогресс экспорта, от 0 до 100%
3896 -|message|Текст описывающий статус
3897 -
3898 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3899 -
3900 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3901 -
3902 -(% class="box infomessage" %)
3903 -(((
3904 -**POST /api/v3/EcoDriving/rating**
3905 -)))
3906 -
3907 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3908 -
3909 -Тело запроса:
3910 -
3911 -{
3912 - "vehicleIds": [vehicleId],
3913 - "from": "2023-11-22T09:29:48.051Z",
3914 - "to": "2023-11-22T09:29:48.051Z"
3915 -}
3916 -
3917 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3918 -|vehicleIds|Массив ID объектов
3919 -|from|Дата начала запроса
3920 -|to|Дата окончания запроса
3921 -
3922 -Ответ:
3923 -
3924 -{
3925 - "items": [
3926 - {
3927 - "from": "2023-11-22T09:29:48.052Z",
3928 - "to": "2023-11-22T09:29:48.052Z",
3929 - "vehicleId": 0,
3930 - "vehicleName": "string",
3931 - "vehicleModel": "string",
3932 - "penalty": 0,
3933 - "score": 0,
3934 - "totalViolations": 0,
3935 - "violationsByType": {
3936 - "overspeedingViolations": 0,
3937 - "accelerationViolations": 0,
3938 - "brakingViolations": 0,
3939 - "turningViolations": 0,
3940 - "dangerousDrivingViolations": 0,
3941 - "sensorViolations": 0
3942 - },
3943 - "moveTime": 0,
3944 - "mileage": 0,
3945 - "tripsCount": 0,
3946 - "trips": [
3947 - {
3948 - "penalty": 0,
3949 - "score": 0,
3950 - "violationsCount": 0,
3951 - "violationsByType": {
3952 - "overspeedingViolations": 0,
3953 - "accelerationViolations": 0,
3954 - "brakingViolations": 0,
3955 - "turningViolations": 0,
3956 - "dangerousDrivingViolations": 0,
3957 - "sensorViolations": 0
3958 - },
3959 - "moveTime": 0,
3960 - "mileage": 0,
3961 - "motohours": 0,
3962 - "maxSpeed": 0,
3963 - "startAddress": "string",
3964 - "endAddress": "string",
3965 - "drivers": [
3966 - {
3967 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3968 - "driverName": "string",
3969 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3970 - }
3971 - ]
3972 - }
3973 - ]
3974 - }
3975 - ]
3976 -}
3977 -
3978 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3979 -|from|Дата начала запроса
3980 -|to|Дата  окончания
3981 -|vehicleId|ID объекта
3982 -|vehicleName|Имя объекта
3983 -|vehicleModel|Модель объекта
3984 -|penalty|Сумма штрафных баллов
3985 -|score|Оценка
3986 -|totalViolations|Суммарное количество нарушений
3987 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3988 -|overspeedingViolations|Превышение скорости
3989 -|accelerationViolations|Ускорение
3990 -|brakingViolations|Торможение
3991 -|turningViolations|Резкий поворот
3992 -|dangerousDrivingViolations|Резкое вождение
3993 -|sensorViolations|Нарушение по датчику
3994 -|moveTime|Время в движении
3995 -|mileage|Пробег
3996 -|tripsCount|Количество рейсов
3997 -|motohours|Моточасы
3998 -|maxSpeed|Максимальная скорость
3999 -|startAddress|Адрес начала рейса
4000 -|endAddress|Адрес окончания рейса
4001 -|drivers|Список водителей, которые были на объекте в течениии рейса
4002 -|driverGuid|Guid водителя
4003 -|driverName|Имя водителя
4004 -|driverRfid|Номер Карты-метки
4005 -
4006 4006  (% class="box" lang="en-US" style="text-align: center;" %)
4007 4007  (((
4008 4008  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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