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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,7 +40,6 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,6 +55,15 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 +
63 +(% class="wikigeneratedid" %)
64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
65 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
105 + "agentId": "",  (%%)
106 + "parentId": "",
107 + "parentName": "string",
108 + "name": "string",
109 + "fullName": "string",
110 + "agentInfoType": 0,
111 + "isForeign": true/false,
112 + "district": "string", 
113 + "region": "string",
114 + "city": "string",
115 + "inn": "string",
116 + "kpp": "string",
117 + "address": "string",
118 + "addressFact": "string",
119 + "email": "string",
120 + "director": "string",
121 + "bankName": "string",
122 + "bankBIK": "string",
123 + "bankRS": "string",
124 + "bankKS": "string"
118 118   }
119 119  
127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
128 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
129 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
130 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
131 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
132 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
133 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
134 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
135 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
136 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
137 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
138 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
139 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
140 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
141 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
142 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
143 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
144 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
145 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
146 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
147 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
148 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
162 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
177 + "agentId": "",(% style="color:#000000" %)   (%%)
178 + "parentId": "",
179 + "name": "string",
180 + "fullName": "string",
181 + "agentInfoType": 0,
182 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
185 +
186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
187 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
188 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
189 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
190 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
191 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
192 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
193 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 +
220 220  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 +
362 +(% class="box warningmessage" %)
363 +(((
364 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 +)))
366 +
367 +Метод позволяет изменить статус клиента, указанного в запросе.
368 +
369 +В пути указывается GUID клиента и статус клиента.
370 +
371 +**status **- значение 0 - заблокирован, 1 - активен.
372 +
373 +Ответ: Code 204
374 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -363,7 +363,6 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 369  
... ... @@ -392,6 +392,7 @@
392 392  (% style="text-align:left" %)
393 393  (% style="color:#000000; font-weight:normal" %)}
394 394  
466 +
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
397 397  (% class="box infomessage" %)
... ... @@ -682,6 +682,249 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
757 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
758 +
759 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
760 +
761 +(% class="box infomessage" %)
762 +(((
763 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
764 +)))
765 +
766 +Метод возвращает полную информацию о модели объекта.
767 +
768 +(% style="color:#000000" %)Метод запроса: **GET**
769 +
770 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
771 +
772 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
773 +
774 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
775 +
776 +(% style="color:#000000" %)Ответ:
777 +
778 +(% style="color:#000000" %){
779 + "parentName": "string",
780 + "name": "string",
781 + "picture": "string",
782 + "minspeed": 0,
783 + "maxspeed": 0,
784 + "width": 0,
785 + "imbeddedtrailer": true,
786 + "hoppercapacity": 0,
787 + "hopperdischargespeed": 0,
788 + "modelType": 0,
789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
791 + "deleted": true
792 +}
793 +
794 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
795 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
796 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
797 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
798 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
799 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
800 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
801 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
802 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
804 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
805 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
806 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
807 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
808 +
809 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
810 +
811 +(% class="box successmessage" %)
812 +(((
813 +(% lang="en-US" %)**POST /api/v3/models/find**
814 +)))
815 +
816 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
817 +
818 +(% style="color:#000000" %)Метод запроса: **POST**
819 +
820 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
821 +
822 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
823 +
824 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
825 +
826 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
827 +}
828 +
829 +(% style="color:#000000" %)Ответ:
830 +
831 +(% style="color:#000000" %)[
832 + {
833 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
834 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
835 + "parentName": "string",
836 + "name": "string",
837 + "modelType": 0
838 + }
839 +]
840 +
841 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
842 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
844 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
845 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
846 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
847 +
848 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
849 +
850 +(% class="box successmessage" %)
851 +(((
852 +(% lang="en-US" %)**POST /api/v3/models**
853 +)))
854 +
855 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
856 +
857 +(% style="color:#000000" %)Метод запроса: **POST**
858 +
859 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
860 +
861 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
862 +
863 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
864 +
865 +{
866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
868 + "deleted": true,
869 + "extId": "string",
870 + "name": "string",
871 + "picture": "string",
872 + "minspeed": 0,
873 + "maxspeed": 0,
874 + "width": 0,
875 + "imbeddedtrailer": true,
876 + "fueloutlay": 0,
877 + "hoppercapacity": 0,
878 + "hopperdischargespeed": 0,
879 + "modelType": 0
880 +}
881 +
882 +Ответ:
883 +
884 +{
885 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
887 + "deleted": true,
888 + "extId": "string",
889 + "name": "string",
890 + "picture": "string",
891 + "minspeed": 0,
892 + "maxspeed": 0,
893 + "width": 0,
894 + "imbeddedtrailer": true,
895 + "hoppercapacity": 0,
896 + "hopperdischargespeed": 0,
897 + "modelType": 0
898 +}
899 +
900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
913 +
914 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
915 +
916 +(% class="box warningmessage" %)
917 +(((
918 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
919 +)))
920 +
921 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
922 +
923 +(% style="color:#000000" %)Метод запроса: **PUT**
924 +
925 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
926 +
927 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
928 +
929 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
930 +
931 +{
932 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
934 + "deleted": true,
935 + "extId": "string",
936 + "name": "string",
937 + "picture": "string",
938 + "minspeed": 0,
939 + "maxspeed": 0,
940 + "width": 0,
941 + "imbeddedtrailer": true,
942 + "fueloutlay": 0,
943 + "hoppercapacity": 0,
944 + "hopperdischargespeed": 0,
945 + "modelType": 0
946 +}
947 +
948 +Ответ:
949 +
950 +{
951 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
952 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
953 + "deleted": true,
954 + "extId": "string",
955 + "name": "string",
956 + "picture": "string",
957 + "minspeed": 0,
958 + "maxspeed": 0,
959 + "width": 0,
960 + "imbeddedtrailer": true,
961 + "fueloutlay": 0,
962 + "hoppercapacity": 0,
963 + "hopperdischargespeed": 0,
964 + "modelType": 0
965 +}
966 +
967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 +
981 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
982 +
983 +(% class="box errormessage" %)
984 +(((
985 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
986 +)))
987 +
988 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
989 +
990 +(% style="color:#000000" %)Метод запроса: **DELETE**
991 +
992 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
993 +
994 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
995 +
996 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
997 +
998 +Ответ: В случае успеха **Success 200**
999 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1116,7 +1116,7 @@
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1434 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1490,7 +1490,7 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1808 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
1891 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1892 +
1893 +(% class="box infomessage" style="text-align: left;" %)
1894 +(((
1895 +**POST /api/v3/terminalMessages/mapping**
1896 +)))
1897 +
1898 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1899 +
1900 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1901 +
1902 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1903 +
1904 +{
1905 + "protocolType": 0,
1906 + "params": ["string"]
1907 +}
1908 +
1909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1910 +|protocolType|ID типа протокола
1911 +|params|(((
1912 +Массив наименований параметров в сообщении
1913 +)))
1914 +
1915 +Ответ:
1916 +
1917 +{
1918 + "protocolType": 0,
1919 + "mapping": {
1920 + "additionalProp1": {
1921 + "inputType": 0,
1922 + "inputNumber": 0
1923 + },
1924 + "additionalProp2": {
1925 + "inputType": 0,
1926 + "inputNumber": 0
1927 + }
1928 + }
1929 +}
1930 +
1931 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1932 +|protocolType|Тип протокола
1933 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1934 +|inputNumber|(((
1935 +Номер входа
1936 +)))
1937 +
1938 +(% class="wikigeneratedid" %)
1939 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
1940 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
1965 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1966 +|vehicleId|ID объекта
1967 +|from|Дата и время начала периода запроса
1968 +|to|Дата и время окончания периода запроса
1969 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,25 +1603,43 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1976 + "deviceTime": "2023-11-29T07:40:44.052Z",
1977 + "serverTime": "2023-11-29T07:40:44.052Z",
1978 + "speed": 0,
1979 + "altitude": 0,
1980 + "latitude": 0,
1981 + "longitude": 0,
1982 + "satellites": 0,
1983 + "course": 0,
1984 + "voltage": 0,
1985 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1990 + "photoCount": 0,
1991 + "lbsCorrectedCoords": true,
1992 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1998 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1999 +|deviceTime|Время сообщения терминала
2000 +|serverTime|Время когда сообщение поступило на сервер
2001 +|speed|Скорость
2002 +|altitude|Высота над уровнем моря
2003 +|latitude|Широта
2004 +|longitude|Долгота
2005 +|satellites|Кол-во спутников
2006 +|course|Курс
2007 +|voltage|Бортовое напряжение
2008 +|parameters|Список параметров и их значений
2009 +|photoCount|Количество фото
2010 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2011 +|protocolType|ID типа протокола
2012 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1755,6 +1755,129 @@
1755 1755   }
1756 1756  ]
1757 1757  
2146 +
2147 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2148 +
2149 +(% class="box infomessage" %)
2150 +(((
2151 +**POST /api/v3/vehicles/moveStop**
2152 +)))
2153 +
2154 +Метод запроса: **POST**
2155 +
2156 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2157 +
2158 +В заголовках запроса: X-Auth: Токен авторизации
2159 +
2160 +
2161 +Тело запроса:
2162 +
2163 +{
2164 +
2165 + "vehicleIds": [ ], ~/~/ Список ID объектов
2166 +
2167 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2168 +
2169 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2170 +
2171 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2172 +
2173 +}
2174 +
2175 +Ответ:
2176 +
2177 +[
2178 +
2179 + {
2180 +
2181 + "vehicleId": 0, ~/~/ ID объекта
2182 +
2183 + "vehicleName": "string", ~/~/ Имя объекта
2184 +
2185 + "moves": [ ~/~/ Событие движения
2186 +
2187 + {
2188 +
2189 + "mileage": 0, ~/~/ Пробег, км
2190 +
2191 + "eventId": 0, ~/~/ Идентификатор события
2192 +
2193 + "eventName": "string", ~/~/ Название события
2194 +
2195 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2196 +
2197 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2198 +
2199 + "duration": 0 ~/~/ Продолжительность события, секунд
2200 +
2201 + }
2202 +
2203 + ],
2204 +
2205 + "stops": [ ~/~/ События стоянок
2206 +
2207 + {
2208 +
2209 + "address": "string", ~/~/ Адрес события
2210 +
2211 + "eventId": 0, ~/~/ Идентификатор события
2212 +
2213 + "eventName": "string", ~/~/ Название события
2214 +
2215 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2216 +
2217 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2218 +
2219 + "duration": 0 ~/~/ Продолжительность события, секунд
2220 +
2221 +
2222 + }
2223 +
2224 + ]
2225 +
2226 + }
2227 +
2228 +]
2229 +
2230 +
2231 +
2232 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2233 +
2234 +(% class="box infomessage" %)
2235 +(((
2236 +**POST /api/v3/vehicles/getlastdata**
2237 +)))
2238 +
2239 +Метод запроса: **POST**
2240 +
2241 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2242 +
2243 +В заголовках запроса: X-Auth: Токен авторизации
2244 +
2245 +
2246 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2247 +
2248 +Ответ:
2249 + {
2250 + "vehicleId": 0, ~/~/Идентификатор объекта.
2251 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2252 + "vehicleNumber": "string",~/~/Номер объекта.
2253 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2254 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2255 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2256 + "speed": 0,~/~/Скорость объекта.
2257 + "course": 0,~/~/Курс движения [0;360]
2258 + "latitude": 0,~/~/Широта [-90°;90°].
2259 + "longitude": 0,~/~/Долгота [-180°;180°].
2260 + "address": "string",~/~/Адрес.
2261 + "geozones": [ ~/~/Сведения по геозонам.
2262 + {
2263 + "id": 0,
2264 + "name": "string"
2265 + }
2266 +
2267 +
2268 +
1758 1758  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1759 1759  
1760 1760  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2653,6 +2653,83 @@
2653 2653  Success
2654 2654  
2655 2655  
3167 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3168 +
3169 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3170 +
3171 +(% class="box infomessage" %)
3172 +(((
3173 +**POST /api/v3/Trailers**
3174 +)))
3175 +
3176 +Пример запроса:
3177 +
3178 +{
3179 + "startDate": "2023-11-14T10:48:03.671Z",
3180 + "endDate": "2023-11-14T10:48:03.671Z",
3181 + "ids": [ 0 ],
3182 + "timezone": 0
3183 +}
3184 +
3185 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3186 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3187 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3188 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3189 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3190 +
3191 +Пример ответа:
3192 +
3193 +[
3194 + {
3195 + "SD": "2023-11-14T10:48:03.717Z",
3196 + "ED": "2023-11-14T10:48:03.717Z", 
3197 + "id": 0,
3198 + "SLat": 0,
3199 + "SLon": 0,
3200 + "ELat": 0,
3201 + "ELon": 0,
3202 + "mileage": 0
3203 + "Duration": 0
3204 + "Address": "string",
3205 + "Address2": "string",
3206 + "name": "string",
3207 + "rid": "string",
3208 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 + "trailer": {
3210 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 + "Number": "string",
3212 + "Description": "string",
3213 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 + "ExternalID": "string",
3215 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 + "CreateTime": "2023-11-14T10:48:03.717Z",
3217 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3218 + "IsDeleted": true
3219 + },
3220 + "filesCount": 0,
3221 + }
3222 +]
3223 +
3224 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3225 +|SD|Дата и время начала события
3226 +|ED|Дата и время окончания события
3227 +|id|ID объекта
3228 +|SLat|Широта начальной координаты
3229 +|SLon|Долгота начальной координаты
3230 +|ELat|Широта конечной координаты
3231 +|ELon|Долгота конечной координаты
3232 +|mileage|Пробег
3233 +|Duration|Продолжительность
3234 +|Address|Адрес начального местоположения
3235 +|Address2|Адрес конечного местоположения
3236 +|name|Имя радиометки
3237 +|rid|Номер радиометки
3238 +|rguid|ID радиометки
3239 +|trailer|Информация об агрегате
3240 +|ModelGuid|ID агрегата
3241 +|Number|Название/номер агрегата
3242 +|Description|Текст примечания агрегата
3243 +
2656 2656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2657 2657  
2658 2658  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2674,13 +2674,18 @@
2674 2674   {
2675 2675   "name": "string",
2676 2676   "number": 0,
2677 - "period": 0, ~/~/ Частота трансляции радиометки
3265 + "period": 0,
2678 2678   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2679 2679   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 - "deleted": true
2681 2681   }
2682 2682  ]
2683 2683  
3271 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3272 +|parentId|ID клиента
3273 +|name|Название карты-метки
3274 +|number|Номер
3275 +|period|Период запросов в секундах (работает только для агрегатов)
3276 +|id|ID карты-метки
2684 2684  
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
... ... @@ -2697,13 +2697,18 @@
2697 2697   {
2698 2698   "name": "string",
2699 2699   "number": 0,
2700 - "period": 0, ~/~/ Частота трансляции радиометки
3293 + "period": 0,
2701 2701   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 2702   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 - "deleted": true
2704 2704   }
2705 2705  ]
2706 2706  
3299 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3300 +|name|Название карты-метки
3301 +|number|Номер
3302 +|period|Период запросов в секундах (работает только для агрегатов)
3303 +|id|ID карты-метки
3304 +|parentId|ID клиента
2707 2707  
2708 2708  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2709 2709  
... ... @@ -2719,7 +2719,6 @@
2719 2719   "number": 0,
2720 2720   "period": 0,
2721 2721   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "deleted": true
2723 2723  }
2724 2724  
2725 2725  Ответ:
... ... @@ -2730,9 +2730,14 @@
2730 2730   "period": 0,
2731 2731   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2732 2732   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 - "deleted": true
2734 2734  }
2735 2735  
3332 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3333 +|name|Название карты-метки
3334 +|number|Номер
3335 +|period|Период запросов в секундах (работает только для агрегатов)
3336 +|id|ID карты-метки
3337 +|parentId|ID клиента
2736 2736  
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
... ... @@ -2749,7 +2749,6 @@
2749 2749   "period": 0,
2750 2750   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 2751   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "deleted": true
2753 2753  }
2754 2754  
2755 2755  Ответ:
... ... @@ -2760,9 +2760,14 @@
2760 2760   "period": 0,
2761 2761   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 2762   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 - "deleted": true
2764 2764  }
2765 2765  
3366 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3367 +|name|Название карты-метки
3368 +|number|Номер
3369 +|period|Период запросов в секундах (работает только для агрегатов)
3370 +|id|ID карты-метки
3371 +|parentId|ID клиента
2766 2766  
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
... ... @@ -2771,7 +2771,7 @@
2771 2771  **DELETE /api/v3/Rfids/{rfidGuid}**
2772 2772  )))
2773 2773  
2774 -Передаем параметр rfidGuid - идентификатор карты-метки
3380 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2775 2775  
2776 2776  Ответ:
2777 2777  
... ... @@ -2778,6 +2778,937 @@
2778 2778  Success
2779 2779  
2780 2780  
3387 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3388 +
3389 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3390 +
3391 +(% class="box infomessage" %)
3392 +(((
3393 +**GET /api/v3/Billing/client/balance/{clientId}**
3394 +)))
3395 +
3396 +Параметр запроса: **clientId **- идентификатор клиента.
3397 +
3398 +Ответ:
3399 +
3400 +{
3401 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3402 + "Balance": 0
3403 +}
3404 +
3405 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3406 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3407 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3408 +
3409 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3410 +
3411 +(% class="box infomessage" %)
3412 +(((
3413 +**GET /api/v3/Billing/client/constraint/{clientId}**
3414 +)))
3415 +
3416 +Параметр запроса: **clientId **- идентификатор клиента.
3417 +
3418 +Ответ:
3419 +
3420 +{
3421 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3422 + "CalculationType": 0,
3423 + "PermissibleBalance": 0,
3424 + "DefermentDays": 0,
3425 + "SendUiNotifications": true,
3426 + "SendEmailNotifications": true,
3427 + "IsPrivate": true,
3428 +}
3429 +
3430 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3431 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3432 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3433 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3434 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3435 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3436 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3437 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3438 +
3439 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3440 +
3441 +(% class="box infomessage" %)
3442 +(((
3443 +**GET /api/v3/Billing/client/plan/{clientId}**
3444 +)))
3445 +
3446 +Параметры запроса:
3447 +
3448 +**clientId **- идентификатор клиента.
3449 +
3450 +**planId **- идентификатор тарифного плана.
3451 +
3452 +Ответ:
3453 +
3454 +{
3455 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3456 + "Plan": { **~/~/ Описание тарифного плана**
3457 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3458 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3459 + "Name": "string",
3460 + "IsArchived": true,
3461 + "Constraint": {
3462 + "CalculationType": 0,
3463 + "PermissibleBalance": 0,
3464 + "DefermentDays": 0
3465 + },
3466 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3467 + {
3468 + "Feature": "string",
3469 + "IsFactual": true,
3470 + "Limit": 0,
3471 + "Price": 0,
3472 + "PeriodValue": 0,
3473 + "PeriodType": 0
3474 + }
3475 + ]
3476 + },
3477 + "DebitDate": "2023-10-18T12:46:24.213Z",
3478 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3479 + {
3480 + "Feature": "string",
3481 + "IsEnabled": true,
3482 + "IsPrivate": true,
3483 + "IsFactual": true,
3484 + "Limit": 0,
3485 + "Price": 0,
3486 + "DebitDate": "2023-10-18T12:46:24.213Z",
3487 + "PeriodValue": 0,
3488 + "PeriodType": 0
3489 + }
3490 + ]
3491 +}
3492 +
3493 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3494 +|ClientId|Идентификатор клиента
3495 +|Id|Идентификатор тарифного плана
3496 +|OwnerId|Идентификатор клиента-владельца
3497 +|Name|Наименование тарифного плана
3498 +|IsArchived|Признак, определяющий архивный тарифный план
3499 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3500 +|PermissibleBalance|Допустимый баланс
3501 +|DefermentDays|Отсрочка, количество дней
3502 +|Feature|Код услуги
3503 +|IsEnabled|Признак, определяющий активирована ли услуга
3504 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3505 +|IsFactual|Признак, определяющий расчёт по факту
3506 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3507 +|Price|Цена за единицу.
3508 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3509 +|PeriodValue|Значение периода.
3510 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3511 +
3512 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3513 +
3514 +(% class="box infomessage" %)
3515 +(((
3516 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3517 +)))
3518 +
3519 +Параметр запроса: **clientId **- идентификатор клиента.
3520 +
3521 +Ответ:
3522 +
3523 +[
3524 + {
3525 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3526 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3527 + "Name": "string",
3528 + "IsArchived": true,
3529 + "Constraint": {
3530 + "CalculationType": 0,
3531 + "PermissibleBalance": 0,
3532 + "DefermentDays": 0
3533 + },
3534 + "Features": [
3535 + {
3536 + "Feature": "string",
3537 + "IsFactual": true,
3538 + "Limit": 0,
3539 + "Price": 0,
3540 + "PeriodValue": 0,
3541 + "PeriodType": 0
3542 + }
3543 + ]
3544 + }
3545 +]
3546 +
3547 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3548 +|ClientId|Идентификатор клиента
3549 +|Id|Идентификатор тарифного плана
3550 +|OwnerId|Идентификатор клиента-владельца
3551 +|Name|Наименование тарифного плана
3552 +|IsArchived|Признак, определяющий архивный тарифный план
3553 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3554 +|PermissibleBalance|Допустимый баланс
3555 +|DefermentDays|Отсрочка, количество дней
3556 +|Feature|Код услуги
3557 +|IsFactual|Признак, определяющий расчёт по факту
3558 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3559 +|Price|Цена за единицу.
3560 +|PeriodValue|Значение периода.
3561 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3562 +
3563 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3564 +
3565 +(% class="box infomessage" %)
3566 +(((
3567 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3568 +)))
3569 +
3570 +Параметр запроса: **clientId **- идентификатор клиента.
3571 +
3572 +Ответ:
3573 +
3574 +[
3575 + {
3576 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3577 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3578 + "Name": "string",
3579 + "IsArchived": true,
3580 + "Constraint": {
3581 + "CalculationType": 0,
3582 + "PermissibleBalance": 0,
3583 + "DefermentDays": 0
3584 + },
3585 + "Features": [
3586 + {
3587 + "Feature": "string",
3588 + "IsFactual": true,
3589 + "Limit": 0,
3590 + "Price": 0,
3591 + "PeriodValue": 0,
3592 + "PeriodType": 0
3593 + }
3594 + ]
3595 + }
3596 +]
3597 +
3598 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3599 +|ClientId|Идентификатор клиента
3600 +|Id|Идентификатор тарифного плана
3601 +|OwnerId|Идентификатор клиента-владельца
3602 +|Name|Наименование тарифного плана
3603 +|IsArchived|Признак, определяющий архивный тарифный план
3604 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3605 +|PermissibleBalance|Допустимый баланс
3606 +|DefermentDays|Отсрочка, количество дней
3607 +|Feature|Код услуги
3608 +|IsFactual|Признак, определяющий расчёт по факту
3609 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3610 +|Price|Цена за единицу.
3611 +|PeriodValue|Значение периода.
3612 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3613 +
3614 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3615 +
3616 +(% class="box warningmessage" %)
3617 +(((
3618 +**PUT /api/v3/Billing/client/balance**
3619 +)))
3620 +
3621 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3622 +
3623 +Тело запроса:
3624 +
3625 +{
3626 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 + "Balance": 0
3628 +}
3629 +
3630 +Ответ: Success
3631 +
3632 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3633 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3634 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3635 +
3636 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3637 +
3638 +(% class="box warningmessage" %)
3639 +(((
3640 +**PUT /api/v3/billing/client/balance/deposit**
3641 +)))
3642 +
3643 +Создает операцию **Пополнение **с указанной суммой
3644 +
3645 +Тело запроса:
3646 +
3647 +{
3648 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3649 + "Balance": 0
3650 +}
3651 +
3652 +Ответ: Success
3653 +
3654 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3655 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3656 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3657 +
3658 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3659 +
3660 +Создает операцию **Списание **с указанной суммой
3661 +
3662 +(% class="box warningmessage" %)
3663 +(((
3664 +**PUT /api/v3/billing/client/balance/withdraw**
3665 +)))
3666 +
3667 +Тело запроса:
3668 +
3669 +{
3670 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3671 + "Balance": 0
3672 +}
3673 +
3674 +Ответ: Success
3675 +
3676 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3677 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3678 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3679 +
3680 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3681 +
3682 +(% class="box warningmessage" %)
3683 +(((
3684 +**PUT /api/v3/Billing/client/constraint**
3685 +)))
3686 +
3687 +Тело запроса:
3688 +
3689 +{
3690 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3691 + "CalculationType": 0,
3692 + "PermissibleBalance": 0,
3693 + "DefermentDays": 0,
3694 + "SendUiNotifications": true,
3695 + "SendEmailNotifications": true,
3696 + "IsPrivate": true,
3697 +}
3698 +
3699 +Ответ: Success
3700 +
3701 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3702 +|ClientId|Идентификатор клиента
3703 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3704 +|PermissibleBalance|Допустимый баланс
3705 +|DefermentDays|(((
3706 +Отсрочка, количество дней
3707 +)))
3708 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3709 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3710 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3711 +
3712 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3713 +
3714 +(% class="box warningmessage" %)
3715 +(((
3716 +**PUT /api/v3/Billing/client/plan**
3717 +)))
3718 +
3719 +Тело запроса:
3720 +
3721 +{
3722 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3723 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3724 + "Features": [
3725 + {
3726 + "Feature": "string",
3727 + "IsEnabled": true,
3728 + "IsFactual": true,
3729 + "Limit": 0,
3730 + "Price": 0,
3731 + "DebitDate": "2023-10-18T13:26:58.987Z",
3732 + "PeriodValue": 0,
3733 + "PeriodType": 0
3734 + }
3735 + ]
3736 +}
3737 +
3738 +Ответ: Success
3739 +
3740 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3741 +|ClientId|Идентификатор клиента
3742 +|PlanId|Идентификатор тарифного плана
3743 +|Feature|Код услуги
3744 +|IsEnabled|Признак, определяющий активирована ли услуга
3745 +|IsFactual|Признак, определяющий расчёт по факту
3746 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3747 +|Price|Цена за единицу.
3748 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3749 +|PeriodValue|Значение периода.
3750 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3751 +
3752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3753 +
3754 +(% class="box warningmessage" %)
3755 +(((
3756 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3757 +)))
3758 +
3759 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3760 +
3761 +(% class="box infomessage" %)
3762 +(((
3763 +**POST /api/v3/vehicles/import/{agentId}**
3764 +)))
3765 +
3766 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3767 +
3768 +В пути указывается **agentId** - id клиента.
3769 +
3770 +**Заголовок**
3771 +
3772 +**X-Auth: [токен авторизации]**
3773 +
3774 +**Параметры**
3775 +
3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3778 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3779 +
3780 +В теле использовать тип **form-data,** тип значения** file**
3781 +
3782 +**Ключи**
3783 +
3784 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3785 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3786 +|csv|В значении передаем файл датчиков, формат **csv**
3787 +
3788 +Ответ:
3789 +
3790 +{
3791 + "vehicleId": 0,
3792 + "name": "string",
3793 + "errors": ["string"]
3794 +}
3795 +
3796 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3797 +|vehicleId|ID созданного объекта
3798 +|name|Имя созданного объекта
3799 +|errors|Ошибки и их описание
3800 +
3801 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3802 +
3803 +(% class="box infomessage" %)
3804 +(((
3805 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3806 +)))
3807 +
3808 +(% class="wikigeneratedid" %)
3809 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3810 +
3811 +(% class="wikigeneratedid" %)
3812 +В пути указывается **vehicleId **- id объекта.
3813 +
3814 +**Заголовок**
3815 +
3816 +**X-Auth: [токен авторизации]**
3817 +
3818 +В теле использовать тип **form-data.**
3819 +
3820 +Ключи:
3821 +
3822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3823 +|**history**|В значении передавать файл с историей
3824 +
3825 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3826 +
3827 +Ответ:
3828 +
3829 +{
3830 + "results": [
3831 + {
3832 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3833 + "vehicleId": 0,
3834 + "errors": [
3835 + "string"
3836 + ],
3837 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3838 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3839 + "producedCount": 0,
3840 + "msgCount": 0
3841 + }
3842 + ]
3843 +}
3844 +
3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 +|results|Результаты импорта в разрезе ТС
3847 +|vehicleGuid|Guid ТС
3848 +|vehicleId|ID ТС
3849 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3850 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3851 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3852 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3853 +|msgCount|Кол-во обработанных сообщений всего
3854 +
3855 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3856 +
3857 +(% class="box infomessage" %)
3858 +(((
3859 +**GET /api/v3/vehicles/import/history/status**
3860 +)))
3861 +
3862 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3863 +
3864 +Ответ:
3865 +
3866 +{
3867 + "activity": true,
3868 + "progress": 0,
3869 + "message": "string"
3870 +}
3871 +
3872 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3873 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3874 +|progress|Guid ТС
3875 +
3876 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3877 +
3878 +(% class="box infomessage" %)
3879 +(((
3880 +**POST /api/v3/vehicles/export**
3881 +)))
3882 +
3883 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3884 +
3885 +Тело запроса:
3886 +
3887 +[
3888 + id
3889 +]
3890 +
3891 +Ответ: Success 200, получаете файлы с настройками.
3892 +
3893 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3894 +
3895 +(% class="box infomessage" %)
3896 +(((
3897 +**POST /api/v3/vehicles/export/history**
3898 +)))
3899 +
3900 +Метод возвращает список сообщений терминала объекта за выбранный период.
3901 +
3902 +Тело запроса:
3903 +
3904 +{
3905 + "vehicleId": 0,
3906 + "asArchive": true,
3907 + "from": "2023-09-27T12:17:45.973Z",
3908 + "to": "2023-09-27T12:17:45.973Z"
3909 +}
3910 +
3911 +Ответ:
3912 +
3913 +Получаете файл. Сообщение: Code 200/Success
3914 +
3915 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3916 +|vehicleId|ID объекта
3917 +|asArchive|true - Архивировать файл, False - не архивировать
3918 +|from|Дата и время начала запроса
3919 +|to|Дата и время окончания запроса
3920 +
3921 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3922 +
3923 +(% class="box infomessage" %)
3924 +(((
3925 +**GET /api/v3/vehicles/export/history/status**
3926 +)))
3927 +
3928 +Метод возвращает список сообщений терминала объекта за выбранный период.
3929 +
3930 +Ответ:
3931 +
3932 +{
3933 + "activity": true,
3934 + "progress": 0,
3935 + "message": "string"
3936 +}
3937 +
3938 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3939 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3940 +|progress|Прогресс экспорта, от 0 до 100%
3941 +|message|Текст описывающий статус
3942 +
3943 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3944 +
3945 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3946 +
3947 +(% class="box infomessage" %)
3948 +(((
3949 +**POST /api/v3/EcoDriving/rating**
3950 +)))
3951 +
3952 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3953 +
3954 +Тело запроса:
3955 +
3956 +{
3957 + "vehicleIds": [vehicleId],
3958 + "from": "2023-11-22T09:29:48.051Z",
3959 + "to": "2023-11-22T09:29:48.051Z"
3960 +}
3961 +
3962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3963 +|vehicleIds|Массив ID объектов
3964 +|from|Дата начала запроса
3965 +|to|Дата окончания запроса
3966 +
3967 +Ответ:
3968 +
3969 +{
3970 + "items": [
3971 + {
3972 + "from": "2023-11-22T09:29:48.052Z",
3973 + "to": "2023-11-22T09:29:48.052Z",
3974 + "vehicleId": 0,
3975 + "vehicleName": "string",
3976 + "vehicleModel": "string",
3977 + "penalty": 0,
3978 + "score": 0,
3979 + "totalViolations": 0,
3980 + "violationsByType": {
3981 + "overspeedingViolations": 0,
3982 + "accelerationViolations": 0,
3983 + "brakingViolations": 0,
3984 + "turningViolations": 0,
3985 + "dangerousDrivingViolations": 0,
3986 + "sensorViolations": 0
3987 + },
3988 + "moveTime": 0,
3989 + "mileage": 0,
3990 + "tripsCount": 0,
3991 + "trips": [
3992 + {
3993 + "penalty": 0,
3994 + "score": 0,
3995 + "violationsCount": 0,
3996 + "violationsByType": {
3997 + "overspeedingViolations": 0,
3998 + "accelerationViolations": 0,
3999 + "brakingViolations": 0,
4000 + "turningViolations": 0,
4001 + "dangerousDrivingViolations": 0,
4002 + "sensorViolations": 0
4003 + },
4004 + "moveTime": 0,
4005 + "mileage": 0,
4006 + "motohours": 0,
4007 + "maxSpeed": 0,
4008 + "startAddress": "string",
4009 + "endAddress": "string",
4010 + "drivers": [
4011 + {
4012 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4013 + "driverName": "string",
4014 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4015 + }
4016 + ]
4017 + }
4018 + ]
4019 + }
4020 + ]
4021 +}
4022 +
4023 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4024 +|from|Дата начала запроса
4025 +|to|Дата  окончания
4026 +|vehicleId|ID объекта
4027 +|vehicleName|Имя объекта
4028 +|vehicleModel|Модель объекта
4029 +|penalty|Сумма штрафных баллов
4030 +|score|Оценка
4031 +|totalViolations|Суммарное количество нарушений
4032 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4033 +|overspeedingViolations|Превышение скорости
4034 +|accelerationViolations|Ускорение
4035 +|brakingViolations|Торможение
4036 +|turningViolations|Резкий поворот
4037 +|dangerousDrivingViolations|Резкое вождение
4038 +|sensorViolations|Нарушение по датчику
4039 +|moveTime|Время в движении
4040 +|mileage|Пробег
4041 +|tripsCount|Количество рейсов
4042 +|motohours|Моточасы
4043 +|maxSpeed|Максимальная скорость
4044 +|startAddress|Адрес начала рейса
4045 +|endAddress|Адрес окончания рейса
4046 +|drivers|Список водителей, которые были на объекте в течениии рейса
4047 +|driverGuid|Guid водителя
4048 +|driverName|Имя водителя
4049 +|driverRfid|Номер Карты-метки
4050 +
4051 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4052 +
4053 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4054 +
4055 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4056 +
4057 +(% class="box infomessage" %)
4058 +(((
4059 +POST /api/v3/fuelcards/transactions
4060 +)))
4061 +
4062 +Метод запроса: POST
4063 +
4064 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4065 +\\В заголовках запроса: X-Auth: Токен авторизации
4066 +
4067 +Параметры в теле запроса (JSON):
4068 +
4069 +{
4070 +
4071 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4072 +
4073 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4074 +
4075 + "ids": [
4076 +
4077 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4078 +
4079 + ],
4080 +
4081 + "timezone": 0 ~/~/Таймзона
4082 +
4083 +}
4084 +
4085 +Ответ:
4086 +
4087 + {
4088 +
4089 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4090 +
4091 + "driver": "string", ~/~/Водители, привязанные к ТК
4092 +
4093 + "object": "string", ~/~/Наименование ТС
4094 +
4095 + "amount": 0, ~/~/Количество топлива
4096 +
4097 + "amountDut": 0, ~/~/Количество по ДУТ
4098 +
4099 + "amountDiff": 0, ~/~/Разница, л
4100 +
4101 + "amountDiffPerc": 0, ~/~/Разница, %
4102 +
4103 + "summa": 0, ~/~/Стоимость, руб
4104 +
4105 + "serviceName": "string", ~/~/Тип топлива
4106 +
4107 + "price": 0, ~/~/Цена за литр, руб
4108 +
4109 + "cardName": "string", ~/~/Наименование ТК
4110 +
4111 + "cardNum": "string", ~/~/Номер ТК
4112 +
4113 + "operator": "string", ~/~/Оператор ТК
4114 +
4115 + "address": "string" ~/~/Адрес АЗС
4116 +
4117 + }
4118 +
4119 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4120 +
4121 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4122 +
4123 +
4124 +(% class="box infomessage" %)
4125 +(((
4126 +GET api/v3/Vehicles/recyclebin/all
4127 +)))
4128 +
4129 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4130 +
4131 +Параметр запроса: {parentId} - идентификатор агента
4132 +
4133 +В заголовках запроса: X-Auth: Токен авторизации
4134 +
4135 +Ответ:
4136 +
4137 +[
4138 +
4139 + {
4140 +
4141 + "recordTime": "", ~/~/Время записи
4142 +
4143 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4144 +
4145 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4146 +
4147 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4148 +
4149 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4150 +
4151 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4152 +
4153 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4154 +
4155 + "items": [ ~/~/ [
4156 +
4157 +nullable: true ~/~/Детали
4158 +
4159 + {
4160 +
4161 + "name": "string", ~/~/наименование столбца
4162 +
4163 + "value": "string" ~/~/содержание столбца
4164 +
4165 + }
4166 +
4167 + ]
4168 +
4169 + },
4170 +
4171 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4172 +
4173 + "string"
4174 +
4175 + ]
4176 +
4177 + }
4178 +
4179 +]
4180 +
4181 +
4182 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4183 +
4184 +(% class="box infomessage" %)
4185 +(((
4186 +POST/api/v3/Vehicles/recyclebin/erase
4187 +)))
4188 +
4189 +В заголовках запроса: X-Auth: Токен авторизации
4190 +
4191 +Пример запроса:
4192 +
4193 +
4194 +[
4195 +
4196 + 0
4197 +
4198 +]
4199 +
4200 +
4201 +Пример ответа:
4202 +
4203 +[
4204 +
4205 + {
4206 +
4207 + "recordTime": "", ~/~/Время записи
4208 +
4209 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4210 +
4211 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4212 +
4213 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4214 +
4215 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4216 +
4217 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4218 +
4219 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4220 +
4221 + "items": [ ~/~/Детали
4222 +
4223 + {
4224 +
4225 + "name": "", ~/~/Имя свойства
4226 +
4227 + "value": "" ~/~/Значение свойства
4228 +
4229 + }
4230 +
4231 + ]
4232 +
4233 + },
4234 +
4235 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4236 +
4237 + ""
4238 +
4239 + ]
4240 +
4241 + }
4242 +
4243 +]
4244 +
4245 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4246 +
4247 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4248 +
4249 +(% class="box infomessage" %)
4250 +(((
4251 +POST/api/v3/Vehicles/recyclebin/restore
4252 +)))
4253 +
4254 +В заголовках запроса: X-Auth: Токен авторизации
4255 +
4256 +Параметры в теле запроса (JSON):
4257 +
4258 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4259 +
4260 +В заголовках запроса: X-Auth: Токен авторизации
4261 +
4262 +
4263 +Пример запроса:
4264 +
4265 +[
4266 +
4267 + 0
4268 +
4269 +]
4270 +
4271 +
4272 +Пример ответа:
4273 +
4274 +[
4275 +
4276 + {
4277 +
4278 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4279 +
4280 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4281 +
4282 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4283 +
4284 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4285 +
4286 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4287 +
4288 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4289 +
4290 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4291 +
4292 + "items": [ ~/~/Детали
4293 +
4294 + {
4295 +
4296 + "name": "string", ~/~/Имя свойства
4297 +
4298 + "value": "string" ~/~/Значение свойства
4299 +
4300 + }
4301 +
4302 + ]
4303 +
4304 + },
4305 +
4306 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4307 +
4308 + "string"
4309 +
4310 + ]
4311 +
4312 + }
4313 +
4314 +]
4315 +
4316 +
4317 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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