Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 104.1 >
edited by Илья Крайнов
on 2023/08/03 17:57
To version < 126.1 >
edited by Илья Крайнов
on 2023/11/29 10:18
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box 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,12 @@
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 +
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" ~/~/ Корр. счет
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"
118 118   }
119 119  
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 +
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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,25 @@
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 - Отказ)
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "parentName": "string",
177 + "name": "string",
178 + "fullName": "string",
179 + "agentInfoType": 0,
180 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
183 +
184 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
191 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
192 +
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", ~/~/ идентификатор клиента-родителя 
211 + "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  
256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
257 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
258 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
259 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
260 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
261 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
262 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
263 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
264 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
265 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
266 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
267 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
268 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
269 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
270 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
271 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
272 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
273 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
274 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
275 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
276 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
277 +
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  
359 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
360 +
361 +(% class="box warningmessage" %)
362 +(((
363 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
364 +)))
365 +
366 +Метод позволяет изменить статус клиента, указанного в запросе.
367 +
368 +В пути указывается GUID клиента и статус клиента.
369 +
370 +**status **- значение 0 - заблокирован, 1 - активен.
371 +
372 +Ответ: Code 204
373 +
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  
465 +
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  
756 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
757 +
758 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
759 +
760 +(% class="box infomessage" %)
761 +(((
762 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
763 +)))
764 +
765 +Метод возвращает полную информацию о модели объекта.
766 +
767 +(% style="color:#000000" %)Метод запроса: **GET**
768 +
769 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
770 +
771 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
772 +
773 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
774 +
775 +(% style="color:#000000" %)Ответ:
776 +
777 +(% style="color:#000000" %){
778 + "parentName": "string",
779 + "name": "string",
780 + "picture": "string",
781 + "minspeed": 0,
782 + "maxspeed": 0,
783 + "width": 0,
784 + "imbeddedtrailer": true,
785 + "hoppercapacity": 0,
786 + "hopperdischargespeed": 0,
787 + "modelType": 0,
788 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
789 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 + "deleted": true
791 +}
792 +
793 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
794 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
795 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
796 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
797 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
798 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
799 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
800 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
801 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
802 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
803 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
804 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
805 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
806 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
807 +
808 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
809 +
810 +(% class="box successmessage" %)
811 +(((
812 +(% lang="en-US" %)**POST /api/v3/models/find**
813 +)))
814 +
815 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
816 +
817 +(% style="color:#000000" %)Метод запроса: **POST**
818 +
819 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
820 +
821 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
822 +
823 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
824 +
825 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
826 +}
827 +
828 +(% style="color:#000000" %)Ответ:
829 +
830 +(% style="color:#000000" %)[
831 + {
832 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
833 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
834 + "parentName": "string",
835 + "name": "string",
836 + "modelType": 0
837 + }
838 +]
839 +
840 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
841 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
842 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
844 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
845 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
846 +
847 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
848 +
849 +(% class="box successmessage" %)
850 +(((
851 +(% lang="en-US" %)**POST /api/v3/models**
852 +)))
853 +
854 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
855 +
856 +(% style="color:#000000" %)Метод запроса: **POST**
857 +
858 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
859 +
860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
861 +
862 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
863 +
864 +{
865 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
866 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 + "deleted": true,
868 + "extId": "string",
869 + "name": "string",
870 + "picture": "string",
871 + "minspeed": 0,
872 + "maxspeed": 0,
873 + "width": 0,
874 + "imbeddedtrailer": true,
875 + "fueloutlay": 0,
876 + "hoppercapacity": 0,
877 + "hopperdischargespeed": 0,
878 + "modelType": 0
879 +}
880 +
881 +Ответ:
882 +
883 +{
884 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
885 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 + "deleted": true,
887 + "extId": "string",
888 + "name": "string",
889 + "picture": "string",
890 + "minspeed": 0,
891 + "maxspeed": 0,
892 + "width": 0,
893 + "imbeddedtrailer": true,
894 + "hoppercapacity": 0,
895 + "hopperdischargespeed": 0,
896 + "modelType": 0
897 +}
898 +
899 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
900 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
901 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
903 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
905 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
906 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
907 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
908 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
909 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
910 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
911 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
912 +
913 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
914 +
915 +(% class="box warningmessage" %)
916 +(((
917 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
918 +)))
919 +
920 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
921 +
922 +(% style="color:#000000" %)Метод запроса: **PUT**
923 +
924 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
925 +
926 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
927 +
928 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
929 +
930 +{
931 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
932 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 + "deleted": true,
934 + "extId": "string",
935 + "name": "string",
936 + "picture": "string",
937 + "minspeed": 0,
938 + "maxspeed": 0,
939 + "width": 0,
940 + "imbeddedtrailer": true,
941 + "fueloutlay": 0,
942 + "hoppercapacity": 0,
943 + "hopperdischargespeed": 0,
944 + "modelType": 0
945 +}
946 +
947 +Ответ:
948 +
949 +{
950 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
951 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
952 + "deleted": true,
953 + "extId": "string",
954 + "name": "string",
955 + "picture": "string",
956 + "minspeed": 0,
957 + "maxspeed": 0,
958 + "width": 0,
959 + "imbeddedtrailer": true,
960 + "fueloutlay": 0,
961 + "hoppercapacity": 0,
962 + "hopperdischargespeed": 0,
963 + "modelType": 0
964 +}
965 +
966 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
967 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
968 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
970 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
972 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
973 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
974 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
975 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
976 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
977 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
978 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
979 +
980 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
981 +
982 +(% class="box errormessage" %)
983 +(((
984 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
985 +)))
986 +
987 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
988 +
989 +(% style="color:#000000" %)Метод запроса: **DELETE**
990 +
991 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
992 +
993 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
994 +
995 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
996 +
997 +Ответ: В случае успеха **Success 200**
998 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1504,10 +1504,304 @@
1504 1504  (% style="text-align:left" %)
1505 1505  (% style="color:#000000" %)}
1506 1506  
1821 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1507 1507  
1823 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1824 +
1825 +(% class="box infomessage" %)
1826 +(((
1827 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1828 +)))
1829 +
1830 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1831 +
1832 +(% style="color:#000000" %)Метод запроса: **GET**
1833 +
1834 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1835 +
1836 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1837 +
1838 +(% style="color:#000000" %)Ответ:
1839 +
1840 +(% style="color:#000000" %){
1841 +
1842 + "id": "", ~/~/ ID типа датчика 
1843 + "name": "", ~/~/ Название
1844 + "description": "", ~/~/ Описание
1845 +
1508 1508  (% style="text-align:left" %)
1509 -(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**
1847 +(% style="color:#000000" %)}
1510 1510  
1849 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1850 +
1851 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1852 +
1853 +(% class="box infomessage" style="text-align: left;" %)
1854 +(((
1855 +**POST /api/v3/terminalMessages/count**
1856 +)))
1857 +
1858 +(% style="text-align: left;" %)
1859 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1860 +
1861 +(% style="text-align: left;" %)
1862 +Метод запроса **POST**
1863 +
1864 +(% style="text-align: left;" %)
1865 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1866 +
1867 +(% style="text-align: left;" %)
1868 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1869 +
1870 +(% style="text-align: left;" %)
1871 +{
1872 + "vehicleIds": [
1873 + id ~/~/ здесь передается список идентификаторов объектов
1874 + ],
1875 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1876 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1877 +}
1878 +
1879 +(% style="text-align: left;" %)
1880 +Ответ:
1881 +
1882 +(% style="text-align: left;" %)
1883 +[
1884 + {
1885 + "vehicleId": 0, ~/~/ идентификатор объекта
1886 + "count": 0 ~/~/ количество сообщений за период
1887 + }
1888 +]
1889 +
1890 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1891 +
1892 +(% class="box infomessage" style="text-align: left;" %)
1893 +(((
1894 +**POST /api/v3/terminalMessages/mapping**
1895 +)))
1896 +
1897 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1898 +
1899 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1900 +
1901 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1902 +
1903 +{
1904 + "protocolType": 0,
1905 + "params": ["string"]
1906 +}
1907 +
1908 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909 +|protocolType|ID типа протокола
1910 +|params|(((
1911 +Массив наименований параметров в сообщении
1912 +)))
1913 +
1914 +Ответ:
1915 +
1916 +{
1917 + "protocolType": 0,
1918 + "mapping": {
1919 + "additionalProp1": {
1920 + "inputType": 0,
1921 + "inputNumber": 0
1922 + },
1923 + "additionalProp2": {
1924 + "inputType": 0,
1925 + "inputNumber": 0
1926 + }
1927 + }
1928 +}
1929 +
1930 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931 +|protocolType|Тип протокола
1932 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933 +|inputNumber|Номер входа
1934 +
1935 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1936 +
1937 +(% class="box infomessage" %)
1938 +(((
1939 +**POST /api/v3/terminalMessages**
1940 +)))
1941 +
1942 +Метод возвращает список сообщений терминала объекта за выбранный период.
1943 +
1944 +(% style="text-align: left;" %)
1945 +Метод запроса **POST**
1946 +
1947 +(% style="text-align: left;" %)
1948 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1949 +
1950 +(% style="text-align: left;" %)
1951 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1952 +
1953 +{
1954 + "vehicleId": 0, ~/~/ id объекта
1955 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1956 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1957 +}
1958 +
1959 +Ответ:
1960 +
1961 +[
1962 + {
1963 + "messages": [
1964 + {
1965 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1966 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1967 + "speed": 0, ~/~/ Скорость, км/ч
1968 + "altitude": 0, ~/~/ Высота, м
1969 + "latitude": 0, ~/~/ Широта [-90°;90°]
1970 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1971 + "satellites": 0, ~/~/ Кол-во спутников
1972 + "voltage": 0, ~/~/ Напряжение
1973 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1974 + "additionalProp1": "string",
1975 + "additionalProp2": "string",
1976 + "additionalProp3": "string"
1977 + },
1978 + "photoCount": 0 ~/~/ Кол-во фото
1979 + }
1980 + ]
1981 + }
1982 +]
1983 +
1984 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1985 +
1986 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1987 +
1988 +(% class="box infomessage" %)
1989 +(((
1990 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1991 +)))
1992 +
1993 +(% style="color:#000000" %)Метод запроса: **POST**
1994 +
1995 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
1996 +
1997 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1998 +
1999 +(% style="text-align:left" %)
2000 +Тело запроса:
2001 +
2002 +{
2003 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2004 + "vehicleIds": [0], ~/~/ Список ID объектов
2005 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2006 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2007 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2008 +}
2009 +
2010 +Ответ:
2011 +
2012 +[
2013 + {
2014 + "vehicleId": 0, ~/~/ ID объекта
2015 + "name": "string", ~/~/ Имя ТС
2016 + "periods": [ ~/~/ Периоды
2017 + {
2018 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2019 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2020 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2021 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2022 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2023 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2024 + }
2025 + ]
2026 + }
2027 +]
2028 +
2029 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2030 +
2031 +(% class="box infomessage" %)
2032 +(((
2033 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2034 +)))
2035 +
2036 +(% style="color:#000000" %)Метод запроса: **POST**
2037 +
2038 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2039 +
2040 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2041 +
2042 +(% style="text-align:left" %)
2043 +Тело запроса:
2044 +
2045 +{
2046 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2047 + "vehicleIds": [0], ~/~/ Список ID объектов
2048 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2049 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2050 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2051 +}
2052 +
2053 +Ответ:
2054 +
2055 +[
2056 + {
2057 + "vehicleId": 0, ~/~/ ID объекта
2058 + "name": "string", ~/~/ Имя ТС
2059 + "periods": [ ~/~/ Периоды
2060 + {
2061 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2062 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2063 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2064 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2065 + "fuelConsumption": 0, ~/~/ Расход топлива
2066 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2067 + }
2068 + ]
2069 + }
2070 +]
2071 +
2072 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2073 +
2074 +(% class="box infomessage" %)
2075 +(((
2076 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2077 +)))
2078 +
2079 +(% style="color:#000000" %)Метод запроса: **POST**
2080 +
2081 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2082 +
2083 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2084 +
2085 +(% style="text-align:left" %)
2086 +Тело запроса:
2087 +
2088 +{
2089 + "vehicleIds": [0], ~/~/ Список ID объектов
2090 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2091 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2092 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2093 +}
2094 +
2095 +Ответ:
2096 +
2097 +[
2098 + {
2099 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2100 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2101 + "vehicleId": 0, ~/~/ ID объекта
2102 + "name": "string", ~/~/ Имя объекта
2103 + "model": "string", ~/~/ Модель объекта
2104 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2105 + {
2106 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2107 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2108 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2109 + "valueFuel": 0, ~/~/ Количество
2110 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2111 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2112 + }
2113 + ]
2114 + }
2115 +]
2116 +
2117 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2118 +
1511 1511  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
1512 1512  
1513 1513  (% class="box infomessage" %)
... ... @@ -1519,7 +1519,7 @@
1519 1519  
1520 1520  (% style="color:#000000" %)Метод запроса: **POST**
1521 1521  
1522 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
2130 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
1523 1523  
1524 1524  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1525 1525  
... ... @@ -1634,124 +1634,6 @@
1634 1634   }
1635 1635  ]
1636 1636  
1637 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1638 -
1639 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1640 -
1641 -(% class="box infomessage" %)
1642 -(((
1643 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1644 -)))
1645 -
1646 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1647 -
1648 -(% style="color:#000000" %)Метод запроса: **GET**
1649 -
1650 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1651 -
1652 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1653 -
1654 -(% style="color:#000000" %)Ответ:
1655 -
1656 -(% style="color:#000000" %){
1657 -
1658 - "id": "", ~/~/ ID типа датчика 
1659 - "name": "", ~/~/ Название
1660 - "description": "", ~/~/ Описание
1661 -
1662 -(% style="text-align:left" %)
1663 -(% style="color:#000000" %)}
1664 -
1665 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1666 -
1667 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1668 -
1669 -(% class="box infomessage" style="text-align: left;" %)
1670 -(((
1671 -**POST /api/v3/terminalMessages/count**
1672 -)))
1673 -
1674 -(% style="text-align: left;" %)
1675 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1676 -
1677 -(% style="text-align: left;" %)
1678 -Метод запроса **POST**
1679 -
1680 -(% style="text-align: left;" %)
1681 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1682 -
1683 -(% style="text-align: left;" %)
1684 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1685 -
1686 -(% style="text-align: left;" %)
1687 -{
1688 - "vehicleIds": [
1689 - id ~/~/ здесь передается список идентификаторов объектов
1690 - ],
1691 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1692 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1693 -}
1694 -
1695 -(% style="text-align: left;" %)
1696 -Ответ:
1697 -
1698 -(% style="text-align: left;" %)
1699 -[
1700 - {
1701 - "vehicleId": 0, ~/~/ идентификатор объекта
1702 - "count": 0 ~/~/ количество сообщений за период
1703 - }
1704 -]
1705 -
1706 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1707 -
1708 -(% class="box infomessage" %)
1709 -(((
1710 -**POST /api/v3/terminalMessages**
1711 -)))
1712 -
1713 -Метод возвращает список сообщений терминала объекта за выбранный период.
1714 -
1715 -(% style="text-align: left;" %)
1716 -Метод запроса **POST**
1717 -
1718 -(% style="text-align: left;" %)
1719 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1720 -
1721 -(% style="text-align: left;" %)
1722 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1723 -
1724 -{
1725 - "vehicleId": 0, ~/~/ id объекта
1726 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1727 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1728 -}
1729 -
1730 -Ответ:
1731 -
1732 -[
1733 - {
1734 - "messages": [
1735 - {
1736 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1737 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1738 - "speed": 0, ~/~/ Скорость, км/ч
1739 - "altitude": 0, ~/~/ Высота, м
1740 - "latitude": 0, ~/~/ Широта [-90°;90°]
1741 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1742 - "satellites": 0, ~/~/ Кол-во спутников
1743 - "voltage": 0, ~/~/ Напряжение
1744 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1745 - "additionalProp1": "string",
1746 - "additionalProp2": "string",
1747 - "additionalProp3": "string"
1748 - },
1749 - "photoCount": 0 ~/~/ Кол-во фото
1750 - }
1751 - ]
1752 - }
1753 -]
1754 -
1755 1755  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1756 1756  
1757 1757  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2522,6 +2522,83 @@
2522 2522  Success
2523 2523  
2524 2524  
3015 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3016 +
3017 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3018 +
3019 +(% class="box infomessage" %)
3020 +(((
3021 +**POST /api/v3/Trailers**
3022 +)))
3023 +
3024 +Пример запроса:
3025 +
3026 +{
3027 + "startDate": "2023-11-14T10:48:03.671Z",
3028 + "endDate": "2023-11-14T10:48:03.671Z",
3029 + "ids": [ 0 ],
3030 + "timezone": 0
3031 +}
3032 +
3033 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3034 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3035 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3036 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3037 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3038 +
3039 +Пример ответа:
3040 +
3041 +[
3042 + {
3043 + "SD": "2023-11-14T10:48:03.717Z",
3044 + "ED": "2023-11-14T10:48:03.717Z", 
3045 + "id": 0,
3046 + "SLat": 0,
3047 + "SLon": 0,
3048 + "ELat": 0,
3049 + "ELon": 0,
3050 + "mileage": 0
3051 + "Duration": 0
3052 + "Address": "string",
3053 + "Address2": "string",
3054 + "name": "string",
3055 + "rid": "string",
3056 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3057 + "trailer": {
3058 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 + "Number": "string",
3060 + "Description": "string",
3061 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3062 + "ExternalID": "string",
3063 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3064 + "CreateTime": "2023-11-14T10:48:03.717Z",
3065 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3066 + "IsDeleted": true
3067 + },
3068 + "filesCount": 0,
3069 + }
3070 +]
3071 +
3072 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3073 +|SD|Дата и время начала события
3074 +|ED|Дата и время окончания события
3075 +|id|ID объекта
3076 +|SLat|Широта начальной координаты
3077 +|SLon|Долгота начальной координаты
3078 +|ELat|Широта конечной координаты
3079 +|ELon|Долгота конечной координаты
3080 +|mileage|Пробег
3081 +|Duration|Продолжительность
3082 +|Address|Адрес начального местоположения
3083 +|Address2|Адрес конечного местоположения
3084 +|name|Имя радиометки
3085 +|rid|Номер радиометки
3086 +|rguid|ID радиометки
3087 +|trailer|Информация об агрегате
3088 +|ModelGuid|ID агрегата
3089 +|Number|Название/номер агрегата
3090 +|Description|Текст примечания агрегата
3091 +
2525 2525  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2526 2526  
2527 2527  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2543,13 +2543,18 @@
2543 2543   {
2544 2544   "name": "string",
2545 2545   "number": 0,
2546 - "period": 0, ~/~/ Частота трансляции радиометки
3113 + "period": 0,
2547 2547   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2548 2548   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2549 - "deleted": true
2550 2550   }
2551 2551  ]
2552 2552  
3119 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3120 +|parentId|ID клиента
3121 +|name|Название карты-метки
3122 +|number|Номер
3123 +|period|Период запросов в секундах (работает только для агрегатов)
3124 +|id|ID карты-метки
2553 2553  
2554 2554  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2555 2555  
... ... @@ -2566,13 +2566,18 @@
2566 2566   {
2567 2567   "name": "string",
2568 2568   "number": 0,
2569 - "period": 0, ~/~/ Частота трансляции радиометки
3141 + "period": 0,
2570 2570   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2571 2571   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2572 - "deleted": true
2573 2573   }
2574 2574  ]
2575 2575  
3147 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3148 +|name|Название карты-метки
3149 +|number|Номер
3150 +|period|Период запросов в секундах (работает только для агрегатов)
3151 +|id|ID карты-метки
3152 +|parentId|ID клиента
2576 2576  
2577 2577  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2578 2578  
... ... @@ -2588,7 +2588,6 @@
2588 2588   "number": 0,
2589 2589   "period": 0,
2590 2590   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2591 - "deleted": true
2592 2592  }
2593 2593  
2594 2594  Ответ:
... ... @@ -2599,9 +2599,14 @@
2599 2599   "period": 0,
2600 2600   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2601 2601   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2602 - "deleted": true
2603 2603  }
2604 2604  
3180 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3181 +|name|Название карты-метки
3182 +|number|Номер
3183 +|period|Период запросов в секундах (работает только для агрегатов)
3184 +|id|ID карты-метки
3185 +|parentId|ID клиента
2605 2605  
2606 2606  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2607 2607  
... ... @@ -2618,7 +2618,6 @@
2618 2618   "period": 0,
2619 2619   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2620 2620   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2621 - "deleted": true
2622 2622  }
2623 2623  
2624 2624  Ответ:
... ... @@ -2629,9 +2629,14 @@
2629 2629   "period": 0,
2630 2630   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2631 2631   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2632 - "deleted": true
2633 2633  }
2634 2634  
3214 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3215 +|name|Название карты-метки
3216 +|number|Номер
3217 +|period|Период запросов в секундах (работает только для агрегатов)
3218 +|id|ID карты-метки
3219 +|parentId|ID клиента
2635 2635  
2636 2636  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2637 2637  
... ... @@ -2640,7 +2640,7 @@
2640 2640  **DELETE /api/v3/Rfids/{rfidGuid}**
2641 2641  )))
2642 2642  
2643 -Передаем параметр rfidGuid - идентификатор карты-метки
3228 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2644 2644  
2645 2645  Ответ:
2646 2646  
... ... @@ -2647,6 +2647,670 @@
2647 2647  Success
2648 2648  
2649 2649  
3235 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3236 +
3237 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3238 +
3239 +(% class="box infomessage" %)
3240 +(((
3241 +**GET /api/v3/Billing/client/balance/{clientId}**
3242 +)))
3243 +
3244 +Параметр запроса: **clientId **- идентификатор клиента.
3245 +
3246 +Ответ:
3247 +
3248 +{
3249 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3250 + "Balance": 0
3251 +}
3252 +
3253 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3254 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3255 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3256 +
3257 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3258 +
3259 +(% class="box infomessage" %)
3260 +(((
3261 +**GET /api/v3/Billing/client/constraint/{clientId}**
3262 +)))
3263 +
3264 +Параметр запроса: **clientId **- идентификатор клиента.
3265 +
3266 +Ответ:
3267 +
3268 +{
3269 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3270 + "CalculationType": 0,
3271 + "PermissibleBalance": 0,
3272 + "DefermentDays": 0,
3273 + "SendUiNotifications": true,
3274 + "SendEmailNotifications": true,
3275 + "IsPrivate": true,
3276 +}
3277 +
3278 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3279 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3280 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3281 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3282 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3283 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3284 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3285 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3286 +
3287 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3288 +
3289 +(% class="box infomessage" %)
3290 +(((
3291 +**GET /api/v3/Billing/client/plan/{clientId}**
3292 +)))
3293 +
3294 +Параметры запроса:
3295 +
3296 +**clientId **- идентификатор клиента.
3297 +
3298 +**planId **- идентификатор тарифного плана.
3299 +
3300 +Ответ:
3301 +
3302 +{
3303 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3304 + "Plan": { **~/~/ Описание тарифного плана**
3305 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3306 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3307 + "Name": "string",
3308 + "IsArchived": true,
3309 + "Constraint": {
3310 + "CalculationType": 0,
3311 + "PermissibleBalance": 0,
3312 + "DefermentDays": 0
3313 + },
3314 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3315 + {
3316 + "Feature": "string",
3317 + "IsFactual": true,
3318 + "Limit": 0,
3319 + "Price": 0,
3320 + "PeriodValue": 0,
3321 + "PeriodType": 0
3322 + }
3323 + ]
3324 + },
3325 + "DebitDate": "2023-10-18T12:46:24.213Z",
3326 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3327 + {
3328 + "Feature": "string",
3329 + "IsEnabled": true,
3330 + "IsPrivate": true,
3331 + "IsFactual": true,
3332 + "Limit": 0,
3333 + "Price": 0,
3334 + "DebitDate": "2023-10-18T12:46:24.213Z",
3335 + "PeriodValue": 0,
3336 + "PeriodType": 0
3337 + }
3338 + ]
3339 +}
3340 +
3341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3342 +|ClientId|Идентификатор клиента
3343 +|Id|Идентификатор тарифного плана
3344 +|OwnerId|Идентификатор клиента-владельца
3345 +|Name|Наименование тарифного плана
3346 +|IsArchived|Признак, определяющий архивный тарифный план
3347 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3348 +|PermissibleBalance|Допустимый баланс
3349 +|DefermentDays|Отсрочка, количество дней
3350 +|Feature|Код услуги
3351 +|IsEnabled|Признак, определяющий активирована ли услуга
3352 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3353 +|IsFactual|Признак, определяющий расчёт по факту
3354 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3355 +|Price|Цена за единицу.
3356 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3357 +|PeriodValue|Значение периода.
3358 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3359 +
3360 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3361 +
3362 +(% class="box infomessage" %)
3363 +(((
3364 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3365 +)))
3366 +
3367 +Параметр запроса: **clientId **- идентификатор клиента.
3368 +
3369 +Ответ:
3370 +
3371 +[
3372 + {
3373 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3374 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3375 + "Name": "string",
3376 + "IsArchived": true,
3377 + "Constraint": {
3378 + "CalculationType": 0,
3379 + "PermissibleBalance": 0,
3380 + "DefermentDays": 0
3381 + },
3382 + "Features": [
3383 + {
3384 + "Feature": "string",
3385 + "IsFactual": true,
3386 + "Limit": 0,
3387 + "Price": 0,
3388 + "PeriodValue": 0,
3389 + "PeriodType": 0
3390 + }
3391 + ]
3392 + }
3393 +]
3394 +
3395 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3396 +|ClientId|Идентификатор клиента
3397 +|Id|Идентификатор тарифного плана
3398 +|OwnerId|Идентификатор клиента-владельца
3399 +|Name|Наименование тарифного плана
3400 +|IsArchived|Признак, определяющий архивный тарифный план
3401 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3402 +|PermissibleBalance|Допустимый баланс
3403 +|DefermentDays|Отсрочка, количество дней
3404 +|Feature|Код услуги
3405 +|IsFactual|Признак, определяющий расчёт по факту
3406 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3407 +|Price|Цена за единицу.
3408 +|PeriodValue|Значение периода.
3409 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3410 +
3411 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3412 +
3413 +(% class="box infomessage" %)
3414 +(((
3415 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3416 +)))
3417 +
3418 +Параметр запроса: **clientId **- идентификатор клиента.
3419 +
3420 +Ответ:
3421 +
3422 +[
3423 + {
3424 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3425 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3426 + "Name": "string",
3427 + "IsArchived": true,
3428 + "Constraint": {
3429 + "CalculationType": 0,
3430 + "PermissibleBalance": 0,
3431 + "DefermentDays": 0
3432 + },
3433 + "Features": [
3434 + {
3435 + "Feature": "string",
3436 + "IsFactual": true,
3437 + "Limit": 0,
3438 + "Price": 0,
3439 + "PeriodValue": 0,
3440 + "PeriodType": 0
3441 + }
3442 + ]
3443 + }
3444 +]
3445 +
3446 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3447 +|ClientId|Идентификатор клиента
3448 +|Id|Идентификатор тарифного плана
3449 +|OwnerId|Идентификатор клиента-владельца
3450 +|Name|Наименование тарифного плана
3451 +|IsArchived|Признак, определяющий архивный тарифный план
3452 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3453 +|PermissibleBalance|Допустимый баланс
3454 +|DefermentDays|Отсрочка, количество дней
3455 +|Feature|Код услуги
3456 +|IsFactual|Признак, определяющий расчёт по факту
3457 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3458 +|Price|Цена за единицу.
3459 +|PeriodValue|Значение периода.
3460 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3461 +
3462 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3463 +
3464 +(% class="box warningmessage" %)
3465 +(((
3466 +**PUT /api/v3/Billing/client/balance**
3467 +)))
3468 +
3469 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3470 +
3471 +Тело запроса:
3472 +
3473 +{
3474 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3475 + "Balance": 0
3476 +}
3477 +
3478 +Ответ: Success
3479 +
3480 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3481 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3482 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3483 +
3484 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3485 +
3486 +(% class="box warningmessage" %)
3487 +(((
3488 +**PUT /api/v3/billing/client/balance/deposit**
3489 +)))
3490 +
3491 +Создает операцию **Пополнение **с указанной суммой
3492 +
3493 +Тело запроса:
3494 +
3495 +{
3496 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497 + "Balance": 0
3498 +}
3499 +
3500 +Ответ: Success
3501 +
3502 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3504 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3505 +
3506 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3507 +
3508 +Создает операцию **Списание **с указанной суммой
3509 +
3510 +(% class="box warningmessage" %)
3511 +(((
3512 +**PUT /api/v3/billing/client/balance/withdraw**
3513 +)))
3514 +
3515 +Тело запроса:
3516 +
3517 +{
3518 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 + "Balance": 0
3520 +}
3521 +
3522 +Ответ: Success
3523 +
3524 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3525 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3526 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3527 +
3528 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3529 +
3530 +(% class="box warningmessage" %)
3531 +(((
3532 +**PUT /api/v3/Billing/client/constraint**
3533 +)))
3534 +
3535 +Тело запроса:
3536 +
3537 +{
3538 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3539 + "CalculationType": 0,
3540 + "PermissibleBalance": 0,
3541 + "DefermentDays": 0,
3542 + "SendUiNotifications": true,
3543 + "SendEmailNotifications": true,
3544 + "IsPrivate": true,
3545 +}
3546 +
3547 +Ответ: Success
3548 +
3549 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3550 +|ClientId|Идентификатор клиента
3551 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3552 +|PermissibleBalance|Допустимый баланс
3553 +|DefermentDays|(((
3554 +Отсрочка, количество дней
3555 +)))
3556 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3557 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3558 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3559 +
3560 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3561 +
3562 +(% class="box warningmessage" %)
3563 +(((
3564 +**PUT /api/v3/Billing/client/plan**
3565 +)))
3566 +
3567 +Тело запроса:
3568 +
3569 +{
3570 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3571 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3572 + "Features": [
3573 + {
3574 + "Feature": "string",
3575 + "IsEnabled": true,
3576 + "IsFactual": true,
3577 + "Limit": 0,
3578 + "Price": 0,
3579 + "DebitDate": "2023-10-18T13:26:58.987Z",
3580 + "PeriodValue": 0,
3581 + "PeriodType": 0
3582 + }
3583 + ]
3584 +}
3585 +
3586 +Ответ: Success
3587 +
3588 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3589 +|ClientId|Идентификатор клиента
3590 +|PlanId|Идентификатор тарифного плана
3591 +|Feature|Код услуги
3592 +|IsEnabled|Признак, определяющий активирована ли услуга
3593 +|IsFactual|Признак, определяющий расчёт по факту
3594 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3595 +|Price|Цена за единицу.
3596 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3597 +|PeriodValue|Значение периода.
3598 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3599 +
3600 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3601 +
3602 +(% class="box warningmessage" %)
3603 +(((
3604 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3605 +)))
3606 +
3607 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3608 +
3609 +(% class="box infomessage" %)
3610 +(((
3611 +**POST /api/v3/vehicles/import/{agentId}**
3612 +)))
3613 +
3614 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3615 +
3616 +В пути указывается **agentId** - id клиента.
3617 +
3618 +**Заголовок**
3619 +
3620 +**X-Auth: [токен авторизации]**
3621 +
3622 +**Параметры**
3623 +
3624 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3626 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3627 +
3628 +В теле использовать тип **form-data,** тип значения** file**
3629 +
3630 +**Ключи**
3631 +
3632 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3633 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3634 +|csv|В значении передаем файл датчиков, формат **csv**
3635 +
3636 +Ответ:
3637 +
3638 +{
3639 + "vehicleId": 0,
3640 + "name": "string",
3641 + "errors": ["string"]
3642 +}
3643 +
3644 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3645 +|vehicleId|ID созданного объекта
3646 +|name|Имя созданного объекта
3647 +|errors|Ошибки и их описание
3648 +
3649 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3650 +
3651 +(% class="box infomessage" %)
3652 +(((
3653 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3654 +)))
3655 +
3656 +(% class="wikigeneratedid" %)
3657 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3658 +
3659 +(% class="wikigeneratedid" %)
3660 +В пути указывается **vehicleId **- id объекта.
3661 +
3662 +**Заголовок**
3663 +
3664 +**X-Auth: [токен авторизации]**
3665 +
3666 +В теле использовать тип **form-data.**
3667 +
3668 +Ключи:
3669 +
3670 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671 +|**history**|В значении передавать файл с историей
3672 +
3673 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3674 +
3675 +Ответ:
3676 +
3677 +{
3678 + "results": [
3679 + {
3680 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 + "vehicleId": 0,
3682 + "errors": [
3683 + "string"
3684 + ],
3685 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3686 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3687 + "producedCount": 0,
3688 + "msgCount": 0
3689 + }
3690 + ]
3691 +}
3692 +
3693 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 +|results|Результаты импорта в разрезе ТС
3695 +|vehicleGuid|Guid ТС
3696 +|vehicleId|ID ТС
3697 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3698 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3699 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3700 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3701 +|msgCount|Кол-во обработанных сообщений всего
3702 +
3703 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3704 +
3705 +(% class="box infomessage" %)
3706 +(((
3707 +**GET /api/v3/vehicles/import/history/status**
3708 +)))
3709 +
3710 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3711 +
3712 +Ответ:
3713 +
3714 +{
3715 + "activity": true,
3716 + "progress": 0,
3717 + "message": "string"
3718 +}
3719 +
3720 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3721 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3722 +|progress|Guid ТС
3723 +
3724 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3725 +
3726 +(% class="box infomessage" %)
3727 +(((
3728 +**POST /api/v3/vehicles/export**
3729 +)))
3730 +
3731 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3732 +
3733 +Тело запроса:
3734 +
3735 +[
3736 + id
3737 +]
3738 +
3739 +Ответ: Success 200, получаете файлы с настройками.
3740 +
3741 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3742 +
3743 +(% class="box infomessage" %)
3744 +(((
3745 +**POST /api/v3/vehicles/export/history**
3746 +)))
3747 +
3748 +Метод возвращает список сообщений терминала объекта за выбранный период.
3749 +
3750 +Тело запроса:
3751 +
3752 +{
3753 + "vehicleId": 0,
3754 + "asArchive": true,
3755 + "from": "2023-09-27T12:17:45.973Z",
3756 + "to": "2023-09-27T12:17:45.973Z"
3757 +}
3758 +
3759 +Ответ:
3760 +
3761 +Получаете файл. Сообщение: Code 200/Success
3762 +
3763 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3764 +|vehicleId|ID объекта
3765 +|asArchive|true - Архивировать файл, False - не архивировать
3766 +|from|Дата и время начала запроса
3767 +|to|Дата и время окончания запроса
3768 +
3769 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3770 +
3771 +(% class="box infomessage" %)
3772 +(((
3773 +**GET /api/v3/vehicles/export/history/status**
3774 +)))
3775 +
3776 +Метод возвращает список сообщений терминала объекта за выбранный период.
3777 +
3778 +Ответ:
3779 +
3780 +{
3781 + "activity": true,
3782 + "progress": 0,
3783 + "message": "string"
3784 +}
3785 +
3786 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3787 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3788 +|progress|Прогресс экспорта, от 0 до 100%
3789 +|message|Текст описывающий статус
3790 +
3791 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3792 +
3793 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3794 +
3795 +(% class="box infomessage" %)
3796 +(((
3797 +**POST /api/v3/EcoDriving/rating**
3798 +)))
3799 +
3800 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3801 +
3802 +Тело запроса:
3803 +
3804 +{
3805 + "vehicleIds": [vehicleId],
3806 + "from": "2023-11-22T09:29:48.051Z",
3807 + "to": "2023-11-22T09:29:48.051Z"
3808 +}
3809 +
3810 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3811 +|vehicleIds|Массив ID объектов
3812 +|from|Дата начала запроса
3813 +|to|Дата окончания запроса
3814 +
3815 +Ответ:
3816 +
3817 +{
3818 + "items": [
3819 + {
3820 + "from": "2023-11-22T09:29:48.052Z",
3821 + "to": "2023-11-22T09:29:48.052Z",
3822 + "vehicleId": 0,
3823 + "vehicleName": "string",
3824 + "vehicleModel": "string",
3825 + "penalty": 0,
3826 + "score": 0,
3827 + "totalViolations": 0,
3828 + "violationsByType": {
3829 + "overspeedingViolations": 0,
3830 + "accelerationViolations": 0,
3831 + "brakingViolations": 0,
3832 + "turningViolations": 0,
3833 + "dangerousDrivingViolations": 0,
3834 + "sensorViolations": 0
3835 + },
3836 + "moveTime": 0,
3837 + "mileage": 0,
3838 + "tripsCount": 0,
3839 + "trips": [
3840 + {
3841 + "penalty": 0,
3842 + "score": 0,
3843 + "violationsCount": 0,
3844 + "violationsByType": {
3845 + "overspeedingViolations": 0,
3846 + "accelerationViolations": 0,
3847 + "brakingViolations": 0,
3848 + "turningViolations": 0,
3849 + "dangerousDrivingViolations": 0,
3850 + "sensorViolations": 0
3851 + },
3852 + "moveTime": 0,
3853 + "mileage": 0,
3854 + "motohours": 0,
3855 + "maxSpeed": 0,
3856 + "startAddress": "string",
3857 + "endAddress": "string",
3858 + "drivers": [
3859 + {
3860 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3861 + "driverName": "string",
3862 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3863 + }
3864 + ]
3865 + }
3866 + ]
3867 + }
3868 + ]
3869 +}
3870 +
3871 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3872 +|from|Дата начала запроса
3873 +|to|Дата  окончания
3874 +|vehicleId|ID объекта
3875 +|vehicleName|Имя объекта
3876 +|vehicleModel|Модель объекта
3877 +|penalty|Сумма штрафных баллов
3878 +|score|Оценка
3879 +|totalViolations|Суммарное количество нарушений
3880 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3881 +|overspeedingViolations|Превышение скорости
3882 +|accelerationViolations|Ускорение
3883 +|brakingViolations|Торможение
3884 +|turningViolations|Резкий поворот
3885 +|dangerousDrivingViolations|Резкое вождение
3886 +|sensorViolations|Нарушение по датчику
3887 +|moveTime|Время в движении
3888 +|mileage|Пробег
3889 +|tripsCount|Количество рейсов
3890 +|motohours|Моточасы
3891 +|maxSpeed|Максимальная скорость
3892 +|startAddress|Адрес начала рейса
3893 +|endAddress|Адрес окончания рейса
3894 +|drivers|Список водителей, которые были на объекте в течениии рейса
3895 +|driverGuid|Guid водителя
3896 +|driverName|Имя водителя
3897 +|driverRfid|Номер Карты-метки
3898 +
2650 2650  (% class="box" lang="en-US" style="text-align: center;" %)
2651 2651  (((
2652 2652  (% 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 г.