Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 152.1 >
edited by Андрей Калиновский
on 2024/03/26 12:01
To version < 93.1 >
edited by Илья Крайнов
on 2023/05/22 16:01
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,15 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 -(% 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 -
66 66  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
67 67  
68 68  (% class="box infomessage" %)
... ... @@ -101,51 +101,30 @@
101 101  Запрос должен содержать данные параметра "**agentId**"
102 102  
103 103  (% style="color:#000000" %)Ответ:
96 +А
104 104  {
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"
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" ~/~/ Корр. счет
125 125   }
126 126  
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 -
149 149  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
150 150  
151 151  (% class="box infomessage" %)
... ... @@ -159,7 +159,7 @@
159 159  
160 160  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
161 161  
162 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
163 163  
164 164  (% style="color:#000000" %)Метод запроса: **POST**
165 165  
... ... @@ -174,23 +174,15 @@
174 174  (% style="color:#000000" %)Ответ:
175 175  
176 176  {
177 - "agentId": "",(% style="color:#000000" %)   (%%)
178 - "parentId": "",
179 - "name": "string",
180 - "fullName": "string",
181 - "agentInfoType": 0,
182 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
183 183  }
184 184  
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 -
194 194  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
195 195  
196 196  (% class="box successmessage" %)
... ... @@ -209,7 +209,7 @@
209 209  Параметры в теле запроса (JSON):
210 210  
211 211  {
212 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
213 213   "name": "string", ~/~/ имя
214 214   "fullName": "string", ~/~/ полное наименование
215 215   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -254,28 +254,6 @@
254 254   "bankKS": "string" ~/~/ корр. счёт
255 255  }
256 256  
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 -
279 279  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
280 280  
281 281  (% class="box warningmessage" %)
... ... @@ -291,6 +291,7 @@
291 291  
292 292  В заголовках запроса: X-Auth: Токен авторизации
293 293  
235 +
294 294  Параметры в теле запроса (JSON):
295 295  
296 296  {
... ... @@ -315,6 +315,7 @@
315 315   "bankKS": "string" ~/~/ корр. счёт
316 316  }
317 317  
260 +
318 318  Ответ:
319 319  
320 320  {
... ... @@ -357,21 +357,6 @@
357 357  
358 358  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
359 359  
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 -
375 375  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
376 376  
377 377  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -435,6 +435,7 @@
435 435   "password": "string",
436 436   "email": "string",
437 437  
366 +
438 438  (% style="text-align:left" %)
439 439  (% style="color:#000000; font-weight:normal" %)Ответ:
440 440  
... ... @@ -463,7 +463,6 @@
463 463  (% style="text-align:left" %)
464 464  (% style="color:#000000; font-weight:normal" %)}
465 465  
466 -
467 467  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
468 468  
469 469  (% class="box infomessage" %)
... ... @@ -754,249 +754,6 @@
754 754  (% style="text-align:left" %)
755 755  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
756 756  
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 -
1000 1000  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
1001 1001  
1002 1002  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1296,70 +1296,45 @@
1296 1296   "retries": 0
1297 1297   }
1298 1298   ],
1299 -
1300 - "sensors": [ ~/~/ Датчики
984 + "sensors": [ ~/~/ Датчики
1301 1301   {
1302 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1303 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1304 - "type": 0, ~/~/ Тип датчика
1305 - "name": "string", ~/~/ Имя датчика
1306 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1307 - "inputNumber": 0, ~/~/ Номер входа
1308 - "pseudonym": "string", ~/~/ Псевдоним
1309 - "medianDegree": 0, ~/~/ Медианная фильтрация
1310 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1311 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1312 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1313 - "gradesTables": [ ~/~/ Массив таблиц тарировки
986 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
987 + "kind": 0,
988 + "type": 0,
989 + "name": "string",
990 + "inputType": 0,
991 + "inputNumber": 0,
992 + "pseudonym": "string",
993 + "medianDegree": 0,
994 + "isInverted": true,
995 + "disabled": true,
996 + "gradeType": 0,
997 + "gradesTables": [
1314 1314   {
1315 - "grades": [ ~/~/ Таблица тарировки 1
999 + "grades": [
1316 1316   {
1317 - "input": 0, ~/~/ Входящее значение
1318 - "output": 0 ~/~/ Выходящее значение
1001 + "input": 0,
1002 + "output": 0
1319 1319   }
1320 1320   ],
1321 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1005 + "relevanceTime": "2023-05-22T12:19:59.728Z"
1322 1322   }
1323 1323   ],
1324 - "showInTooltip": true, ~/~/ Отображать в подсказке
1325 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1326 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1327 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1328 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1329 - "expr": "string", ~/~/ Формула
1330 - "children": [ ~/~/ массив дочерних датчиков
1008 + "showInTooltip": true,
1009 + "showLastValid": true,
1010 + "showAsDutOnGraph": true,
1011 + "showWithoutIgn": true,
1012 + "agrFunction": 0,
1013 + "expr": "string",
1014 + "children": [
1331 1331   "string"
1332 1332   ],
1333 - "customParams": { ~/~/ прочие произвольные параметры
1017 + "customParams": {
1334 1334   "additionalProp1": "string",
1335 1335   "additionalProp2": "string",
1336 1336   "additionalProp3": "string"
1337 1337   },
1338 -
1339 -~/~/ Характерные для произвольного:
1340 -
1341 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1342 -
1343 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1344 -
1345 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1346 -
1347 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1348 -
1349 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1350 -
1351 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1352 -
1353 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1354 -
1355 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1356 -
1357 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1358 -
1359 -~/~/ "ValueOn": "Вкл.",
1360 -
1361 -~/~/ "ValueOff": "Выкл."
1362 - "summaryMaxValue": 0 ~/~/ Макс. значение
1022 + "summaryMaxValue": 0
1363 1363   }
1364 1364   ],
1365 1365   "customFields": [ ~/~/ Произвольные поля
... ... @@ -1570,7 +1570,7 @@
1570 1570  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1571 1571  
1572 1572  (% style="color:#000000" %){
1573 - "vehicleId": , ~/~/ ID объекта
1233 +
1574 1574   "parentId": "" , ~/~/ ID клиента
1575 1575   "name": "" , ~/~/ имя ТС
1576 1576   "imei": "" , ~/~/ IMEI
... ... @@ -1639,70 +1639,45 @@
1639 1639   "retries": 0
1640 1640   }
1641 1641   ],
1642 -
1643 - "sensors": [ ~/~/ Датчики
1302 + "sensors": [ ~/~/ Датчики
1644 1644   {
1645 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1646 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1647 - "type": 0, ~/~/ Тип датчика
1648 - "name": "string", ~/~/ Имя датчика
1649 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1650 - "inputNumber": 0, ~/~/ Номер входа
1651 - "pseudonym": "string", ~/~/ Псевдоним
1652 - "medianDegree": 0, ~/~/ Медианная фильтрация
1653 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1654 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1655 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1656 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1304 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1305 + "kind": 0,
1306 + "type": 0,
1307 + "name": "string",
1308 + "inputType": 0,
1309 + "inputNumber": 0,
1310 + "pseudonym": "string",
1311 + "medianDegree": 0,
1312 + "isInverted": true,
1313 + "disabled": true,
1314 + "gradeType": 0,
1315 + "gradesTables": [
1657 1657   {
1658 - "grades": [ ~/~/ Таблица тарировки 1
1317 + "grades": [
1659 1659   {
1660 - "input": 0, ~/~/ Входящее значение
1661 - "output": 0 ~/~/ Выходящее значение
1319 + "input": 0,
1320 + "output": 0
1662 1662   }
1663 1663   ],
1664 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1323 + "relevanceTime": "2023-05-22T12:19:59.728Z"
1665 1665   }
1666 1666   ],
1667 - "showInTooltip": true, ~/~/ Отображать в подсказке
1668 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1669 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1670 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1671 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1672 - "expr": "string", ~/~/ Формула
1673 - "children": [ ~/~/ массив дочерних датчиков
1326 + "showInTooltip": true,
1327 + "showLastValid": true,
1328 + "showAsDutOnGraph": true,
1329 + "showWithoutIgn": true,
1330 + "agrFunction": 0,
1331 + "expr": "string",
1332 + "children": [
1674 1674   "string"
1675 1675   ],
1676 - "customParams": { ~/~/ прочие произвольные параметры
1335 + "customParams": {
1677 1677   "additionalProp1": "string",
1678 1678   "additionalProp2": "string",
1679 1679   "additionalProp3": "string"
1680 1680   },
1681 -
1682 -~/~/ Характерные для произвольного:
1683 -
1684 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1685 -
1686 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1687 -
1688 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1689 -
1690 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1691 -
1692 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1693 -
1694 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1695 -
1696 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1697 -
1698 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1699 -
1700 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1701 -
1702 -~/~/ "ValueOn": "Вкл.",
1703 -
1704 -~/~/ "ValueOff": "Выкл."
1705 - "summaryMaxValue": 0 ~/~/ Макс. значение
1340 + "summaryMaxValue": 0
1706 1706   }
1707 1707   ],
1708 1708   "customFields": [ ~/~/ Произвольные поля
... ... @@ -1805,7 +1805,7 @@
1805 1805  
1806 1806  (% style="color:#000000" %)Метод запроса: **GET**
1807 1807  
1808 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1443 +(% 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]]
1809 1809  
1810 1810  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1811 1811  
... ... @@ -1888,56 +1888,6 @@
1888 1888   }
1889 1889  ]
1890 1890  
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 -
1941 1941  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1942 1942  
1943 1943  (% class="box infomessage" %)
... ... @@ -1962,11 +1962,6 @@
1962 1962   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1963 1963  }
1964 1964  
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 -
1970 1970  Ответ:
1971 1971  
1972 1972  [
... ... @@ -1973,427 +1973,25 @@
1973 1973   {
1974 1974   "messages": [
1975 1975   {
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": {
1556 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1557 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1558 + "speed": 0, ~/~/ Скорость, км/ч
1559 + "altitude": 0, ~/~/ Высота, м
1560 + "latitude": 0, ~/~/ Широта [-90°;90°]
1561 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1562 + "satellites": 0, ~/~/ Кол-во спутников
1563 + "voltage": 0, ~/~/ Напряжение
1564 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1986 1986   "additionalProp1": "string",
1987 1987   "additionalProp2": "string",
1988 1988   "additionalProp3": "string"
1989 1989   },
1990 - "photoCount": 0,
1991 - "lbsCorrectedCoords": true,
1992 - "protocolType": 0
1569 + "photoCount": 0 ~/~/ Кол-во фото
1993 1993   }
1994 1994   ]
1995 1995   }
1996 1996  ]
1997 1997  
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 -
2013 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2014 -
2015 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2016 -
2017 -(% class="box infomessage" %)
2018 -(((
2019 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2020 -)))
2021 -
2022 -(% style="color:#000000" %)Метод запроса: **POST**
2023 -
2024 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2025 -
2026 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2027 -
2028 -(% style="text-align:left" %)
2029 -Тело запроса:
2030 -
2031 -{
2032 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2033 - "vehicleIds": [0], ~/~/ Список ID объектов
2034 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2035 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2036 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2037 -}
2038 -
2039 -Ответ:
2040 -
2041 -[
2042 - {
2043 - "vehicleId": 0, ~/~/ ID объекта
2044 - "name": "string", ~/~/ Имя ТС
2045 - "periods": [ ~/~/ Периоды
2046 - {
2047 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2048 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2049 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2050 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2051 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2052 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2053 - }
2054 - ]
2055 - }
2056 -]
2057 -
2058 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2059 -
2060 -(% class="box infomessage" %)
2061 -(((
2062 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2063 -)))
2064 -
2065 -(% style="color:#000000" %)Метод запроса: **POST**
2066 -
2067 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2068 -
2069 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2070 -
2071 -(% style="text-align:left" %)
2072 -Тело запроса:
2073 -
2074 -{
2075 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2076 - "vehicleIds": [0], ~/~/ Список ID объектов
2077 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2078 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2079 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2080 -}
2081 -
2082 -Ответ:
2083 -
2084 -[
2085 - {
2086 - "vehicleId": 0, ~/~/ ID объекта
2087 - "name": "string", ~/~/ Имя ТС
2088 - "periods": [ ~/~/ Периоды
2089 - {
2090 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2091 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2092 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2093 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2094 - "fuelConsumption": 0, ~/~/ Расход топлива
2095 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2096 - }
2097 - ]
2098 - }
2099 -]
2100 -
2101 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2102 -
2103 -(% class="box infomessage" %)
2104 -(((
2105 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2106 -)))
2107 -
2108 -(% style="color:#000000" %)Метод запроса: **POST**
2109 -
2110 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2111 -
2112 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2113 -
2114 -(% style="text-align:left" %)
2115 -Тело запроса:
2116 -
2117 -{
2118 - "vehicleIds": [0], ~/~/ Список ID объектов
2119 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2120 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2121 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2122 -}
2123 -
2124 -Ответ:
2125 -
2126 -[
2127 - {
2128 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2129 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2130 - "vehicleId": 0, ~/~/ ID объекта
2131 - "name": "string", ~/~/ Имя объекта
2132 - "model": "string", ~/~/ Модель объекта
2133 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2134 - {
2135 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2136 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2137 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2138 - "valueFuel": 0, ~/~/ Количество
2139 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2140 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2141 - }
2142 - ]
2143 - }
2144 -]
2145 -
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 -
2269 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2270 -
2271 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2272 -
2273 -(% class="box infomessage" %)
2274 -(((
2275 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2276 -)))
2277 -
2278 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2279 -
2280 -(% style="color:#000000" %)Метод запроса: **POST**
2281 -
2282 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2283 -
2284 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2285 -
2286 -(% style="text-align:left" %)
2287 -Тело запроса:
2288 -
2289 -(% style="text-align:left" %)
2290 -{
2291 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2292 -}
2293 -
2294 -(% style="text-align:left" %)
2295 -Ответ:
2296 -
2297 -[
2298 - {
2299 - "id": 0, ~/~/ Идентификатор объекта геозоны
2300 - "name": "string", ~/~/ Название объекта геозоны
2301 - "type": 0, ~/~/ Тип объекта геозоны
2302 - "fname": "string", ~/~/ Имя файла
2303 - "parentId": "string", ~/~/ Идентификатор клиента
2304 - "radius": 0, ~/~/ Радиус геообъекта
2305 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2306 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2307 - "description": "string", ~/~/ Описание
2308 - "area": 0, ~/~/ Площадь, м^^2^^
2309 - "perimetr": 0, ~/~/ Периметр, м
2310 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2311 - }
2312 -]
2313 -
2314 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2315 -
2316 -(% class="box infomessage" %)
2317 -(((
2318 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2319 -)))
2320 -
2321 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2322 -
2323 -(% style="color:#000000" %)Метод запроса: **POST**
2324 -
2325 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2326 -
2327 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2328 -
2329 -(% style="text-align:left" %)
2330 -Тело запроса:
2331 -
2332 -{
2333 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2334 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2335 - "ids": [ ], ~/~/ Массив id объектов
2336 - "byTime": 0, ~/~/ Объединение событий по времени 
2337 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2338 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2339 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2340 -}
2341 -
2342 -Ответ:
2343 -[
2344 - {
2345 - "geozoneId": 0, ~/~/ ID геообъекта
2346 - "geozoneName": "string", ~/~/ Название геообъекта
2347 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2348 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2349 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2350 - "vehicleId": 0, ~/~/ ID объекта
2351 - "vehicleName": "string" ~/~/ Имя объекта
2352 - }
2353 -]
2354 -
2355 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2356 -
2357 -(% class="box infomessage" %)
2358 -(((
2359 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2360 -)))
2361 -
2362 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2363 -
2364 -(% style="color:#000000" %)Метод запроса: **POST**
2365 -
2366 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2367 -
2368 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2369 -
2370 -(% style="text-align:left" %)
2371 -Тело запроса:
2372 -
2373 -{
2374 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2375 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2376 - "ids": [ ], ~/~/ Массив id геообъектов
2377 - "byTime": 0, ~/~/ Объединение событий по времени 
2378 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2379 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2380 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2381 -}
2382 -
2383 -Ответ:
2384 -
2385 -[
2386 - {
2387 - "geozoneId": 0, ~/~/ ID геообъекта
2388 - "geozoneName": "string", ~/~/ Название геообъекта
2389 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2390 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2391 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2392 - "vehicleId": 0, ~/~/ ID объекта
2393 - "vehicleName": "string" ~/~/ Имя объекта
2394 - }
2395 -]
2396 -
2397 2397  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2398 2398  
2399 2399  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2594,1606 +2594,6 @@
2594 2594  
2595 2595  Success
2596 2596  
2597 -
2598 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2599 -
2600 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2601 -
2602 -(% class="box infomessage" %)
2603 -(((
2604 -**POST /api/v3/Drivers/find**
2605 -)))
2606 -
2607 -Передается параметр: parentId - ID клиента-родителя
2608 -
2609 -Ответ:
2610 -
2611 -[
2612 - {
2613 - "name": "string", ~/~/ Определяет наименование
2614 - "description": "string", ~/~/ Определяет описание
2615 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2616 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2617 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2618 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2619 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2620 - "deleted": true ~/~/ Признак удаления
2621 - }
2622 -]
2623 -
2624 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2625 -
2626 -(% class="box infomessage" %)
2627 -(((
2628 -**GET /api/v3/Drivers/{driverGuid}**
2629 -)))
2630 -
2631 -Передается параметр: ID водителя
2632 -
2633 -Ответ:
2634 -
2635 -{
2636 - "name": "string", ~/~/ Определяет наименование
2637 - "description": "string", ~/~/ Определяет описание
2638 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2639 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2640 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2641 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2642 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2643 - "deleted": true ~/~/ Признак удаления
2644 -}
2645 -
2646 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2647 -
2648 -(% class="box successmessage" %)
2649 -(((
2650 -**POST /api/v3/Drivers**
2651 -)))
2652 -
2653 -Запрос:
2654 -
2655 -{
2656 - "name": "string",
2657 - "description": "string",
2658 - "hiredate": "2023-06-30T12:50:54.020Z",
2659 - "chopdate": "2023-06-30T12:50:54.020Z",
2660 - "exclusive": true,
2661 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2662 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2663 - "deleted": true
2664 -}
2665 -
2666 -Ответ:
2667 -
2668 -{
2669 - "name": "string",
2670 - "description": "string",
2671 - "hiredate": "2023-06-30T12:50:54.051Z",
2672 - "chopdate": "2023-06-30T12:50:54.051Z",
2673 - "exclusive": true,
2674 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2675 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2676 - "deleted": true
2677 -}
2678 -
2679 -
2680 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2681 -
2682 -(% class="box warningmessage" %)
2683 -(((
2684 -**PUT /api/v3/Drivers**
2685 -)))
2686 -
2687 -Запрос:
2688 -
2689 -{
2690 - "name": "string",
2691 - "description": "string",
2692 - "hiredate": "2023-06-30T12:50:27.910Z",
2693 - "chopdate": "2023-06-30T12:50:27.910Z",
2694 - "exclusive": true,
2695 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2696 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2697 - "deleted": true
2698 -}
2699 -
2700 -Ответ:
2701 -
2702 -{
2703 - "name": "string",
2704 - "description": "string",
2705 - "hiredate": "2023-06-30T12:50:27.929Z",
2706 - "chopdate": "2023-06-30T12:50:27.929Z",
2707 - "exclusive": true,
2708 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2709 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2710 - "deleted": true
2711 -}
2712 -
2713 -
2714 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2715 -
2716 -(% class="box errormessage" %)
2717 -(((
2718 -**DELETE /api/v3/Drivers/{driverGuid}**
2719 -)))
2720 -
2721 -Передается параметр: ID водителя
2722 -
2723 -Ответ:
2724 -
2725 -Success
2726 -
2727 -
2728 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2729 -
2730 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2731 -
2732 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2733 -
2734 -(% class="box infomessage" %)
2735 -(((
2736 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2737 -)))
2738 -
2739 -Запрос:
2740 -
2741 -{
2742 - "Ids": [
2743 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2744 - ],
2745 - "BeginTime": "2023-06-30T12:49:04.365Z",
2746 - "EndTime": "2023-06-30T12:49:04.365Z"
2747 -}
2748 -
2749 -Ответ:
2750 -
2751 -[
2752 - {
2753 - "VehicleId": 0,
2754 - "CreateTime": "2023-06-30T09:52:31.240Z",
2755 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2756 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2757 - "BeginTime": "2023-06-30T09:52:31.240Z",
2758 - "EndTime": "2023-06-30T09:52:31.240Z"
2759 - }
2760 -]
2761 -
2762 -
2763 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2764 -
2765 -(% class="box infomessage" %)
2766 -(((
2767 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2768 -)))
2769 -
2770 -Запрос:
2771 -
2772 -{
2773 - "Ids": [
2774 - 0
2775 - ],
2776 - "BeginTime": "2023-06-30T12:48:39.419Z",
2777 - "EndTime": "2023-06-30T12:48:39.419Z"
2778 -}
2779 -
2780 -Ответ:
2781 -
2782 -[
2783 - {
2784 - "VehicleId": 0,
2785 - "CreateTime": "2023-06-30T09:54:01.631Z",
2786 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 - "BeginTime": "2023-06-30T09:54:01.631Z",
2789 - "EndTime": "2023-06-30T09:54:01.631Z"
2790 - }
2791 -]
2792 -
2793 -
2794 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2795 -
2796 -(% class="box successmessage" %)
2797 -(((
2798 -**POST /api/v3/DriversVehiclesAssignments**
2799 -)))
2800 -
2801 -Передается массив назначений
2802 -
2803 -Запрос:
2804 -
2805 -[
2806 - {
2807 - "VehicleId": 0, ~/~/ Идентификатор объекта
2808 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2809 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2810 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2811 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2812 - }
2813 -]
2814 -
2815 -Ответ:
2816 -
2817 -[
2818 - {
2819 - "VehicleId": 0,
2820 - "CreateTime": "2023-06-30T11:04:46.903Z",
2821 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2822 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2823 - "BeginTime": "2023-06-30T11:04:46.903Z",
2824 - "EndTime": "2023-06-30T11:04:46.903Z"
2825 - }
2826 -]
2827 -
2828 -
2829 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2830 -
2831 -(% class="box warningmessage" %)
2832 -(((
2833 -**PUT /api/v3/DriversVehiclesAssignments**
2834 -)))
2835 -
2836 -Запрос:
2837 -
2838 -[
2839 - {
2840 - "VehicleId": 0,
2841 - "CreateTime": "2023-06-30T11:14:08.117Z",
2842 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2843 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2844 - "BeginTime": "2023-06-30T11:14:08.117Z",
2845 - "EndTime": "2023-06-30T11:14:08.117Z"
2846 - }
2847 -]
2848 -
2849 -Ответ:
2850 -
2851 -[
2852 - {
2853 - "VehicleId": 0,
2854 - "CreateTime": "2023-06-30T11:14:53.349Z",
2855 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2856 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2857 - "BeginTime": "2023-06-30T11:14:53.349Z",
2858 - "EndTime": "2023-06-30T11:14:53.349Z"
2859 - }
2860 -]
2861 -
2862 -
2863 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2864 -
2865 -(% class="box errormessage" %)
2866 -(((
2867 -**DELETE /api/v3/DriversVehiclesAssignments**
2868 -)))
2869 -
2870 -Запрос:
2871 -
2872 -[
2873 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2874 -]
2875 -
2876 -Ответ:
2877 -
2878 -Success
2879 -
2880 -
2881 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2882 -
2883 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2884 -
2885 -(% class="box infomessage" %)
2886 -(((
2887 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2888 -)))
2889 -
2890 -Запрос:
2891 -
2892 -{
2893 - "Ids": [
2894 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2895 - ],
2896 - "BeginTime": "2023-06-30T12:47:12.162Z",
2897 - "EndTime": "2023-06-30T12:47:12.162Z"
2898 -}
2899 -
2900 -Ответ:
2901 -
2902 -[
2903 - {
2904 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2905 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2906 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2907 - "BeginTime": "2023-06-30T11:19:40.703Z",
2908 - "EndTime": "2023-06-30T11:19:40.703Z"
2909 - }
2910 -]
2911 -
2912 -
2913 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2914 -
2915 -(% class="box infomessage" %)
2916 -(((
2917 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2918 -)))
2919 -
2920 -Запрос:
2921 -
2922 -{
2923 - "Ids": [
2924 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2925 - ],
2926 - "BeginTime": "2023-06-30T12:47:12.162Z",
2927 - "EndTime": "2023-06-30T12:47:12.162Z"
2928 -}
2929 -
2930 -Ответ:
2931 -
2932 -[
2933 - {
2934 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2935 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2936 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2937 - "BeginTime": "2023-06-30T11:19:40.703Z",
2938 - "EndTime": "2023-06-30T11:19:40.703Z"
2939 - }
2940 -]
2941 -
2942 -
2943 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2944 -
2945 -(% class="box successmessage" %)
2946 -(((
2947 -**POST /api/v3/DriversRfidsAssignments**
2948 -)))
2949 -
2950 -Запрос:
2951 -
2952 -[
2953 - {
2954 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2955 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2956 - "BeginTime": "2023-06-30T11:27:08.635Z",
2957 - "EndTime": "2023-06-30T11:27:08.635Z"
2958 - }
2959 -]
2960 -
2961 -Ответ:
2962 -
2963 -[
2964 - {
2965 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2966 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2967 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2968 - "BeginTime": "2023-06-30T11:27:08.677Z",
2969 - "EndTime": "2023-06-30T11:27:08.677Z"
2970 - }
2971 -]
2972 -
2973 -
2974 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2975 -
2976 -(% class="box warningmessage" %)
2977 -(((
2978 -**PUT /api/v3/DriversRfidsAssignments**
2979 -)))
2980 -
2981 -Запрос:
2982 -
2983 -[
2984 - {
2985 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2986 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2987 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2988 - "BeginTime": "2023-06-30T11:28:43.330Z",
2989 - "EndTime": "2023-06-30T11:28:43.330Z"
2990 - }
2991 -]
2992 -
2993 -Ответ:
2994 -
2995 -[
2996 - {
2997 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2998 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 - "BeginTime": "2023-06-30T11:28:43.331Z",
3001 - "EndTime": "2023-06-30T11:28:43.331Z"
3002 - }
3003 -]
3004 -
3005 -
3006 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3007 -
3008 -(% class="box errormessage" %)
3009 -(((
3010 -**DELETE /api/v3/DriversRfidsAssignments**
3011 -)))
3012 -
3013 -Запрос:
3014 -
3015 -[
3016 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3017 -]
3018 -
3019 -Ответ:
3020 -
3021 -Success
3022 -
3023 -
3024 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3025 -
3026 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3027 -
3028 -(% class="box infomessage" %)
3029 -(((
3030 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3031 -)))
3032 -
3033 -Запрос:
3034 -
3035 -{
3036 - "Ids": [
3037 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3038 - ],
3039 - "BeginTime": "2023-06-30T12:45:10.852Z",
3040 - "EndTime": "2023-06-30T12:45:10.852Z"
3041 -}
3042 -
3043 -Ответ:
3044 -
3045 -[
3046 - {
3047 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3048 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3049 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3050 - "BeginTime": "2023-06-30T11:58:04.695Z",
3051 - "EndTime": "2023-06-30T11:58:04.695Z"
3052 - }
3053 -]
3054 -
3055 -
3056 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3057 -
3058 -(% class="box infomessage" %)
3059 -(((
3060 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3061 -)))
3062 -
3063 -Запрос:
3064 -
3065 -{
3066 - "Ids": [
3067 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3068 - ],
3069 - "BeginTime": "2023-06-30T12:45:10.852Z",
3070 - "EndTime": "2023-06-30T12:45:10.852Z"
3071 -}
3072 -
3073 -Ответ:
3074 -
3075 -[
3076 - {
3077 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3078 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3079 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3080 - "BeginTime": "2023-06-30T11:58:04.695Z",
3081 - "EndTime": "2023-06-30T11:58:04.695Z"
3082 - }
3083 -]
3084 -
3085 -
3086 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3087 -
3088 -(% class="box successmessage" %)
3089 -(((
3090 -**POST /api/v3/DriversFuelCardsAssignments**
3091 -)))
3092 -
3093 -Запрос:
3094 -
3095 -[
3096 - {
3097 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3098 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3099 - "BeginTime": "2023-06-30T12:09:53.175Z",
3100 - "EndTime": "2023-06-30T12:09:53.175Z"
3101 - }
3102 -]
3103 -
3104 -Ответ:
3105 -
3106 -[
3107 - {
3108 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3109 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3110 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3111 - "BeginTime": "2023-06-30T12:09:53.201Z",
3112 - "EndTime": "2023-06-30T12:09:53.201Z"
3113 - }
3114 -]
3115 -
3116 -
3117 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3118 -
3119 -(% class="box warningmessage" %)
3120 -(((
3121 -**PUT /api/v3/DriversFuelCardsAssignments**
3122 -)))
3123 -
3124 -Запрос:
3125 -
3126 -[
3127 - {
3128 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3129 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3130 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3131 - "BeginTime": "2023-06-30T12:09:53.201Z",
3132 - "EndTime": "2023-06-30T12:09:53.201Z"
3133 - }
3134 -]
3135 -
3136 -Ответ:
3137 -
3138 -[
3139 - {
3140 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3141 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3142 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3143 - "BeginTime": "2023-06-30T12:09:53.201Z",
3144 - "EndTime": "2023-06-30T12:09:53.201Z"
3145 - }
3146 -]
3147 -
3148 -
3149 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3150 -
3151 -(% class="box errormessage" %)
3152 -(((
3153 -**DELETE /api/v3/DriversFuelCardsAssignments**
3154 -)))
3155 -
3156 -Запрос:
3157 -
3158 -[
3159 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3160 -]
3161 -
3162 -Ответ:
3163 -
3164 -Success
3165 -
3166 -
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 -
3244 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3245 -
3246 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3247 -
3248 -(% class="box infomessage" %)
3249 -(((
3250 -**POST /api/v3/Rfids/find**
3251 -)))
3252 -
3253 -Запрос:
3254 -
3255 -{
3256 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3257 -}
3258 -
3259 -Ответ:
3260 -
3261 -[
3262 - {
3263 - "name": "string",
3264 - "number": 0,
3265 - "period": 0,
3266 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3267 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3268 - }
3269 -]
3270 -
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 карты-метки
3277 -
3278 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3279 -
3280 -(% class="box infomessage" %)
3281 -(((
3282 -**GET /api/v3/Rfids/{rfidGuid}**
3283 -)))
3284 -
3285 -Передаем параметр rfidGuid - идентификатор карты-метки
3286 -
3287 -Ответ:
3288 -
3289 -[
3290 - {
3291 - "name": "string",
3292 - "number": 0,
3293 - "period": 0,
3294 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3295 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3296 - }
3297 -]
3298 -
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 клиента
3305 -
3306 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3307 -
3308 -(% class="box successmessage" %)
3309 -(((
3310 -**POST /api/v3/Rfids**
3311 -)))
3312 -
3313 -Запрос:
3314 -
3315 -{
3316 - "name": "string",
3317 - "number": 0,
3318 - "period": 0,
3319 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3320 -}
3321 -
3322 -Ответ:
3323 -
3324 -{
3325 - "name": "string",
3326 - "number": 0,
3327 - "period": 0,
3328 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3329 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3330 -}
3331 -
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 клиента
3338 -
3339 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3340 -
3341 -(% class="box warningmessage" %)
3342 -(((
3343 -**PUT /api/v3/Rfids**
3344 -)))
3345 -
3346 -Запрос:
3347 -
3348 -{
3349 - "name": "string",
3350 - "number": 0,
3351 - "period": 0,
3352 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3353 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3354 -}
3355 -
3356 -Ответ:
3357 -
3358 -{
3359 - "name": "string",
3360 - "number": 0,
3361 - "period": 0,
3362 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3363 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3364 -}
3365 -
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 клиента
3372 -
3373 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3374 -
3375 -(% class="box errormessage" %)
3376 -(((
3377 -**DELETE /api/v3/Rfids/{rfidGuid}**
3378 -)))
3379 -
3380 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3381 -
3382 -Ответ:
3383 -
3384 -Success
3385 -
3386 -
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 -Запрос должен содержать параметры:
4063 -
4064 -{
4065 -
4066 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4067 -
4068 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4069 -
4070 - "ids": [
4071 -
4072 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4073 -
4074 - ],
4075 -
4076 - "timezone": 0, ~/~/ Часовой пояс
4077 -
4078 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4079 -
4080 -}
4081 -
4082 -Ответ:
4083 -
4084 - {
4085 -
4086 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4087 -
4088 - " driver ": "string", ~/~/ Имя водителя
4089 -
4090 - "amount": 0, ~/~/ Количество топлива
4091 -
4092 - "amountDut": 0, ~/~/ Количество топлива по ДУТ
4093 -
4094 - "amountDiff": 0, ~/~/ Разница в литрах
4095 -
4096 - "amountDiffPerc": 0, ~/~/ Разница в %
4097 -
4098 - "summa": 0, ~/~/  Стоимость в руб.
4099 -
4100 - "serviceName": "string", ~/~/ Тип топлива
4101 -
4102 - "price": 0, ~/~/ Цена за литр в руб.
4103 -
4104 - "cardName": "string", ~/~/ Наименование ТК
4105 -
4106 - "cardNum": "string", ~/~/ Номер ТК
4107 -
4108 - "operator": "string", ~/~/ Оператор ТК
4109 -
4110 - "address": "string", ~/~/ Адрес АЗС
4111 -
4112 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4113 -
4114 - }
4115 -
4116 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4117 -
4118 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4119 -
4120 -
4121 -(% class="box infomessage" %)
4122 -(((
4123 -GET api/v3/Vehicles/recyclebin/all
4124 -)))
4125 -
4126 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4127 -
4128 -Параметр запроса: {parentId} - идентификатор агента
4129 -
4130 -В заголовках запроса: X-Auth: Токен авторизации
4131 -
4132 -Ответ:
4133 -
4134 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4135 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4136 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4137 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4138 -"objectType": "Vehicle", - Тип объекта
4139 -"details": {
4140 -"items": [ {
4141 -"name": "ObjectName", - наименование столбца
4142 -"value": "01" - содержание столбца
4143 -},
4144 -
4145 -{
4146 -"parentName": "string",
4147 -"name": "string",
4148 -"picture": "string",
4149 -"minspeed": 0,
4150 -"maxspeed": 0,
4151 -"width": 0,
4152 -"imbeddedtrailer": true,
4153 -"hoppercapacity": 0,
4154 -"hopperdischargespeed": 0,
4155 -"modelType": 0,
4156 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4157 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4158 -"deleted": true
4159 -}
4160 -
4161 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4162 -
4163 -(% class="box infomessage" %)
4164 -(((
4165 -POST/api/v3/Vehicles/recyclebin/erase
4166 -)))
4167 -
4168 -В заголовках запроса: X-Auth: Токен авторизации
4169 -
4170 -Параметры в теле запроса (JSON):
4171 -[
4172 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4173 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4174 -]
4175 -
4176 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4177 -
4178 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4179 -
4180 -(% class="box infomessage" %)
4181 -(((
4182 -POST/api/v3/Vehicles/recyclebin/restore
4183 -)))
4184 -
4185 -В заголовках запроса: X-Auth: Токен авторизации
4186 -
4187 -Параметры в теле запроса (JSON):
4188 -[
4189 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4190 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4191 -]
4192 -
4193 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4194 -
4195 -
4196 -
4197 4197  (% class="box" lang="en-US" style="text-align: center;" %)
4198 4198  (((
4199 4199  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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