Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 98.1 >
edited by Илья Крайнов
on 2023/06/30 15:51
To version < 129.1 >
edited by Михаил Жучков
on 2023/12/25 17:53
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
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,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 - Отказ)
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "name": "string",
177 + "fullName": "string",
178 + "agentInfoType": 0,
179 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
182 +
183 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 +
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", ~/~/ идентификатор клиента-родителя 
209 + "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  
254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275 +
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  
357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358 +
359 +(% class="box warningmessage" %)
360 +(((
361 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 +)))
363 +
364 +Метод позволяет изменить статус клиента, указанного в запросе.
365 +
366 +В пути указывается GUID клиента и статус клиента.
367 +
368 +**status **- значение 0 - заблокирован, 1 - активен.
369 +
370 +Ответ: Code 204
371 +
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  
463 +
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  
754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
755 +
756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
757 +
758 +(% class="box infomessage" %)
759 +(((
760 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
761 +)))
762 +
763 +Метод возвращает полную информацию о модели объекта.
764 +
765 +(% style="color:#000000" %)Метод запроса: **GET**
766 +
767 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
768 +
769 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
770 +
771 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
772 +
773 +(% style="color:#000000" %)Ответ:
774 +
775 +(% style="color:#000000" %){
776 + "parentName": "string",
777 + "name": "string",
778 + "picture": "string",
779 + "minspeed": 0,
780 + "maxspeed": 0,
781 + "width": 0,
782 + "imbeddedtrailer": true,
783 + "hoppercapacity": 0,
784 + "hopperdischargespeed": 0,
785 + "modelType": 0,
786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788 + "deleted": true
789 +}
790 +
791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
792 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
793 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
794 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
795 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
796 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
799 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
801 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
804 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
805 +
806 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
807 +
808 +(% class="box successmessage" %)
809 +(((
810 +(% lang="en-US" %)**POST /api/v3/models/find**
811 +)))
812 +
813 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
814 +
815 +(% style="color:#000000" %)Метод запроса: **POST**
816 +
817 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
818 +
819 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
820 +
821 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
822 +
823 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
824 +}
825 +
826 +(% style="color:#000000" %)Ответ:
827 +
828 +(% style="color:#000000" %)[
829 + {
830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "parentName": "string",
833 + "name": "string",
834 + "modelType": 0
835 + }
836 +]
837 +
838 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
839 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
840 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
841 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
842 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
844 +
845 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
846 +
847 +(% class="box successmessage" %)
848 +(((
849 +(% lang="en-US" %)**POST /api/v3/models**
850 +)))
851 +
852 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
853 +
854 +(% style="color:#000000" %)Метод запроса: **POST**
855 +
856 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
857 +
858 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
859 +
860 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
861 +
862 +{
863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 + "deleted": true,
866 + "extId": "string",
867 + "name": "string",
868 + "picture": "string",
869 + "minspeed": 0,
870 + "maxspeed": 0,
871 + "width": 0,
872 + "imbeddedtrailer": true,
873 + "fueloutlay": 0,
874 + "hoppercapacity": 0,
875 + "hopperdischargespeed": 0,
876 + "modelType": 0
877 +}
878 +
879 +Ответ:
880 +
881 +{
882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
883 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
884 + "deleted": true,
885 + "extId": "string",
886 + "name": "string",
887 + "picture": "string",
888 + "minspeed": 0,
889 + "maxspeed": 0,
890 + "width": 0,
891 + "imbeddedtrailer": true,
892 + "hoppercapacity": 0,
893 + "hopperdischargespeed": 0,
894 + "modelType": 0
895 +}
896 +
897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 +
911 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 +
913 +(% class="box warningmessage" %)
914 +(((
915 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
916 +)))
917 +
918 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
919 +
920 +(% style="color:#000000" %)Метод запроса: **PUT**
921 +
922 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
923 +
924 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
925 +
926 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
927 +
928 +{
929 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 + "deleted": true,
932 + "extId": "string",
933 + "name": "string",
934 + "picture": "string",
935 + "minspeed": 0,
936 + "maxspeed": 0,
937 + "width": 0,
938 + "imbeddedtrailer": true,
939 + "fueloutlay": 0,
940 + "hoppercapacity": 0,
941 + "hopperdischargespeed": 0,
942 + "modelType": 0
943 +}
944 +
945 +Ответ:
946 +
947 +{
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
950 + "deleted": true,
951 + "extId": "string",
952 + "name": "string",
953 + "picture": "string",
954 + "minspeed": 0,
955 + "maxspeed": 0,
956 + "width": 0,
957 + "imbeddedtrailer": true,
958 + "fueloutlay": 0,
959 + "hoppercapacity": 0,
960 + "hopperdischargespeed": 0,
961 + "modelType": 0
962 +}
963 +
964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 +
978 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 +
980 +(% class="box errormessage" %)
981 +(((
982 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
983 +)))
984 +
985 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
986 +
987 +(% style="color:#000000" %)Метод запроса: **DELETE**
988 +
989 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
990 +
991 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
992 +
993 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
994 +
995 +Ответ: В случае успеха **Success 200**
996 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1255,7 +1255,7 @@
1255 1255  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1256 1256  
1257 1257  (% style="color:#000000" %){
1258 -
1570 + "vehicleId": , ~/~/ ID объекта
1259 1259   "parentId": "" , ~/~/ ID клиента
1260 1260   "name": "" , ~/~/ имя ТС
1261 1261   "imei": "" , ~/~/ IMEI
... ... @@ -1573,6 +1573,51 @@
1573 1573   }
1574 1574  ]
1575 1575  
1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 +
1890 +(% class="box infomessage" style="text-align: left;" %)
1891 +(((
1892 +**POST /api/v3/terminalMessages/mapping**
1893 +)))
1894 +
1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 +
1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 +
1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 +
1901 +{
1902 + "protocolType": 0,
1903 + "params": ["string"]
1904 +}
1905 +
1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 +|protocolType|ID типа протокола
1908 +|params|(((
1909 +Массив наименований параметров в сообщении
1910 +)))
1911 +
1912 +Ответ:
1913 +
1914 +{
1915 + "protocolType": 0,
1916 + "mapping": {
1917 + "additionalProp1": {
1918 + "inputType": 0,
1919 + "inputNumber": 0
1920 + },
1921 + "additionalProp2": {
1922 + "inputType": 0,
1923 + "inputNumber": 0
1924 + }
1925 + }
1926 +}
1927 +
1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 +|protocolType|Тип протокола
1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 +|inputNumber|Номер входа
1932 +
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  
1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 +|vehicleId|ID объекта
1959 +|from|Дата и время начала периода запроса
1960 +|to|Дата и время окончания периода запроса
1961 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,25 +1603,304 @@
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": { ~/~/ список параметров датчиков передаваемых терминалом
1968 + "deviceTime": "2023-11-29T07:40:44.052Z",
1969 + "serverTime": "2023-11-29T07:40:44.052Z",
1970 + "speed": 0,
1971 + "altitude": 0,
1972 + "latitude": 0,
1973 + "longitude": 0,
1974 + "satellites": 0,
1975 + "course": 0,
1976 + "voltage": 0,
1977 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1982 + "photoCount": 0,
1983 + "lbsCorrectedCoords": true,
1984 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 +|deviceTime|Время сообщения терминала
1992 +|serverTime|Время когда сообщение поступило на сервер
1993 +|speed|Скорость
1994 +|altitude|Высота над уровнем моря
1995 +|latitude|Широта
1996 +|longitude|Долгота
1997 +|satellites|Кол-во спутников
1998 +|course|Курс
1999 +|voltage|Бортовое напряжение
2000 +|parameters|Список параметров и их значений
2001 +|photoCount|Количество фото
2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 +|protocolType|ID типа протокола
2004 +
2005 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 +
2007 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2008 +
2009 +(% class="box infomessage" %)
2010 +(((
2011 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2012 +)))
2013 +
2014 +(% style="color:#000000" %)Метод запроса: **POST**
2015 +
2016 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2017 +
2018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2019 +
2020 +(% style="text-align:left" %)
2021 +Тело запроса:
2022 +
2023 +{
2024 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2025 + "vehicleIds": [0], ~/~/ Список ID объектов
2026 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2027 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2028 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2029 +}
2030 +
2031 +Ответ:
2032 +
2033 +[
2034 + {
2035 + "vehicleId": 0, ~/~/ ID объекта
2036 + "name": "string", ~/~/ Имя ТС
2037 + "periods": [ ~/~/ Периоды
2038 + {
2039 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2040 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2041 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2042 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2043 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2044 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2045 + }
2046 + ]
2047 + }
2048 +]
2049 +
2050 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2051 +
2052 +(% class="box infomessage" %)
2053 +(((
2054 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2055 +)))
2056 +
2057 +(% style="color:#000000" %)Метод запроса: **POST**
2058 +
2059 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2060 +
2061 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2062 +
2063 +(% style="text-align:left" %)
2064 +Тело запроса:
2065 +
2066 +{
2067 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2068 + "vehicleIds": [0], ~/~/ Список ID объектов
2069 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2070 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2071 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2072 +}
2073 +
2074 +Ответ:
2075 +
2076 +[
2077 + {
2078 + "vehicleId": 0, ~/~/ ID объекта
2079 + "name": "string", ~/~/ Имя ТС
2080 + "periods": [ ~/~/ Периоды
2081 + {
2082 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2083 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2084 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2085 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2086 + "fuelConsumption": 0, ~/~/ Расход топлива
2087 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2088 + }
2089 + ]
2090 + }
2091 +]
2092 +
2093 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2094 +
2095 +(% class="box infomessage" %)
2096 +(((
2097 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 +)))
2099 +
2100 +(% style="color:#000000" %)Метод запроса: **POST**
2101 +
2102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2103 +
2104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2105 +
2106 +(% style="text-align:left" %)
2107 +Тело запроса:
2108 +
2109 +{
2110 + "vehicleIds": [0], ~/~/ Список ID объектов
2111 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 +}
2115 +
2116 +Ответ:
2117 +
2118 +[
2119 + {
2120 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 + "vehicleId": 0, ~/~/ ID объекта
2123 + "name": "string", ~/~/ Имя объекта
2124 + "model": "string", ~/~/ Модель объекта
2125 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 + {
2127 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 + "valueFuel": 0, ~/~/ Количество
2131 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 + }
2134 + ]
2135 + }
2136 +]
2137 +
2138 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2139 +
2140 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2141 +
2142 +(% class="box infomessage" %)
2143 +(((
2144 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2145 +)))
2146 +
2147 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2148 +
2149 +(% style="color:#000000" %)Метод запроса: **POST**
2150 +
2151 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2152 +
2153 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2154 +
2155 +(% style="text-align:left" %)
2156 +Тело запроса:
2157 +
2158 +(% style="text-align:left" %)
2159 +{
2160 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2161 +}
2162 +
2163 +(% style="text-align:left" %)
2164 +Ответ:
2165 +
2166 +[
2167 + {
2168 + "id": 0, ~/~/ Идентификатор объекта геозоны
2169 + "name": "string", ~/~/ Название объекта геозоны
2170 + "type": 0, ~/~/ Тип объекта геозоны
2171 + "fname": "string", ~/~/ Имя файла
2172 + "parentId": "string", ~/~/ Идентификатор клиента
2173 + "radius": 0, ~/~/ Радиус геообъекта
2174 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2175 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2176 + "description": "string", ~/~/ Описание
2177 + "area": 0, ~/~/ Площадь, м^^2^^
2178 + "perimetr": 0, ~/~/ Периметр, м
2179 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2180 + }
2181 +]
2182 +
2183 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2184 +
2185 +(% class="box infomessage" %)
2186 +(((
2187 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2188 +)))
2189 +
2190 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2191 +
2192 +(% style="color:#000000" %)Метод запроса: **POST**
2193 +
2194 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2195 +
2196 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2197 +
2198 +(% style="text-align:left" %)
2199 +Тело запроса:
2200 +
2201 +{
2202 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2203 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2204 + "ids": [ ], ~/~/ Массив id объектов
2205 + "byTime": 0, ~/~/ Объединение событий по времени 
2206 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2207 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2208 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2209 +}
2210 +
2211 +Ответ:
2212 +[
2213 + {
2214 + "geozoneId": 0, ~/~/ ID геообъекта
2215 + "geozoneName": "string", ~/~/ Название геообъекта
2216 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2217 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2218 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2219 + "vehicleId": 0, ~/~/ ID объекта
2220 + "vehicleName": "string" ~/~/ Имя объекта
2221 + }
2222 +]
2223 +
2224 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2225 +
2226 +(% class="box infomessage" %)
2227 +(((
2228 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2229 +)))
2230 +
2231 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2232 +
2233 +(% style="color:#000000" %)Метод запроса: **POST**
2234 +
2235 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2236 +
2237 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2238 +
2239 +(% style="text-align:left" %)
2240 +Тело запроса:
2241 +
2242 +{
2243 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2244 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2245 + "ids": [ ], ~/~/ Массив id геообъектов
2246 + "byTime": 0, ~/~/ Объединение событий по времени 
2247 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2248 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2249 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2250 +}
2251 +
2252 +Ответ:
2253 +
2254 +[
2255 + {
2256 + "geozoneId": 0, ~/~/ ID геообъекта
2257 + "geozoneName": "string", ~/~/ Название геообъекта
2258 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2259 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2260 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2261 + "vehicleId": 0, ~/~/ ID объекта
2262 + "vehicleName": "string" ~/~/ Имя объекта
2263 + }
2264 +]
2265 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1827,7 +1827,10 @@
1827 1827  
1828 1828  == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
1829 1829  
1830 -POST /api/v3/Drivers/find
2471 +(% class="box infomessage" %)
2472 +(((
2473 +**POST /api/v3/Drivers/find**
2474 +)))
1831 1831  
1832 1832  Передается параметр: parentId - ID клиента-родителя
1833 1833  
... ... @@ -1835,20 +1835,23 @@
1835 1835  
1836 1836  [
1837 1837   {
1838 - "name": "string", //Определяет наименование
1839 - "description": "string", // Определяет описание
1840 - "hiredate": "2023-06-30T09:37:58.407Z", // Определяет дату найма
1841 - "chopdate": "2023-06-30T09:37:58.407Z", // Определяет дату увольнения
1842 - "exclusive": true, // Определяет признак "Исключительный"
1843 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя
1844 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
1845 - "deleted": true // Признак удаления
2482 + "name": "string", ~/~/ Определяет наименование
2483 + "description": "string", ~/~/ Определяет описание
2484 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2485 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2486 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2487 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2488 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2489 + "deleted": true ~/~/ Признак удаления
1846 1846   }
1847 1847  ]
1848 1848  
1849 1849  == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
1850 1850  
1851 -GET /api/v3/Drivers/{driverGuid}
2495 +(% class="box infomessage" %)
2496 +(((
2497 +**GET /api/v3/Drivers/{driverGuid}**
2498 +)))
1852 1852  
1853 1853  Передается параметр: ID водителя
1854 1854  
... ... @@ -1855,19 +1855,22 @@
1855 1855  Ответ:
1856 1856  
1857 1857  {
1858 - "name": "string", // Определяет наименование
1859 - "description": "string", // Определяет описание
1860 - "hiredate": "2023-06-30T09:33:33.083Z", // Определяет дату найма
1861 - "chopdate": "2023-06-30T09:33:33.083Z", // Определяет дату увольнения
1862 - "exclusive": true, // Определяет признак "Исключительный"
1863 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя
1864 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
1865 - "deleted": true // Признак удаления
2505 + "name": "string", ~/~/ Определяет наименование
2506 + "description": "string", ~/~/ Определяет описание
2507 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2508 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2509 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2510 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2511 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2512 + "deleted": true ~/~/ Признак удаления
1866 1866  }
1867 1867  
1868 1868  == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
1869 1869  
1870 -POST /api/v3/Drivers
2517 +(% class="box successmessage" %)
2518 +(((
2519 +**POST /api/v3/Drivers**
2520 +)))
1871 1871  
1872 1872  Запрос:
1873 1873  
... ... @@ -1898,7 +1898,10 @@
1898 1898  
1899 1899  == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
1900 1900  
1901 -PUT /api/v3/Drivers
2551 +(% class="box warningmessage" %)
2552 +(((
2553 +**PUT /api/v3/Drivers**
2554 +)))
1902 1902  
1903 1903  Запрос:
1904 1904  
... ... @@ -1929,7 +1929,10 @@
1929 1929  
1930 1930  == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
1931 1931  
1932 -DELETE /api/v3/Drivers/{driverGuid}
2585 +(% class="box errormessage" %)
2586 +(((
2587 +**DELETE /api/v3/Drivers/{driverGuid}**
2588 +)))
1933 1933  
1934 1934  Передается параметр: ID водителя
1935 1935  
... ... @@ -1944,7 +1944,10 @@
1944 1944  
1945 1945  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
1946 1946  
1947 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers
2603 +(% class="box infomessage" %)
2604 +(((
2605 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2606 +)))
1948 1948  
1949 1949  Запрос:
1950 1950  
... ... @@ -1972,7 +1972,10 @@
1972 1972  
1973 1973  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
1974 1974  
1975 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles
2634 +(% class="box infomessage" %)
2635 +(((
2636 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2637 +)))
1976 1976  
1977 1977  Запрос:
1978 1978  
... ... @@ -2000,7 +2000,10 @@
2000 2000  
2001 2001  === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2002 2002  
2003 -POST /api/v3/DriversVehiclesAssignments
2665 +(% class="box successmessage" %)
2666 +(((
2667 +**POST /api/v3/DriversVehiclesAssignments**
2668 +)))
2004 2004  
2005 2005  Передается массив назначений
2006 2006  
... ... @@ -2008,11 +2008,11 @@
2008 2008  
2009 2009  [
2010 2010   {
2011 - "VehicleId": 0, // Идентификатор объекта
2012 - "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения
2013 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2014 - "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения
2015 - "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно.
2676 + "VehicleId": 0, ~/~/ Идентификатор объекта
2677 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2678 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2679 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2680 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2016 2016   }
2017 2017  ]
2018 2018  
... ... @@ -2032,7 +2032,10 @@
2032 2032  
2033 2033  === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2034 2034  
2035 -PUT /api/v3/DriversVehiclesAssignments
2700 +(% class="box warningmessage" %)
2701 +(((
2702 +**PUT /api/v3/DriversVehiclesAssignments**
2703 +)))
2036 2036  
2037 2037  Запрос:
2038 2038  
... ... @@ -2040,7 +2040,7 @@
2040 2040   {
2041 2041   "VehicleId": 0,
2042 2042   "CreateTime": "2023-06-30T11:14:08.117Z",
2043 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2711 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2044 2044   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2045 2045   "BeginTime": "2023-06-30T11:14:08.117Z",
2046 2046   "EndTime": "2023-06-30T11:14:08.117Z"
... ... @@ -2063,33 +2063,20 @@
2063 2063  
2064 2064  === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2065 2065  
2066 -DELETE /api/v3/DriversVehiclesAssignments
2734 +(% class="box errormessage" %)
2735 +(((
2736 +**DELETE /api/v3/DriversVehiclesAssignments**
2737 +)))
2067 2067  
2068 2068  Запрос:
2069 2069  
2070 2070  [
2071 - {
2072 - "VehicleId": 0,
2073 - "CreateTime": "2023-06-30T11:16:08.341Z",
2074 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2075 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2076 - "BeginTime": "2023-06-30T11:16:08.342Z",
2077 - "EndTime": "2023-06-30T11:16:08.342Z"
2078 - }
2742 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2079 2079  ]
2080 2080  
2081 2081  Ответ:
2082 2082  
2083 -[
2084 - {
2085 - "VehicleId": 0,
2086 - "CreateTime": "2023-06-30T11:16:08.344Z",
2087 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2088 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2089 - "BeginTime": "2023-06-30T11:16:08.344Z",
2090 - "EndTime": "2023-06-30T11:16:08.344Z"
2091 - }
2092 -]
2747 +Success
2093 2093  
2094 2094  
2095 2095  == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
... ... @@ -2096,7 +2096,10 @@
2096 2096  
2097 2097  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2098 2098  
2099 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2754 +(% class="box infomessage" %)
2755 +(((
2756 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2757 +)))
2100 2100  
2101 2101  Запрос:
2102 2102  
... ... @@ -2112,9 +2112,9 @@
2112 2112  
2113 2113  [
2114 2114   {
2115 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2116 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2117 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2773 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2774 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2775 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2118 2118   "BeginTime": "2023-06-30T11:19:40.703Z",
2119 2119   "EndTime": "2023-06-30T11:19:40.703Z"
2120 2120   }
... ... @@ -2123,7 +2123,10 @@
2123 2123  
2124 2124  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2125 2125  
2126 -POST /api/v3/DriversRfidsAssignments/GetByRfids
2784 +(% class="box infomessage" %)
2785 +(((
2786 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2787 +)))
2127 2127  
2128 2128  Запрос:
2129 2129  
... ... @@ -2139,9 +2139,9 @@
2139 2139  
2140 2140  [
2141 2141   {
2142 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2143 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2144 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2803 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2804 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2805 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2145 2145   "BeginTime": "2023-06-30T11:19:40.703Z",
2146 2146   "EndTime": "2023-06-30T11:19:40.703Z"
2147 2147   }
... ... @@ -2150,7 +2150,10 @@
2150 2150  
2151 2151  === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2152 2152  
2153 -POST /api/v3/DriversRfidsAssignments
2814 +(% class="box successmessage" %)
2815 +(((
2816 +**POST /api/v3/DriversRfidsAssignments**
2817 +)))
2154 2154  
2155 2155  Запрос:
2156 2156  
... ... @@ -2178,7 +2178,10 @@
2178 2178  
2179 2179  === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2180 2180  
2181 -PUT /api/v3/DriversRfidsAssignments
2845 +(% class="box warningmessage" %)
2846 +(((
2847 +**PUT /api/v3/DriversRfidsAssignments**
2848 +)))
2182 2182  
2183 2183  Запрос:
2184 2184  
... ... @@ -2207,31 +2207,20 @@
2207 2207  
2208 2208  === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2209 2209  
2210 -DELETE /api/v3/DriversRfidsAssignments
2877 +(% class="box errormessage" %)
2878 +(((
2879 +**DELETE /api/v3/DriversRfidsAssignments**
2880 +)))
2211 2211  
2212 2212  Запрос:
2213 2213  
2214 2214  [
2215 - {
2216 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2217 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2218 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2219 - "BeginTime": "2023-06-30T11:28:43.330Z",
2220 - "EndTime": "2023-06-30T11:28:43.330Z"
2221 - }
2885 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2222 2222  ]
2223 2223  
2224 2224  Ответ:
2225 2225  
2226 -[
2227 - {
2228 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2229 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2230 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2231 - "BeginTime": "2023-06-30T11:28:43.331Z",
2232 - "EndTime": "2023-06-30T11:28:43.331Z"
2233 - }
2234 -]
2890 +Success
2235 2235  
2236 2236  
2237 2237  == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
... ... @@ -2238,7 +2238,10 @@
2238 2238  
2239 2239  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2240 2240  
2241 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
2897 +(% class="box infomessage" %)
2898 +(((
2899 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2900 +)))
2242 2242  
2243 2243  Запрос:
2244 2244  
... ... @@ -2265,7 +2265,10 @@
2265 2265  
2266 2266  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2267 2267  
2268 -POST /api/v3/DriversFuelCardsAssignments/GetByCards
2927 +(% class="box infomessage" %)
2928 +(((
2929 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2930 +)))
2269 2269  
2270 2270  Запрос:
2271 2271  
... ... @@ -2292,7 +2292,10 @@
2292 2292  
2293 2293  === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2294 2294  
2295 -POST /api/v3/DriversFuelCardsAssignments
2957 +(% class="box successmessage" %)
2958 +(((
2959 +**POST /api/v3/DriversFuelCardsAssignments**
2960 +)))
2296 2296  
2297 2297  Запрос:
2298 2298  
... ... @@ -2320,7 +2320,10 @@
2320 2320  
2321 2321  === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2322 2322  
2323 -PUT /api/v3/DriversFuelCardsAssignments
2988 +(% class="box warningmessage" %)
2989 +(((
2990 +**PUT /api/v3/DriversFuelCardsAssignments**
2991 +)))
2324 2324  
2325 2325  Запрос:
2326 2326  
... ... @@ -2327,9 +2327,10 @@
2327 2327  [
2328 2328   {
2329 2329   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2998 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2330 2330   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2331 - "BeginTime": "2023-06-30T12:09:53.175Z",
2332 - "EndTime": "2023-06-30T12:09:53.175Z"
3000 + "BeginTime": "2023-06-30T12:09:53.201Z",
3001 + "EndTime": "2023-06-30T12:09:53.201Z"
2333 2333   }
2334 2334  ]
2335 2335  
... ... @@ -2348,42 +2348,112 @@
2348 2348  
2349 2349  === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2350 2350  
2351 -DELETE /api/v3/DriversFuelCardsAssignments
3020 +(% class="box errormessage" %)
3021 +(((
3022 +**DELETE /api/v3/DriversFuelCardsAssignments**
3023 +)))
2352 2352  
2353 2353  Запрос:
2354 2354  
2355 2355  [
2356 - {
2357 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2358 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2359 - "BeginTime": "2023-06-30T12:09:53.175Z",
2360 - "EndTime": "2023-06-30T12:09:53.175Z"
2361 - }
3028 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2362 2362  ]
2363 2363  
2364 2364  Ответ:
2365 2365  
3033 +Success
3034 +
3035 +
3036 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3037 +
3038 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3039 +
3040 +(% class="box infomessage" %)
3041 +(((
3042 +**POST /api/v3/Trailers**
3043 +)))
3044 +
3045 +Пример запроса:
3046 +
3047 +{
3048 + "startDate": "2023-11-14T10:48:03.671Z",
3049 + "endDate": "2023-11-14T10:48:03.671Z",
3050 + "ids": [ 0 ],
3051 + "timezone": 0
3052 +}
3053 +
3054 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3055 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3056 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3057 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3058 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3059 +
3060 +Пример ответа:
3061 +
2366 2366  [
2367 2367   {
2368 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2369 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2370 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2371 - "BeginTime": "2023-06-30T12:09:53.201Z",
2372 - "EndTime": "2023-06-30T12:09:53.201Z"
3064 + "SD": "2023-11-14T10:48:03.717Z",
3065 + "ED": "2023-11-14T10:48:03.717Z", 
3066 + "id": 0,
3067 + "SLat": 0,
3068 + "SLon": 0,
3069 + "ELat": 0,
3070 + "ELon": 0,
3071 + "mileage": 0
3072 + "Duration": 0
3073 + "Address": "string",
3074 + "Address2": "string",
3075 + "name": "string",
3076 + "rid": "string",
3077 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3078 + "trailer": {
3079 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3080 + "Number": "string",
3081 + "Description": "string",
3082 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 + "ExternalID": "string",
3084 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "CreateTime": "2023-11-14T10:48:03.717Z",
3086 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3087 + "IsDeleted": true
3088 + },
3089 + "filesCount": 0,
2373 2373   }
2374 2374  ]
2375 2375  
3093 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3094 +|SD|Дата и время начала события
3095 +|ED|Дата и время окончания события
3096 +|id|ID объекта
3097 +|SLat|Широта начальной координаты
3098 +|SLon|Долгота начальной координаты
3099 +|ELat|Широта конечной координаты
3100 +|ELon|Долгота конечной координаты
3101 +|mileage|Пробег
3102 +|Duration|Продолжительность
3103 +|Address|Адрес начального местоположения
3104 +|Address2|Адрес конечного местоположения
3105 +|name|Имя радиометки
3106 +|rid|Номер радиометки
3107 +|rguid|ID радиометки
3108 +|trailer|Информация об агрегате
3109 +|ModelGuid|ID агрегата
3110 +|Number|Название/номер агрегата
3111 +|Description|Текст примечания агрегата
2376 2376  
2377 2377  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2378 2378  
2379 2379  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2380 2380  
2381 -POST /api/v3/Rfids/find
3117 +(% class="box infomessage" %)
3118 +(((
3119 +**POST /api/v3/Rfids/find**
3120 +)))
2382 2382  
2383 2383  Запрос:
2384 2384  
2385 -{
2386 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3124 +{
3125 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2387 2387  }
2388 2388  
2389 2389  Ответ:
... ... @@ -2392,17 +2392,25 @@
2392 2392   {
2393 2393   "name": "string",
2394 2394   "number": 0,
2395 - "period": 0, // Частота трансляции радиометки
3134 + "period": 0,
2396 2396   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2397 2397   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2398 - "deleted": true
2399 2399   }
2400 2400  ]
2401 2401  
3140 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3141 +|parentId|ID клиента
3142 +|name|Название карты-метки
3143 +|number|Номер
3144 +|period|Период запросов в секундах (работает только для агрегатов)
3145 +|id|ID карты-метки
2402 2402  
2403 2403  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2404 2404  
2405 -GET /api/v3/Rfids/{rfidGuid}
3149 +(% class="box infomessage" %)
3150 +(((
3151 +**GET /api/v3/Rfids/{rfidGuid}**
3152 +)))
2406 2406  
2407 2407  Передаем параметр rfidGuid - идентификатор карты-метки
2408 2408  
... ... @@ -2412,17 +2412,25 @@
2412 2412   {
2413 2413   "name": "string",
2414 2414   "number": 0,
2415 - "period": 0, // Частота трансляции радиометки
3162 + "period": 0,
2416 2416   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2417 2417   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2418 - "deleted": true
2419 2419   }
2420 2420  ]
2421 2421  
3168 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3169 +|name|Название карты-метки
3170 +|number|Номер
3171 +|period|Период запросов в секундах (работает только для агрегатов)
3172 +|id|ID карты-метки
3173 +|parentId|ID клиента
2422 2422  
2423 2423  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2424 2424  
2425 -POST /api/v3/Rfids
3177 +(% class="box successmessage" %)
3178 +(((
3179 +**POST /api/v3/Rfids**
3180 +)))
2426 2426  
2427 2427  Запрос:
2428 2428  
... ... @@ -2431,7 +2431,6 @@
2431 2431   "number": 0,
2432 2432   "period": 0,
2433 2433   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2434 - "deleted": true
2435 2435  }
2436 2436  
2437 2437  Ответ:
... ... @@ -2442,13 +2442,21 @@
2442 2442   "period": 0,
2443 2443   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2444 2444   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2445 - "deleted": true
2446 2446  }
2447 2447  
3201 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3202 +|name|Название карты-метки
3203 +|number|Номер
3204 +|period|Период запросов в секундах (работает только для агрегатов)
3205 +|id|ID карты-метки
3206 +|parentId|ID клиента
2448 2448  
2449 2449  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2450 2450  
2451 -PUT /api/v3/Rfids
3210 +(% class="box warningmessage" %)
3211 +(((
3212 +**PUT /api/v3/Rfids**
3213 +)))
2452 2452  
2453 2453  Запрос:
2454 2454  
... ... @@ -2458,7 +2458,6 @@
2458 2458   "period": 0,
2459 2459   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2460 2460   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2461 - "deleted": true
2462 2462  }
2463 2463  
2464 2464  Ответ:
... ... @@ -2469,15 +2469,23 @@
2469 2469   "period": 0,
2470 2470   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2471 2471   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2472 - "deleted": true
2473 2473  }
2474 2474  
3235 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3236 +|name|Название карты-метки
3237 +|number|Номер
3238 +|period|Период запросов в секундах (работает только для агрегатов)
3239 +|id|ID карты-метки
3240 +|parentId|ID клиента
2475 2475  
2476 2476  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2477 2477  
3244 +(% class="box errormessage" %)
3245 +(((
2478 2478  **DELETE /api/v3/Rfids/{rfidGuid}**
3247 +)))
2479 2479  
2480 -Передаем параметр rfidGuid - идентификатор карты-метки
3249 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2481 2481  
2482 2482  Ответ:
2483 2483  
... ... @@ -2484,6 +2484,670 @@
2484 2484  Success
2485 2485  
2486 2486  
3256 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3257 +
3258 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3259 +
3260 +(% class="box infomessage" %)
3261 +(((
3262 +**GET /api/v3/Billing/client/balance/{clientId}**
3263 +)))
3264 +
3265 +Параметр запроса: **clientId **- идентификатор клиента.
3266 +
3267 +Ответ:
3268 +
3269 +{
3270 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3271 + "Balance": 0
3272 +}
3273 +
3274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3275 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3276 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3277 +
3278 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3279 +
3280 +(% class="box infomessage" %)
3281 +(((
3282 +**GET /api/v3/Billing/client/constraint/{clientId}**
3283 +)))
3284 +
3285 +Параметр запроса: **clientId **- идентификатор клиента.
3286 +
3287 +Ответ:
3288 +
3289 +{
3290 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3291 + "CalculationType": 0,
3292 + "PermissibleBalance": 0,
3293 + "DefermentDays": 0,
3294 + "SendUiNotifications": true,
3295 + "SendEmailNotifications": true,
3296 + "IsPrivate": true,
3297 +}
3298 +
3299 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3300 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3301 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3302 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3303 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3304 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3305 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3306 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3307 +
3308 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3309 +
3310 +(% class="box infomessage" %)
3311 +(((
3312 +**GET /api/v3/Billing/client/plan/{clientId}**
3313 +)))
3314 +
3315 +Параметры запроса:
3316 +
3317 +**clientId **- идентификатор клиента.
3318 +
3319 +**planId **- идентификатор тарифного плана.
3320 +
3321 +Ответ:
3322 +
3323 +{
3324 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3325 + "Plan": { **~/~/ Описание тарифного плана**
3326 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3328 + "Name": "string",
3329 + "IsArchived": true,
3330 + "Constraint": {
3331 + "CalculationType": 0,
3332 + "PermissibleBalance": 0,
3333 + "DefermentDays": 0
3334 + },
3335 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3336 + {
3337 + "Feature": "string",
3338 + "IsFactual": true,
3339 + "Limit": 0,
3340 + "Price": 0,
3341 + "PeriodValue": 0,
3342 + "PeriodType": 0
3343 + }
3344 + ]
3345 + },
3346 + "DebitDate": "2023-10-18T12:46:24.213Z",
3347 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3348 + {
3349 + "Feature": "string",
3350 + "IsEnabled": true,
3351 + "IsPrivate": true,
3352 + "IsFactual": true,
3353 + "Limit": 0,
3354 + "Price": 0,
3355 + "DebitDate": "2023-10-18T12:46:24.213Z",
3356 + "PeriodValue": 0,
3357 + "PeriodType": 0
3358 + }
3359 + ]
3360 +}
3361 +
3362 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3363 +|ClientId|Идентификатор клиента
3364 +|Id|Идентификатор тарифного плана
3365 +|OwnerId|Идентификатор клиента-владельца
3366 +|Name|Наименование тарифного плана
3367 +|IsArchived|Признак, определяющий архивный тарифный план
3368 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3369 +|PermissibleBalance|Допустимый баланс
3370 +|DefermentDays|Отсрочка, количество дней
3371 +|Feature|Код услуги
3372 +|IsEnabled|Признак, определяющий активирована ли услуга
3373 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3374 +|IsFactual|Признак, определяющий расчёт по факту
3375 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3376 +|Price|Цена за единицу.
3377 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3378 +|PeriodValue|Значение периода.
3379 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3380 +
3381 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3382 +
3383 +(% class="box infomessage" %)
3384 +(((
3385 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3386 +)))
3387 +
3388 +Параметр запроса: **clientId **- идентификатор клиента.
3389 +
3390 +Ответ:
3391 +
3392 +[
3393 + {
3394 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3395 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3396 + "Name": "string",
3397 + "IsArchived": true,
3398 + "Constraint": {
3399 + "CalculationType": 0,
3400 + "PermissibleBalance": 0,
3401 + "DefermentDays": 0
3402 + },
3403 + "Features": [
3404 + {
3405 + "Feature": "string",
3406 + "IsFactual": true,
3407 + "Limit": 0,
3408 + "Price": 0,
3409 + "PeriodValue": 0,
3410 + "PeriodType": 0
3411 + }
3412 + ]
3413 + }
3414 +]
3415 +
3416 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3417 +|ClientId|Идентификатор клиента
3418 +|Id|Идентификатор тарифного плана
3419 +|OwnerId|Идентификатор клиента-владельца
3420 +|Name|Наименование тарифного плана
3421 +|IsArchived|Признак, определяющий архивный тарифный план
3422 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3423 +|PermissibleBalance|Допустимый баланс
3424 +|DefermentDays|Отсрочка, количество дней
3425 +|Feature|Код услуги
3426 +|IsFactual|Признак, определяющий расчёт по факту
3427 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3428 +|Price|Цена за единицу.
3429 +|PeriodValue|Значение периода.
3430 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3431 +
3432 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3433 +
3434 +(% class="box infomessage" %)
3435 +(((
3436 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3437 +)))
3438 +
3439 +Параметр запроса: **clientId **- идентификатор клиента.
3440 +
3441 +Ответ:
3442 +
3443 +[
3444 + {
3445 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3446 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3447 + "Name": "string",
3448 + "IsArchived": true,
3449 + "Constraint": {
3450 + "CalculationType": 0,
3451 + "PermissibleBalance": 0,
3452 + "DefermentDays": 0
3453 + },
3454 + "Features": [
3455 + {
3456 + "Feature": "string",
3457 + "IsFactual": true,
3458 + "Limit": 0,
3459 + "Price": 0,
3460 + "PeriodValue": 0,
3461 + "PeriodType": 0
3462 + }
3463 + ]
3464 + }
3465 +]
3466 +
3467 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3468 +|ClientId|Идентификатор клиента
3469 +|Id|Идентификатор тарифного плана
3470 +|OwnerId|Идентификатор клиента-владельца
3471 +|Name|Наименование тарифного плана
3472 +|IsArchived|Признак, определяющий архивный тарифный план
3473 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3474 +|PermissibleBalance|Допустимый баланс
3475 +|DefermentDays|Отсрочка, количество дней
3476 +|Feature|Код услуги
3477 +|IsFactual|Признак, определяющий расчёт по факту
3478 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3479 +|Price|Цена за единицу.
3480 +|PeriodValue|Значение периода.
3481 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3482 +
3483 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3484 +
3485 +(% class="box warningmessage" %)
3486 +(((
3487 +**PUT /api/v3/Billing/client/balance**
3488 +)))
3489 +
3490 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3491 +
3492 +Тело запроса:
3493 +
3494 +{
3495 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3496 + "Balance": 0
3497 +}
3498 +
3499 +Ответ: Success
3500 +
3501 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3502 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3503 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3504 +
3505 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3506 +
3507 +(% class="box warningmessage" %)
3508 +(((
3509 +**PUT /api/v3/billing/client/balance/deposit**
3510 +)))
3511 +
3512 +Создает операцию **Пополнение **с указанной суммой
3513 +
3514 +Тело запроса:
3515 +
3516 +{
3517 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 + "Balance": 0
3519 +}
3520 +
3521 +Ответ: Success
3522 +
3523 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3524 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3525 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3526 +
3527 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3528 +
3529 +Создает операцию **Списание **с указанной суммой
3530 +
3531 +(% class="box warningmessage" %)
3532 +(((
3533 +**PUT /api/v3/billing/client/balance/withdraw**
3534 +)))
3535 +
3536 +Тело запроса:
3537 +
3538 +{
3539 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3540 + "Balance": 0
3541 +}
3542 +
3543 +Ответ: Success
3544 +
3545 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3546 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3547 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3548 +
3549 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3550 +
3551 +(% class="box warningmessage" %)
3552 +(((
3553 +**PUT /api/v3/Billing/client/constraint**
3554 +)))
3555 +
3556 +Тело запроса:
3557 +
3558 +{
3559 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3560 + "CalculationType": 0,
3561 + "PermissibleBalance": 0,
3562 + "DefermentDays": 0,
3563 + "SendUiNotifications": true,
3564 + "SendEmailNotifications": true,
3565 + "IsPrivate": true,
3566 +}
3567 +
3568 +Ответ: Success
3569 +
3570 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3571 +|ClientId|Идентификатор клиента
3572 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3573 +|PermissibleBalance|Допустимый баланс
3574 +|DefermentDays|(((
3575 +Отсрочка, количество дней
3576 +)))
3577 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3578 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3579 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3580 +
3581 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3582 +
3583 +(% class="box warningmessage" %)
3584 +(((
3585 +**PUT /api/v3/Billing/client/plan**
3586 +)))
3587 +
3588 +Тело запроса:
3589 +
3590 +{
3591 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3592 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3593 + "Features": [
3594 + {
3595 + "Feature": "string",
3596 + "IsEnabled": true,
3597 + "IsFactual": true,
3598 + "Limit": 0,
3599 + "Price": 0,
3600 + "DebitDate": "2023-10-18T13:26:58.987Z",
3601 + "PeriodValue": 0,
3602 + "PeriodType": 0
3603 + }
3604 + ]
3605 +}
3606 +
3607 +Ответ: Success
3608 +
3609 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3610 +|ClientId|Идентификатор клиента
3611 +|PlanId|Идентификатор тарифного плана
3612 +|Feature|Код услуги
3613 +|IsEnabled|Признак, определяющий активирована ли услуга
3614 +|IsFactual|Признак, определяющий расчёт по факту
3615 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3616 +|Price|Цена за единицу.
3617 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3618 +|PeriodValue|Значение периода.
3619 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3620 +
3621 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3622 +
3623 +(% class="box warningmessage" %)
3624 +(((
3625 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3626 +)))
3627 +
3628 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3629 +
3630 +(% class="box infomessage" %)
3631 +(((
3632 +**POST /api/v3/vehicles/import/{agentId}**
3633 +)))
3634 +
3635 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3636 +
3637 +В пути указывается **agentId** - id клиента.
3638 +
3639 +**Заголовок**
3640 +
3641 +**X-Auth: [токен авторизации]**
3642 +
3643 +**Параметры**
3644 +
3645 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3646 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3647 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3648 +
3649 +В теле использовать тип **form-data,** тип значения** file**
3650 +
3651 +**Ключи**
3652 +
3653 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3654 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3655 +|csv|В значении передаем файл датчиков, формат **csv**
3656 +
3657 +Ответ:
3658 +
3659 +{
3660 + "vehicleId": 0,
3661 + "name": "string",
3662 + "errors": ["string"]
3663 +}
3664 +
3665 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3666 +|vehicleId|ID созданного объекта
3667 +|name|Имя созданного объекта
3668 +|errors|Ошибки и их описание
3669 +
3670 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3671 +
3672 +(% class="box infomessage" %)
3673 +(((
3674 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3675 +)))
3676 +
3677 +(% class="wikigeneratedid" %)
3678 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3679 +
3680 +(% class="wikigeneratedid" %)
3681 +В пути указывается **vehicleId **- id объекта.
3682 +
3683 +**Заголовок**
3684 +
3685 +**X-Auth: [токен авторизации]**
3686 +
3687 +В теле использовать тип **form-data.**
3688 +
3689 +Ключи:
3690 +
3691 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3692 +|**history**|В значении передавать файл с историей
3693 +
3694 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3695 +
3696 +Ответ:
3697 +
3698 +{
3699 + "results": [
3700 + {
3701 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 + "vehicleId": 0,
3703 + "errors": [
3704 + "string"
3705 + ],
3706 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3707 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3708 + "producedCount": 0,
3709 + "msgCount": 0
3710 + }
3711 + ]
3712 +}
3713 +
3714 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3715 +|results|Результаты импорта в разрезе ТС
3716 +|vehicleGuid|Guid ТС
3717 +|vehicleId|ID ТС
3718 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3719 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3720 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3721 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3722 +|msgCount|Кол-во обработанных сообщений всего
3723 +
3724 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3725 +
3726 +(% class="box infomessage" %)
3727 +(((
3728 +**GET /api/v3/vehicles/import/history/status**
3729 +)))
3730 +
3731 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3732 +
3733 +Ответ:
3734 +
3735 +{
3736 + "activity": true,
3737 + "progress": 0,
3738 + "message": "string"
3739 +}
3740 +
3741 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3742 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3743 +|progress|Guid ТС
3744 +
3745 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3746 +
3747 +(% class="box infomessage" %)
3748 +(((
3749 +**POST /api/v3/vehicles/export**
3750 +)))
3751 +
3752 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3753 +
3754 +Тело запроса:
3755 +
3756 +[
3757 + id
3758 +]
3759 +
3760 +Ответ: Success 200, получаете файлы с настройками.
3761 +
3762 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3763 +
3764 +(% class="box infomessage" %)
3765 +(((
3766 +**POST /api/v3/vehicles/export/history**
3767 +)))
3768 +
3769 +Метод возвращает список сообщений терминала объекта за выбранный период.
3770 +
3771 +Тело запроса:
3772 +
3773 +{
3774 + "vehicleId": 0,
3775 + "asArchive": true,
3776 + "from": "2023-09-27T12:17:45.973Z",
3777 + "to": "2023-09-27T12:17:45.973Z"
3778 +}
3779 +
3780 +Ответ:
3781 +
3782 +Получаете файл. Сообщение: Code 200/Success
3783 +
3784 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3785 +|vehicleId|ID объекта
3786 +|asArchive|true - Архивировать файл, False - не архивировать
3787 +|from|Дата и время начала запроса
3788 +|to|Дата и время окончания запроса
3789 +
3790 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3791 +
3792 +(% class="box infomessage" %)
3793 +(((
3794 +**GET /api/v3/vehicles/export/history/status**
3795 +)))
3796 +
3797 +Метод возвращает список сообщений терминала объекта за выбранный период.
3798 +
3799 +Ответ:
3800 +
3801 +{
3802 + "activity": true,
3803 + "progress": 0,
3804 + "message": "string"
3805 +}
3806 +
3807 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3808 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3809 +|progress|Прогресс экспорта, от 0 до 100%
3810 +|message|Текст описывающий статус
3811 +
3812 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3813 +
3814 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3815 +
3816 +(% class="box infomessage" %)
3817 +(((
3818 +**POST /api/v3/EcoDriving/rating**
3819 +)))
3820 +
3821 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3822 +
3823 +Тело запроса:
3824 +
3825 +{
3826 + "vehicleIds": [vehicleId],
3827 + "from": "2023-11-22T09:29:48.051Z",
3828 + "to": "2023-11-22T09:29:48.051Z"
3829 +}
3830 +
3831 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3832 +|vehicleIds|Массив ID объектов
3833 +|from|Дата начала запроса
3834 +|to|Дата окончания запроса
3835 +
3836 +Ответ:
3837 +
3838 +{
3839 + "items": [
3840 + {
3841 + "from": "2023-11-22T09:29:48.052Z",
3842 + "to": "2023-11-22T09:29:48.052Z",
3843 + "vehicleId": 0,
3844 + "vehicleName": "string",
3845 + "vehicleModel": "string",
3846 + "penalty": 0,
3847 + "score": 0,
3848 + "totalViolations": 0,
3849 + "violationsByType": {
3850 + "overspeedingViolations": 0,
3851 + "accelerationViolations": 0,
3852 + "brakingViolations": 0,
3853 + "turningViolations": 0,
3854 + "dangerousDrivingViolations": 0,
3855 + "sensorViolations": 0
3856 + },
3857 + "moveTime": 0,
3858 + "mileage": 0,
3859 + "tripsCount": 0,
3860 + "trips": [
3861 + {
3862 + "penalty": 0,
3863 + "score": 0,
3864 + "violationsCount": 0,
3865 + "violationsByType": {
3866 + "overspeedingViolations": 0,
3867 + "accelerationViolations": 0,
3868 + "brakingViolations": 0,
3869 + "turningViolations": 0,
3870 + "dangerousDrivingViolations": 0,
3871 + "sensorViolations": 0
3872 + },
3873 + "moveTime": 0,
3874 + "mileage": 0,
3875 + "motohours": 0,
3876 + "maxSpeed": 0,
3877 + "startAddress": "string",
3878 + "endAddress": "string",
3879 + "drivers": [
3880 + {
3881 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3882 + "driverName": "string",
3883 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3884 + }
3885 + ]
3886 + }
3887 + ]
3888 + }
3889 + ]
3890 +}
3891 +
3892 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3893 +|from|Дата начала запроса
3894 +|to|Дата  окончания
3895 +|vehicleId|ID объекта
3896 +|vehicleName|Имя объекта
3897 +|vehicleModel|Модель объекта
3898 +|penalty|Сумма штрафных баллов
3899 +|score|Оценка
3900 +|totalViolations|Суммарное количество нарушений
3901 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3902 +|overspeedingViolations|Превышение скорости
3903 +|accelerationViolations|Ускорение
3904 +|brakingViolations|Торможение
3905 +|turningViolations|Резкий поворот
3906 +|dangerousDrivingViolations|Резкое вождение
3907 +|sensorViolations|Нарушение по датчику
3908 +|moveTime|Время в движении
3909 +|mileage|Пробег
3910 +|tripsCount|Количество рейсов
3911 +|motohours|Моточасы
3912 +|maxSpeed|Максимальная скорость
3913 +|startAddress|Адрес начала рейса
3914 +|endAddress|Адрес окончания рейса
3915 +|drivers|Список водителей, которые были на объекте в течениии рейса
3916 +|driverGuid|Guid водителя
3917 +|driverName|Имя водителя
3918 +|driverRfid|Номер Карты-метки
3919 +
2487 2487  (% class="box" lang="en-US" style="text-align: center;" %)
2488 2488  (((
2489 2489  (% 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 г.