Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 96.3 >
edited by Илья Крайнов
on 2023/06/30 15:22
To version < 120.1 >
edited by Илья Крайнов
on 2023/11/27 09:31
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,7 +40,6 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,6 +55,12 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
102 + "agentId": "",  (%%)
103 + "parentId": "",
104 + "parentName": "string",
105 + "name": "string",
106 + "fullName": "string",
107 + "agentInfoType": 0,
108 + "isForeign": true/false,
109 + "district": "string", 
110 + "region": "string",
111 + "city": "string",
112 + "inn": "string",
113 + "kpp": "string",
114 + "address": "string",
115 + "addressFact": "string",
116 + "email": "string",
117 + "director": "string",
118 + "bankName": "string",
119 + "bankBIK": "string",
120 + "bankRS": "string",
121 + "bankKS": "string"
118 118   }
119 119  
124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,25 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "parentName": "string",
177 + "name": "string",
178 + "fullName": "string",
179 + "agentInfoType": 0,
180 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
183 +
184 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
191 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
192 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
211 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
257 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
258 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
259 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
260 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
261 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
262 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
263 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
264 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
265 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
266 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
267 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
268 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
269 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
270 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
271 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
272 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
273 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
274 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
275 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
276 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
277 +
220 220  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -363,7 +363,6 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 369  
... ... @@ -392,6 +392,7 @@
392 392  (% style="text-align:left" %)
393 393  (% style="color:#000000; font-weight:normal" %)}
394 394  
450 +
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
397 397  (% class="box infomessage" %)
... ... @@ -682,6 +682,249 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
741 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
742 +
743 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
744 +
745 +(% class="box infomessage" %)
746 +(((
747 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
748 +)))
749 +
750 +Метод возвращает полную информацию о модели объекта.
751 +
752 +(% style="color:#000000" %)Метод запроса: **GET**
753 +
754 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
755 +
756 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
757 +
758 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
759 +
760 +(% style="color:#000000" %)Ответ:
761 +
762 +(% style="color:#000000" %){
763 + "parentName": "string",
764 + "name": "string",
765 + "picture": "string",
766 + "minspeed": 0,
767 + "maxspeed": 0,
768 + "width": 0,
769 + "imbeddedtrailer": true,
770 + "hoppercapacity": 0,
771 + "hopperdischargespeed": 0,
772 + "modelType": 0,
773 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
774 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
775 + "deleted": true
776 +}
777 +
778 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
779 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
780 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
781 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
782 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
783 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
784 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
785 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
786 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
787 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
788 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
789 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
790 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
791 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
792 +
793 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
794 +
795 +(% class="box successmessage" %)
796 +(((
797 +(% lang="en-US" %)**POST /api/v3/models/find**
798 +)))
799 +
800 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
801 +
802 +(% style="color:#000000" %)Метод запроса: **POST**
803 +
804 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
805 +
806 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
807 +
808 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
809 +
810 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
811 +}
812 +
813 +(% style="color:#000000" %)Ответ:
814 +
815 +(% style="color:#000000" %)[
816 + {
817 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
818 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
819 + "parentName": "string",
820 + "name": "string",
821 + "modelType": 0
822 + }
823 +]
824 +
825 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
826 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
827 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
828 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
829 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
830 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
831 +
832 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
833 +
834 +(% class="box successmessage" %)
835 +(((
836 +(% lang="en-US" %)**POST /api/v3/models**
837 +)))
838 +
839 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
840 +
841 +(% style="color:#000000" %)Метод запроса: **POST**
842 +
843 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
844 +
845 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
846 +
847 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
848 +
849 +{
850 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
852 + "deleted": true,
853 + "extId": "string",
854 + "name": "string",
855 + "picture": "string",
856 + "minspeed": 0,
857 + "maxspeed": 0,
858 + "width": 0,
859 + "imbeddedtrailer": true,
860 + "fueloutlay": 0,
861 + "hoppercapacity": 0,
862 + "hopperdischargespeed": 0,
863 + "modelType": 0
864 +}
865 +
866 +Ответ:
867 +
868 +{
869 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
871 + "deleted": true,
872 + "extId": "string",
873 + "name": "string",
874 + "picture": "string",
875 + "minspeed": 0,
876 + "maxspeed": 0,
877 + "width": 0,
878 + "imbeddedtrailer": true,
879 + "hoppercapacity": 0,
880 + "hopperdischargespeed": 0,
881 + "modelType": 0
882 +}
883 +
884 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
885 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
886 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
887 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
888 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
889 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
890 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
891 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
892 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
893 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
894 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
895 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
896 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
897 +
898 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
899 +
900 +(% class="box warningmessage" %)
901 +(((
902 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
903 +)))
904 +
905 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
906 +
907 +(% style="color:#000000" %)Метод запроса: **PUT**
908 +
909 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
910 +
911 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
912 +
913 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
914 +
915 +{
916 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
917 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
918 + "deleted": true,
919 + "extId": "string",
920 + "name": "string",
921 + "picture": "string",
922 + "minspeed": 0,
923 + "maxspeed": 0,
924 + "width": 0,
925 + "imbeddedtrailer": true,
926 + "fueloutlay": 0,
927 + "hoppercapacity": 0,
928 + "hopperdischargespeed": 0,
929 + "modelType": 0
930 +}
931 +
932 +Ответ:
933 +
934 +{
935 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
936 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
937 + "deleted": true,
938 + "extId": "string",
939 + "name": "string",
940 + "picture": "string",
941 + "minspeed": 0,
942 + "maxspeed": 0,
943 + "width": 0,
944 + "imbeddedtrailer": true,
945 + "fueloutlay": 0,
946 + "hoppercapacity": 0,
947 + "hopperdischargespeed": 0,
948 + "modelType": 0
949 +}
950 +
951 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
952 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
953 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
954 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
955 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
956 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
957 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
958 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
959 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
960 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
961 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
962 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
963 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
964 +
965 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
966 +
967 +(% class="box errormessage" %)
968 +(((
969 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
970 +)))
971 +
972 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
973 +
974 +(% style="color:#000000" %)Метод запроса: **DELETE**
975 +
976 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
977 +
978 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
979 +
980 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
981 +
982 +Ответ: В случае успеха **Success 200**
983 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1255,7 +1255,7 @@
1255 1255  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1256 1256  
1257 1257  (% style="color:#000000" %){
1258 -
1557 + "vehicleId": , ~/~/ ID объекта
1259 1259   "parentId": "" , ~/~/ ID клиента
1260 1260   "name": "" , ~/~/ имя ТС
1261 1261   "imei": "" , ~/~/ IMEI
... ... @@ -1622,6 +1622,267 @@
1622 1622   }
1623 1623  ]
1624 1624  
1924 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1925 +
1926 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1927 +
1928 +(% class="box infomessage" %)
1929 +(((
1930 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1931 +)))
1932 +
1933 +(% style="color:#000000" %)Метод запроса: **POST**
1934 +
1935 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
1936 +
1937 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1938 +
1939 +(% style="text-align:left" %)
1940 +Тело запроса:
1941 +
1942 +{
1943 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1944 + "vehicleIds": [0], ~/~/ Список ID объектов
1945 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1946 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
1947 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1948 +}
1949 +
1950 +Ответ:
1951 +
1952 +[
1953 + {
1954 + "vehicleId": 0, ~/~/ ID объекта
1955 + "name": "string", ~/~/ Имя ТС
1956 + "periods": [ ~/~/ Периоды
1957 + {
1958 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1959 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1960 + "mileageBegin": 0, ~/~/ Пробег на начало периода
1961 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
1962 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1963 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
1964 + }
1965 + ]
1966 + }
1967 +]
1968 +
1969 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
1970 +
1971 +(% class="box infomessage" %)
1972 +(((
1973 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
1974 +)))
1975 +
1976 +(% style="color:#000000" %)Метод запроса: **POST**
1977 +
1978 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
1979 +
1980 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1981 +
1982 +(% style="text-align:left" %)
1983 +Тело запроса:
1984 +
1985 +{
1986 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1987 + "vehicleIds": [0], ~/~/ Список ID объектов
1988 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1989 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
1990 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1991 +}
1992 +
1993 +Ответ:
1994 +
1995 +[
1996 + {
1997 + "vehicleId": 0, ~/~/ ID объекта
1998 + "name": "string", ~/~/ Имя ТС
1999 + "periods": [ ~/~/ Периоды
2000 + {
2001 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2002 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2003 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2004 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2005 + "fuelConsumption": 0, ~/~/ Расход топлива
2006 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2007 + }
2008 + ]
2009 + }
2010 +]
2011 +
2012 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2013 +
2014 +(% class="box infomessage" %)
2015 +(((
2016 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2017 +)))
2018 +
2019 +(% style="color:#000000" %)Метод запроса: **POST**
2020 +
2021 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2022 +
2023 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2024 +
2025 +(% style="text-align:left" %)
2026 +Тело запроса:
2027 +
2028 +{
2029 + "vehicleIds": [0], ~/~/ Список ID объектов
2030 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2031 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2032 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2033 +}
2034 +
2035 +Ответ:
2036 +
2037 +[
2038 + {
2039 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2040 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2041 + "vehicleId": 0, ~/~/ ID объекта
2042 + "name": "string", ~/~/ Имя объекта
2043 + "model": "string", ~/~/ Модель объекта
2044 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2045 + {
2046 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2047 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2048 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2049 + "valueFuel": 0, ~/~/ Количество
2050 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2051 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2052 + }
2053 + ]
2054 + }
2055 +]
2056 +
2057 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2058 +
2059 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2060 +
2061 +(% class="box infomessage" %)
2062 +(((
2063 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2064 +)))
2065 +
2066 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2067 +
2068 +(% style="color:#000000" %)Метод запроса: **POST**
2069 +
2070 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2071 +
2072 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2073 +
2074 +(% style="text-align:left" %)
2075 +Тело запроса:
2076 +
2077 +(% style="text-align:left" %)
2078 +{
2079 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2080 +}
2081 +
2082 +(% style="text-align:left" %)
2083 +Ответ:
2084 +
2085 +[
2086 + {
2087 + "id": 0, ~/~/ Идентификатор объекта геозоны
2088 + "name": "string", ~/~/ Название объекта геозоны
2089 + "type": 0, ~/~/ Тип объекта геозоны
2090 + "fname": "string", ~/~/ Имя файла
2091 + "parentId": "string", ~/~/ Идентификатор клиента
2092 + "radius": 0, ~/~/ Радиус геообъекта
2093 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2094 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2095 + "description": "string", ~/~/ Описание
2096 + "area": 0, ~/~/ Площадь, м^^2^^
2097 + "perimetr": 0, ~/~/ Периметр, м
2098 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2099 + }
2100 +]
2101 +
2102 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2103 +
2104 +(% class="box infomessage" %)
2105 +(((
2106 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2107 +)))
2108 +
2109 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2110 +
2111 +(% style="color:#000000" %)Метод запроса: **POST**
2112 +
2113 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2114 +
2115 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2116 +
2117 +(% style="text-align:left" %)
2118 +Тело запроса:
2119 +
2120 +{
2121 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2122 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2123 + "ids": [ ], ~/~/ Массив id объектов
2124 + "byTime": 0, ~/~/ Объединение событий по времени 
2125 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2126 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2127 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2128 +}
2129 +
2130 +Ответ:
2131 +[
2132 + {
2133 + "geozoneId": 0, ~/~/ ID геообъекта
2134 + "geozoneName": "string", ~/~/ Название геообъекта
2135 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2136 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2137 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2138 + "vehicleId": 0, ~/~/ ID объекта
2139 + "vehicleName": "string" ~/~/ Имя объекта
2140 + }
2141 +]
2142 +
2143 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2144 +
2145 +(% class="box infomessage" %)
2146 +(((
2147 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2148 +)))
2149 +
2150 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2151 +
2152 +(% style="color:#000000" %)Метод запроса: **POST**
2153 +
2154 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2155 +
2156 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2157 +
2158 +(% style="text-align:left" %)
2159 +Тело запроса:
2160 +
2161 +{
2162 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2163 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2164 + "ids": [ ], ~/~/ Массив id геообъектов
2165 + "byTime": 0, ~/~/ Объединение событий по времени 
2166 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2167 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2168 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2169 +}
2170 +
2171 +Ответ:
2172 +
2173 +[
2174 + {
2175 + "geozoneId": 0, ~/~/ ID геообъекта
2176 + "geozoneName": "string", ~/~/ Название геообъекта
2177 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2178 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2179 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2180 + "vehicleId": 0, ~/~/ ID объекта
2181 + "vehicleName": "string" ~/~/ Имя объекта
2182 + }
2183 +]
2184 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1823,82 +1823,130 @@
1823 1823  Success
1824 1824  
1825 1825  
1826 -= Раздел: **Водители** =
2386 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
1827 1827  
1828 -Получить список водителей клиента
2388 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
1829 1829  
1830 -POST /api/v3/Drivers/find
2390 +(% class="box infomessage" %)
2391 +(((
2392 +**POST /api/v3/Drivers/find**
2393 +)))
1831 1831  
1832 -Передается: parentId - ID клиента-родителя
2395 +Передается параметр: parentId - ID клиента-родителя
1833 1833  
1834 1834  Ответ:
1835 1835  
1836 -{{{[
2399 +[
1837 1837   {
1838 - "name": "string", //Определяет наименование
1839 - "description": "string", // Определяет описание
1840 - "hiredate": "2023-06-30T09:37:58.407Z", // Определяет дату найма
1841 - "chopdate": "2023-06-30T09:37:58.407Z", // Определяет дату увольнения
1842 - "exclusive": true, // Определяет признак "Исключительный"
1843 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя
1844 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
1845 - "deleted": true // Признак удаления
2401 + "name": "string", ~/~/ Определяет наименование
2402 + "description": "string", ~/~/ Определяет описание
2403 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2404 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2405 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2406 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2407 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2408 + "deleted": true ~/~/ Признак удаления
1846 1846   }
1847 -]}}}
2410 +]
1848 1848  
2412 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
1849 1849  
1850 -Получить данные о водителе
2414 +(% class="box infomessage" %)
2415 +(((
2416 +**GET /api/v3/Drivers/{driverGuid}**
2417 +)))
1851 1851  
1852 -GET /api/v3/Drivers/{driverGuid}
2419 +Передается параметр: ID водителя
1853 1853  
1854 -Передается ID водителя
1855 -
1856 1856  Ответ:
1857 1857  
1858 -{{{{
1859 - "name": "string", // Определяет наименование
1860 - "description": "string", // Определяет описание
1861 - "hiredate": "2023-06-30T09:33:33.083Z", // Определяет дату найма
1862 - "chopdate": "2023-06-30T09:33:33.083Z", // Определяет дату увольнения
1863 - "exclusive": true, // Определяет признак "Исключительный"
1864 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя
1865 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
1866 - "deleted": true // Признак удаления
2423 +{
2424 + "name": "string", ~/~/ Определяет наименование
2425 + "description": "string", ~/~/ Определяет описание
2426 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2427 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2428 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2429 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2430 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2431 + "deleted": true ~/~/ Признак удаления
1867 1867  }
1868 -}}}
1869 1869  
2434 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
1870 1870  
1871 -Добавить водителя
2436 +(% class="box successmessage" %)
2437 +(((
2438 +**POST /api/v3/Drivers**
2439 +)))
1872 1872  
1873 -POST /api/v3/Drivers
2441 +Запрос:
1874 1874  
1875 -Передается:
2443 +{
2444 + "name": "string",
2445 + "description": "string",
2446 + "hiredate": "2023-06-30T12:50:54.020Z",
2447 + "chopdate": "2023-06-30T12:50:54.020Z",
2448 + "exclusive": true,
2449 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2450 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2451 + "deleted": true
2452 +}
1876 1876  
1877 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:05.949Z", "chopdate": "2023-06-30T09:43:05.949Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
1878 -
1879 1879  Ответ:
1880 1880  
1881 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:06.014Z", "chopdate": "2023-06-30T09:43:06.014Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2456 +{
2457 + "name": "string",
2458 + "description": "string",
2459 + "hiredate": "2023-06-30T12:50:54.051Z",
2460 + "chopdate": "2023-06-30T12:50:54.051Z",
2461 + "exclusive": true,
2462 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2463 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2464 + "deleted": true
2465 +}
1882 1882  
1883 1883  
1884 -Редактировать водителя
2468 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
1885 1885  
1886 -PUT /api/v3/Drivers
2470 +(% class="box warningmessage" %)
2471 +(((
2472 +**PUT /api/v3/Drivers**
2473 +)))
1887 1887  
1888 -Передается:
2475 +Запрос:
1889 1889  
1890 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.382Z", "chopdate": "2023-06-30T09:45:41.382Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2477 +{
2478 + "name": "string",
2479 + "description": "string",
2480 + "hiredate": "2023-06-30T12:50:27.910Z",
2481 + "chopdate": "2023-06-30T12:50:27.910Z",
2482 + "exclusive": true,
2483 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2484 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2485 + "deleted": true
2486 +}
1891 1891  
1892 1892  Ответ:
1893 1893  
1894 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.433Z", "chopdate": "2023-06-30T09:45:41.433Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2490 +{
2491 + "name": "string",
2492 + "description": "string",
2493 + "hiredate": "2023-06-30T12:50:27.929Z",
2494 + "chopdate": "2023-06-30T12:50:27.929Z",
2495 + "exclusive": true,
2496 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2497 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2498 + "deleted": true
2499 +}
1895 1895  
1896 1896  
1897 -Удалить водителя
2502 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
1898 1898  
1899 -DELETE /api/v3/Drivers/{driverGuid}
2504 +(% class="box errormessage" %)
2505 +(((
2506 +**DELETE /api/v3/Drivers/{driverGuid}**
2507 +)))
1900 1900  
1901 -Передается ID водителя
2509 +Передается параметр: ID водителя
1902 1902  
1903 1903  Ответ:
1904 1904  
... ... @@ -1905,21 +1905,30 @@
1905 1905  Success
1906 1906  
1907 1907  
1908 -= Раздел: **Журнал назначений** =
2516 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
1909 1909  
1910 -**Назначение водителя на объект**
2518 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
1911 1911  
1912 -Получить назначения водителей запросом к водителю
2520 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
1913 1913  
1914 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers
2522 +(% class="box infomessage" %)
2523 +(((
2524 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2525 +)))
1915 1915  
1916 -Передаем:
2527 +Запрос:
1917 1917  
1918 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T09:52:31.196Z", "EndTime": "2023-06-30T09:52:31.196Z" }}}}
2529 +{
2530 + "Ids": [
2531 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2532 + ],
2533 + "BeginTime": "2023-06-30T12:49:04.365Z",
2534 + "EndTime": "2023-06-30T12:49:04.365Z"
2535 +}
1919 1919  
1920 1920  Ответ:
1921 1921  
1922 -{{{[
2539 +[
1923 1923   {
1924 1924   "VehicleId": 0,
1925 1925   "CreateTime": "2023-06-30T09:52:31.240Z",
... ... @@ -1928,20 +1928,29 @@
1928 1928   "BeginTime": "2023-06-30T09:52:31.240Z",
1929 1929   "EndTime": "2023-06-30T09:52:31.240Z"
1930 1930   }
1931 -]}}}
2548 +]
1932 1932  
1933 1933  
1934 -Получить назначения водителей запросом к объекту
2551 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
1935 1935  
1936 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles
2553 +(% class="box infomessage" %)
2554 +(((
2555 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2556 +)))
1937 1937  
1938 -Передаем:
2558 +Запрос:
1939 1939  
1940 -{{{{ "Ids": [ 0 ], "BeginTime": "2023-06-30T09:54:01.583Z", "EndTime": "2023-06-30T09:54:01.583Z" }}}}
2560 +{
2561 + "Ids": [
2562 + 0
2563 + ],
2564 + "BeginTime": "2023-06-30T12:48:39.419Z",
2565 + "EndTime": "2023-06-30T12:48:39.419Z"
2566 +}
1941 1941  
1942 1942  Ответ:
1943 1943  
1944 -{{{[
2570 +[
1945 1945   {
1946 1946   "VehicleId": 0,
1947 1947   "CreateTime": "2023-06-30T09:54:01.631Z",
... ... @@ -1950,30 +1950,33 @@
1950 1950   "BeginTime": "2023-06-30T09:54:01.631Z",
1951 1951   "EndTime": "2023-06-30T09:54:01.631Z"
1952 1952   }
1953 -]}}}
2579 +]
1954 1954  
1955 1955  
1956 -Создать назначение водителя на объект
2582 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
1957 1957  
1958 -POST /api/v3/DriversVehiclesAssignments
2584 +(% class="box successmessage" %)
2585 +(((
2586 +**POST /api/v3/DriversVehiclesAssignments**
2587 +)))
1959 1959  
1960 1960  Передается массив назначений
1961 1961  
1962 1962  Запрос:
1963 1963  
1964 -{{{[
2593 +[
1965 1965   {
1966 - "VehicleId": 0, // Идентификатор объекта
1967 - "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения
1968 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
1969 - "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения
1970 - "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно.
2595 + "VehicleId": 0, ~/~/ Идентификатор объекта
2596 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2597 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2598 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2599 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
1971 1971   }
1972 -]}}}
2601 +]
1973 1973  
1974 1974  Ответ:
1975 1975  
1976 -{{{[
2605 +[
1977 1977   {
1978 1978   "VehicleId": 0,
1979 1979   "CreateTime": "2023-06-30T11:04:46.903Z",
... ... @@ -1982,29 +1982,32 @@
1982 1982   "BeginTime": "2023-06-30T11:04:46.903Z",
1983 1983   "EndTime": "2023-06-30T11:04:46.903Z"
1984 1984   }
1985 -]}}}
2614 +]
1986 1986  
1987 1987  
1988 -Изменить назначения водителей на объекты
2617 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
1989 1989  
1990 -PUT /api/v3/DriversVehiclesAssignments
2619 +(% class="box warningmessage" %)
2620 +(((
2621 +**PUT /api/v3/DriversVehiclesAssignments**
2622 +)))
1991 1991  
1992 1992  Запрос:
1993 1993  
1994 -{{{[
2626 +[
1995 1995   {
1996 1996   "VehicleId": 0,
1997 1997   "CreateTime": "2023-06-30T11:14:08.117Z",
1998 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2630 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
1999 1999   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2000 2000   "BeginTime": "2023-06-30T11:14:08.117Z",
2001 2001   "EndTime": "2023-06-30T11:14:08.117Z"
2002 2002   }
2003 -]}}}
2635 +]
2004 2004  
2005 2005  Ответ:
2006 2006  
2007 -{{{[
2639 +[
2008 2008   {
2009 2009   "VehicleId": 0,
2010 2010   "CreateTime": "2023-06-30T11:14:53.349Z",
... ... @@ -2013,91 +2013,99 @@
2013 2013   "BeginTime": "2023-06-30T11:14:53.349Z",
2014 2014   "EndTime": "2023-06-30T11:14:53.349Z"
2015 2015   }
2016 -]}}}
2648 +]
2017 2017  
2018 2018  
2019 -Удалить назначения водителей на объекты
2651 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2020 2020  
2021 -DELETE /api/v3/DriversVehiclesAssignments
2653 +(% class="box errormessage" %)
2654 +(((
2655 +**DELETE /api/v3/DriversVehiclesAssignments**
2656 +)))
2022 2022  
2023 2023  Запрос:
2024 2024  
2025 -{{{[
2026 - {
2027 - "VehicleId": 0,
2028 - "CreateTime": "2023-06-30T11:16:08.341Z",
2029 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2030 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2031 - "BeginTime": "2023-06-30T11:16:08.342Z",
2032 - "EndTime": "2023-06-30T11:16:08.342Z"
2033 - }
2034 -]}}}
2660 +[
2661 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2662 +]
2035 2035  
2036 2036  Ответ:
2037 2037  
2038 -{{{[
2039 - {
2040 - "VehicleId": 0,
2041 - "CreateTime": "2023-06-30T11:16:08.344Z",
2042 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2043 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2044 - "BeginTime": "2023-06-30T11:16:08.344Z",
2045 - "EndTime": "2023-06-30T11:16:08.344Z"
2046 - }
2047 -]}}}
2666 +Success
2048 2048  
2049 2049  
2050 -**Назначение карты-метки водителю**
2669 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2051 2051  
2052 -Получить назначения меток запросом к водителю
2671 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2053 2053  
2054 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2673 +(% class="box infomessage" %)
2674 +(((
2675 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2676 +)))
2055 2055  
2056 2056  Запрос:
2057 2057  
2058 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы водителей ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}}
2680 +{
2681 + "Ids": [
2682 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2683 + ],
2684 + "BeginTime": "2023-06-30T12:47:12.162Z",
2685 + "EndTime": "2023-06-30T12:47:12.162Z"
2686 +}
2059 2059  
2060 2060  Ответ:
2061 2061  
2062 -{{{[
2690 +[
2063 2063   {
2064 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2065 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2066 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2692 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2693 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2694 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2067 2067   "BeginTime": "2023-06-30T11:19:40.703Z",
2068 2068   "EndTime": "2023-06-30T11:19:40.703Z"
2069 2069   }
2070 -]}}}
2698 +]
2071 2071  
2072 2072  
2073 -Получить назначения меток запросом к карте-метке
2701 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2074 2074  
2075 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2703 +(% class="box infomessage" %)
2704 +(((
2705 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2706 +)))
2076 2076  
2077 2077  Запрос:
2078 2078  
2079 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы карт-меток ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}}
2710 +{
2711 + "Ids": [
2712 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2713 + ],
2714 + "BeginTime": "2023-06-30T12:47:12.162Z",
2715 + "EndTime": "2023-06-30T12:47:12.162Z"
2716 +}
2080 2080  
2081 2081  Ответ:
2082 2082  
2083 -{{{[
2720 +[
2084 2084   {
2085 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2086 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2087 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2722 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2723 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2724 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2088 2088   "BeginTime": "2023-06-30T11:19:40.703Z",
2089 2089   "EndTime": "2023-06-30T11:19:40.703Z"
2090 2090   }
2091 -]}}}
2728 +]
2092 2092  
2093 2093  
2094 -Добавить назначения меток на водителей.
2731 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2095 2095  
2096 -POST /api/v3/DriversRfidsAssignments
2733 +(% class="box successmessage" %)
2734 +(((
2735 +**POST /api/v3/DriversRfidsAssignments**
2736 +)))
2097 2097  
2098 2098  Запрос:
2099 2099  
2100 -{{{[
2740 +[
2101 2101   {
2102 2102   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2103 2103   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2104,11 +2104,11 @@
2104 2104   "BeginTime": "2023-06-30T11:27:08.635Z",
2105 2105   "EndTime": "2023-06-30T11:27:08.635Z"
2106 2106   }
2107 -]}}}
2747 +]
2108 2108  
2109 2109  Ответ:
2110 2110  
2111 -{{{[
2751 +[
2112 2112   {
2113 2113   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2114 2114   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2116,16 +2116,19 @@
2116 2116   "BeginTime": "2023-06-30T11:27:08.677Z",
2117 2117   "EndTime": "2023-06-30T11:27:08.677Z"
2118 2118   }
2119 -]}}}
2759 +]
2120 2120  
2121 2121  
2122 -Изменить назначения меток на водителей
2762 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2123 2123  
2124 -PUT /api/v3/DriversRfidsAssignments
2764 +(% class="box warningmessage" %)
2765 +(((
2766 +**PUT /api/v3/DriversRfidsAssignments**
2767 +)))
2125 2125  
2126 2126  Запрос:
2127 2127  
2128 -{{{[
2771 +[
2129 2129   {
2130 2130   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2131 2131   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2133,11 +2133,11 @@
2133 2133   "BeginTime": "2023-06-30T11:28:43.330Z",
2134 2134   "EndTime": "2023-06-30T11:28:43.330Z"
2135 2135   }
2136 -]}}}
2779 +]
2137 2137  
2138 2138  Ответ:
2139 2139  
2140 -{{{[
2783 +[
2141 2141   {
2142 2142   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2143 2143   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2145,51 +2145,49 @@
2145 2145   "BeginTime": "2023-06-30T11:28:43.331Z",
2146 2146   "EndTime": "2023-06-30T11:28:43.331Z"
2147 2147   }
2148 -]}}}
2791 +]
2149 2149  
2150 2150  
2151 -Удалить назначения меток на водителей
2794 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2152 2152  
2153 -DELETE /api/v3/DriversRfidsAssignments
2796 +(% class="box errormessage" %)
2797 +(((
2798 +**DELETE /api/v3/DriversRfidsAssignments**
2799 +)))
2154 2154  
2155 2155  Запрос:
2156 2156  
2157 -{{{[
2158 - {
2159 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2160 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2161 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2162 - "BeginTime": "2023-06-30T11:28:43.330Z",
2163 - "EndTime": "2023-06-30T11:28:43.330Z"
2164 - }
2165 -]}}}
2803 +[
2804 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2805 +]
2166 2166  
2167 2167  Ответ:
2168 2168  
2169 -{{{[
2170 - {
2171 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2172 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2173 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2174 - "BeginTime": "2023-06-30T11:28:43.331Z",
2175 - "EndTime": "2023-06-30T11:28:43.331Z"
2176 - }
2177 -]}}}
2809 +Success
2178 2178  
2179 2179  
2180 -== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначение топливной карты водителю**(%%) ==
2812 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2181 2181  
2182 2182  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2183 2183  
2184 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
2816 +(% class="box infomessage" %)
2817 +(((
2818 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2819 +)))
2185 2185  
2186 2186  Запрос:
2187 2187  
2188 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}}
2823 +{
2824 + "Ids": [
2825 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2826 + ],
2827 + "BeginTime": "2023-06-30T12:45:10.852Z",
2828 + "EndTime": "2023-06-30T12:45:10.852Z"
2829 +}
2189 2189  
2190 2190  Ответ:
2191 2191  
2192 -{{{[
2833 +[
2193 2193   {
2194 2194   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2195 2195   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2197,20 +2197,29 @@
2197 2197   "BeginTime": "2023-06-30T11:58:04.695Z",
2198 2198   "EndTime": "2023-06-30T11:58:04.695Z"
2199 2199   }
2200 -]}}}
2841 +]
2201 2201  
2202 2202  
2203 2203  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2204 2204  
2205 -POST /api/v3/DriversFuelCardsAssignments/GetByCards
2846 +(% class="box infomessage" %)
2847 +(((
2848 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2849 +)))
2206 2206  
2207 2207  Запрос:
2208 2208  
2209 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}}
2853 +{
2854 + "Ids": [
2855 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2856 + ],
2857 + "BeginTime": "2023-06-30T12:45:10.852Z",
2858 + "EndTime": "2023-06-30T12:45:10.852Z"
2859 +}
2210 2210  
2211 2211  Ответ:
2212 2212  
2213 -{{{[
2863 +[
2214 2214   {
2215 2215   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2216 2216   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2218,16 +2218,19 @@
2218 2218   "BeginTime": "2023-06-30T11:58:04.695Z",
2219 2219   "EndTime": "2023-06-30T11:58:04.695Z"
2220 2220   }
2221 -]}}}
2871 +]
2222 2222  
2223 2223  
2224 2224  === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2225 2225  
2226 -POST /api/v3/DriversFuelCardsAssignments
2876 +(% class="box successmessage" %)
2877 +(((
2878 +**POST /api/v3/DriversFuelCardsAssignments**
2879 +)))
2227 2227  
2228 2228  Запрос:
2229 2229  
2230 -{{{[
2883 +[
2231 2231   {
2232 2232   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2233 2233   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2234,11 +2234,11 @@
2234 2234   "BeginTime": "2023-06-30T12:09:53.175Z",
2235 2235   "EndTime": "2023-06-30T12:09:53.175Z"
2236 2236   }
2237 -]}}}
2890 +]
2238 2238  
2239 2239  Ответ:
2240 2240  
2241 -{{{[
2894 +[
2242 2242   {
2243 2243   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2244 2244   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2246,27 +2246,31 @@
2246 2246   "BeginTime": "2023-06-30T12:09:53.201Z",
2247 2247   "EndTime": "2023-06-30T12:09:53.201Z"
2248 2248   }
2249 -]}}}
2902 +]
2250 2250  
2251 2251  
2252 2252  === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2253 2253  
2254 -PUT /api/v3/DriversFuelCardsAssignments
2907 +(% class="box warningmessage" %)
2908 +(((
2909 +**PUT /api/v3/DriversFuelCardsAssignments**
2910 +)))
2255 2255  
2256 2256  Запрос:
2257 2257  
2258 -{{{[
2914 +[
2259 2259   {
2260 2260   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2917 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2261 2261   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2262 - "BeginTime": "2023-06-30T12:09:53.175Z",
2263 - "EndTime": "2023-06-30T12:09:53.175Z"
2919 + "BeginTime": "2023-06-30T12:09:53.201Z",
2920 + "EndTime": "2023-06-30T12:09:53.201Z"
2264 2264   }
2265 -]}}}
2922 +]
2266 2266  
2267 2267  Ответ:
2268 2268  
2269 -{{{[
2926 +[
2270 2270   {
2271 2271   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2272 2272   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2274,103 +2274,241 @@
2274 2274   "BeginTime": "2023-06-30T12:09:53.201Z",
2275 2275   "EndTime": "2023-06-30T12:09:53.201Z"
2276 2276   }
2277 -]}}}
2934 +]
2278 2278  
2279 2279  
2280 2280  === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2281 2281  
2282 -DELETE /api/v3/DriversFuelCardsAssignments
2939 +(% class="box errormessage" %)
2940 +(((
2941 +**DELETE /api/v3/DriversFuelCardsAssignments**
2942 +)))
2283 2283  
2284 2284  Запрос:
2285 2285  
2286 -{{{[
2287 - {
2288 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2289 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2290 - "BeginTime": "2023-06-30T12:09:53.175Z",
2291 - "EndTime": "2023-06-30T12:09:53.175Z"
2292 - }
2293 -]}}}
2946 +[
2947 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2948 +]
2294 2294  
2295 2295  Ответ:
2296 2296  
2297 -{{{[
2952 +Success
2953 +
2954 +
2955 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
2956 +
2957 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
2958 +
2959 +(% class="box infomessage" %)
2960 +(((
2961 +**POST /api/v3/Trailers**
2962 +)))
2963 +
2964 +Пример запроса:
2965 +
2966 +{
2967 + "startDate": "2023-11-14T10:48:03.671Z",
2968 + "endDate": "2023-11-14T10:48:03.671Z",
2969 + "ids": [ 0 ],
2970 + "timezone": 0
2971 +}
2972 +
2973 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2974 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
2975 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
2976 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
2977 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
2978 +
2979 +Пример ответа:
2980 +
2981 +[
2298 2298   {
2299 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2300 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2301 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2302 - "BeginTime": "2023-06-30T12:09:53.201Z",
2303 - "EndTime": "2023-06-30T12:09:53.201Z"
2983 + "SD": "2023-11-14T10:48:03.717Z",
2984 + "ED": "2023-11-14T10:48:03.717Z", 
2985 + "id": 0,
2986 + "SLat": 0,
2987 + "SLon": 0,
2988 + "ELat": 0,
2989 + "ELon": 0,
2990 + "mileage": 0
2991 + "Duration": 0
2992 + "Address": "string",
2993 + "Address2": "string",
2994 + "name": "string",
2995 + "rid": "string",
2996 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2997 + "trailer": {
2998 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 + "Number": "string",
3000 + "Description": "string",
3001 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3002 + "ExternalID": "string",
3003 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3004 + "CreateTime": "2023-11-14T10:48:03.717Z",
3005 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3006 + "IsDeleted": true
3007 + },
3008 + "filesCount": 0,
2304 2304   }
2305 -]}}}
3010 +]
2306 2306  
3012 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3013 +|SD|Дата и время начала события
3014 +|ED|Дата и время окончания события
3015 +|id|ID объекта
3016 +|SLat|Широта начальной координаты
3017 +|SLon|Долгота начальной координаты
3018 +|ELat|Широта конечной координаты
3019 +|ELon|Долгота конечной координаты
3020 +|mileage|Пробег
3021 +|Duration|Продолжительность
3022 +|Address|Адрес начального местоположения
3023 +|Address2|Адрес конечного местоположения
3024 +|name|Имя радиометки
3025 +|rid|Номер радиометки
3026 +|rguid|ID радиометки
3027 +|trailer|Информация об агрегате
3028 +|ModelGuid|ID агрегата
3029 +|Number|Название/номер агрегата
3030 +|Description|Текст примечания агрегата
2307 2307  
2308 2308  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2309 2309  
2310 2310  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2311 2311  
2312 -POST /api/v3/Rfids/find
3036 +(% class="box infomessage" %)
3037 +(((
3038 +**POST /api/v3/Rfids/find**
3039 +)))
2313 2313  
2314 2314  Запрос:
2315 2315  
2316 -{{{{ "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }}}}
3043 +{
3044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3045 +}
2317 2317  
2318 2318  Ответ:
2319 2319  
2320 -{{{[
3049 +[
2321 2321   {
2322 2322   "name": "string",
2323 2323   "number": 0,
2324 - "period": 0, // Частота трансляции радиометки
3053 + "period": 0,
2325 2325   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2326 2326   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2327 - "deleted": true
2328 2328   }
2329 -]}}}
3057 +]
2330 2330  
3059 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3060 +|parentId|ID клиента
3061 +|name|Название карты-метки
3062 +|number|Номер
3063 +|period|Период запросов в секундах (работает только для агрегатов)
3064 +|id|ID карты-метки
2331 2331  
2332 2332  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2333 2333  
2334 -GET /api/v3/Rfids/{rfidGuid}
3068 +(% class="box infomessage" %)
3069 +(((
3070 +**GET /api/v3/Rfids/{rfidGuid}**
3071 +)))
2335 2335  
2336 2336  Передаем параметр rfidGuid - идентификатор карты-метки
2337 2337  
2338 2338  Ответ:
2339 2339  
2340 -{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
3077 +[
3078 + {
3079 + "name": "string",
3080 + "number": 0,
3081 + "period": 0,
3082 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 + }
3085 +]
2341 2341  
3087 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3088 +|name|Название карты-метки
3089 +|number|Номер
3090 +|period|Период запросов в секундах (работает только для агрегатов)
3091 +|id|ID карты-метки
3092 +|parentId|ID клиента
2342 2342  
2343 2343  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2344 2344  
2345 -POST /api/v3/Rfids
3096 +(% class="box successmessage" %)
3097 +(((
3098 +**POST /api/v3/Rfids**
3099 +)))
2346 2346  
2347 2347  Запрос:
2348 2348  
2349 -{{{{ "name": "string", "number": 0, "period": 0, "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
3103 +{
3104 + "name": "string",
3105 + "number": 0,
3106 + "period": 0,
3107 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3108 +}
2350 2350  
2351 2351  Ответ:
2352 2352  
2353 -{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
3112 +{
3113 + "name": "string",
3114 + "number": 0,
3115 + "period": 0,
3116 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3117 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3118 +}
2354 2354  
3120 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3121 +|name|Название карты-метки
3122 +|number|Номер
3123 +|period|Период запросов в секундах (работает только для агрегатов)
3124 +|id|ID карты-метки
3125 +|parentId|ID клиента
2355 2355  
2356 2356  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2357 2357  
2358 -PUT /api/v3/Rfids
3129 +(% class="box warningmessage" %)
3130 +(((
3131 +**PUT /api/v3/Rfids**
3132 +)))
2359 2359  
2360 2360  Запрос:
2361 2361  
2362 -{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
3136 +{
3137 + "name": "string",
3138 + "number": 0,
3139 + "period": 0,
3140 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3141 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3142 +}
2363 2363  
2364 2364  Ответ:
2365 2365  
2366 -{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
3146 +{
3147 + "name": "string",
3148 + "number": 0,
3149 + "period": 0,
3150 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 +}
2367 2367  
3154 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3155 +|name|Название карты-метки
3156 +|number|Номер
3157 +|period|Период запросов в секундах (работает только для агрегатов)
3158 +|id|ID карты-метки
3159 +|parentId|ID клиента
2368 2368  
2369 2369  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2370 2370  
2371 -DELETE /api/v3/Rfids/{rfidGuid}
3163 +(% class="box errormessage" %)
3164 +(((
3165 +**DELETE /api/v3/Rfids/{rfidGuid}**
3166 +)))
2372 2372  
2373 -Передаем параметр rfidGuid - идентификатор карты-метки
3168 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2374 2374  
2375 2375  Ответ:
2376 2376  
... ... @@ -2377,6 +2377,538 @@
2377 2377  Success
2378 2378  
2379 2379  
3175 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3176 +
3177 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3178 +
3179 +(% class="box infomessage" %)
3180 +(((
3181 +**GET /api/v3/Billing/client/balance/{clientId}**
3182 +)))
3183 +
3184 +Параметр запроса: **clientId **- идентификатор клиента.
3185 +
3186 +Ответ:
3187 +
3188 +{
3189 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3190 + "Balance": 0
3191 +}
3192 +
3193 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3194 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3195 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3196 +
3197 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3198 +
3199 +(% class="box infomessage" %)
3200 +(((
3201 +**GET /api/v3/Billing/client/constraint/{clientId}**
3202 +)))
3203 +
3204 +Параметр запроса: **clientId **- идентификатор клиента.
3205 +
3206 +Ответ:
3207 +
3208 +{
3209 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 + "CalculationType": 0,
3211 + "PermissibleBalance": 0,
3212 + "DefermentDays": 0,
3213 + "SendUiNotifications": true,
3214 + "SendEmailNotifications": true,
3215 + "IsPrivate": true,
3216 +}
3217 +
3218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3219 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3220 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3221 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3222 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3223 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3224 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3225 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3226 +
3227 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3228 +
3229 +(% class="box infomessage" %)
3230 +(((
3231 +**GET /api/v3/Billing/client/plan/{clientId}**
3232 +)))
3233 +
3234 +Параметры запроса:
3235 +
3236 +**clientId **- идентификатор клиента.
3237 +
3238 +**planId **- идентификатор тарифного плана.
3239 +
3240 +Ответ:
3241 +
3242 +{
3243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3244 + "Plan": { **~/~/ Описание тарифного плана**
3245 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 + "Name": "string",
3248 + "IsArchived": true,
3249 + "Constraint": {
3250 + "CalculationType": 0,
3251 + "PermissibleBalance": 0,
3252 + "DefermentDays": 0
3253 + },
3254 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3255 + {
3256 + "Feature": "string",
3257 + "IsFactual": true,
3258 + "Limit": 0,
3259 + "Price": 0,
3260 + "PeriodValue": 0,
3261 + "PeriodType": 0
3262 + }
3263 + ]
3264 + },
3265 + "DebitDate": "2023-10-18T12:46:24.213Z",
3266 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3267 + {
3268 + "Feature": "string",
3269 + "IsEnabled": true,
3270 + "IsPrivate": true,
3271 + "IsFactual": true,
3272 + "Limit": 0,
3273 + "Price": 0,
3274 + "DebitDate": "2023-10-18T12:46:24.213Z",
3275 + "PeriodValue": 0,
3276 + "PeriodType": 0
3277 + }
3278 + ]
3279 +}
3280 +
3281 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3282 +|ClientId|Идентификатор клиента
3283 +|Id|Идентификатор тарифного плана
3284 +|OwnerId|Идентификатор клиента-владельца
3285 +|Name|Наименование тарифного плана
3286 +|IsArchived|Признак, определяющий архивный тарифный план
3287 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3288 +|PermissibleBalance|Допустимый баланс
3289 +|DefermentDays|Отсрочка, количество дней
3290 +|Feature|Код услуги
3291 +|IsEnabled|Признак, определяющий активирована ли услуга
3292 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3293 +|IsFactual|Признак, определяющий расчёт по факту
3294 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3295 +|Price|Цена за единицу.
3296 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3297 +|PeriodValue|Значение периода.
3298 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3299 +
3300 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3301 +
3302 +(% class="box infomessage" %)
3303 +(((
3304 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3305 +)))
3306 +
3307 +Параметр запроса: **clientId **- идентификатор клиента.
3308 +
3309 +Ответ:
3310 +
3311 +[
3312 + {
3313 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3314 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 + "Name": "string",
3316 + "IsArchived": true,
3317 + "Constraint": {
3318 + "CalculationType": 0,
3319 + "PermissibleBalance": 0,
3320 + "DefermentDays": 0
3321 + },
3322 + "Features": [
3323 + {
3324 + "Feature": "string",
3325 + "IsFactual": true,
3326 + "Limit": 0,
3327 + "Price": 0,
3328 + "PeriodValue": 0,
3329 + "PeriodType": 0
3330 + }
3331 + ]
3332 + }
3333 +]
3334 +
3335 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3336 +|ClientId|Идентификатор клиента
3337 +|Id|Идентификатор тарифного плана
3338 +|OwnerId|Идентификатор клиента-владельца
3339 +|Name|Наименование тарифного плана
3340 +|IsArchived|Признак, определяющий архивный тарифный план
3341 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3342 +|PermissibleBalance|Допустимый баланс
3343 +|DefermentDays|Отсрочка, количество дней
3344 +|Feature|Код услуги
3345 +|IsFactual|Признак, определяющий расчёт по факту
3346 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3347 +|Price|Цена за единицу.
3348 +|PeriodValue|Значение периода.
3349 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3350 +
3351 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3352 +
3353 +(% class="box infomessage" %)
3354 +(((
3355 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3356 +)))
3357 +
3358 +Параметр запроса: **clientId **- идентификатор клиента.
3359 +
3360 +Ответ:
3361 +
3362 +[
3363 + {
3364 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3365 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3366 + "Name": "string",
3367 + "IsArchived": true,
3368 + "Constraint": {
3369 + "CalculationType": 0,
3370 + "PermissibleBalance": 0,
3371 + "DefermentDays": 0
3372 + },
3373 + "Features": [
3374 + {
3375 + "Feature": "string",
3376 + "IsFactual": true,
3377 + "Limit": 0,
3378 + "Price": 0,
3379 + "PeriodValue": 0,
3380 + "PeriodType": 0
3381 + }
3382 + ]
3383 + }
3384 +]
3385 +
3386 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3387 +|ClientId|Идентификатор клиента
3388 +|Id|Идентификатор тарифного плана
3389 +|OwnerId|Идентификатор клиента-владельца
3390 +|Name|Наименование тарифного плана
3391 +|IsArchived|Признак, определяющий архивный тарифный план
3392 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3393 +|PermissibleBalance|Допустимый баланс
3394 +|DefermentDays|Отсрочка, количество дней
3395 +|Feature|Код услуги
3396 +|IsFactual|Признак, определяющий расчёт по факту
3397 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3398 +|Price|Цена за единицу.
3399 +|PeriodValue|Значение периода.
3400 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3401 +
3402 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3403 +
3404 +(% class="box warningmessage" %)
3405 +(((
3406 +**PUT /api/v3/Billing/client/balance**
3407 +)))
3408 +
3409 +Тело запроса:
3410 +
3411 +{
3412 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 + "Balance": 0
3414 +}
3415 +
3416 +Ответ: Success
3417 +
3418 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3419 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3420 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3421 +
3422 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3423 +
3424 +(% class="box warningmessage" %)
3425 +(((
3426 +**PUT /api/v3/Billing/client/constraint**
3427 +)))
3428 +
3429 +Тело запроса:
3430 +
3431 +{
3432 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3433 + "CalculationType": 0,
3434 + "PermissibleBalance": 0,
3435 + "DefermentDays": 0,
3436 + "SendUiNotifications": true,
3437 + "SendEmailNotifications": true,
3438 + "IsPrivate": true,
3439 +}
3440 +
3441 +Ответ: Success
3442 +
3443 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3444 +|ClientId|Идентификатор клиента
3445 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3446 +|PermissibleBalance|Допустимый баланс
3447 +|DefermentDays|(((
3448 +Отсрочка, количество дней
3449 +)))
3450 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3451 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3452 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3453 +
3454 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3455 +
3456 +(% class="box warningmessage" %)
3457 +(((
3458 +**PUT /api/v3/Billing/client/plan**
3459 +)))
3460 +
3461 +Тело запроса:
3462 +
3463 +{
3464 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 + "Features": [
3467 + {
3468 + "Feature": "string",
3469 + "IsEnabled": true,
3470 + "IsFactual": true,
3471 + "Limit": 0,
3472 + "Price": 0,
3473 + "DebitDate": "2023-10-18T13:26:58.987Z",
3474 + "PeriodValue": 0,
3475 + "PeriodType": 0
3476 + }
3477 + ]
3478 +}
3479 +
3480 +Ответ: Success
3481 +
3482 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3483 +|ClientId|Идентификатор клиента
3484 +|PlanId|Идентификатор тарифного плана
3485 +|Feature|Код услуги
3486 +|IsEnabled|Признак, определяющий активирована ли услуга
3487 +|IsFactual|Признак, определяющий расчёт по факту
3488 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3489 +|Price|Цена за единицу.
3490 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3491 +|PeriodValue|Значение периода.
3492 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3493 +
3494 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3495 +
3496 +(% class="box warningmessage" %)
3497 +(((
3498 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3499 +)))
3500 +
3501 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3502 +
3503 +(% class="box infomessage" %)
3504 +(((
3505 +**POST /api/v3/vehicles/import/{agentId}**
3506 +)))
3507 +
3508 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
3509 +
3510 +**agentId** - id клиента, указывается в пути запроса. (обязательный)
3511 +
3512 +
3513 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3514 +
3515 +(% class="box infomessage" %)
3516 +(((
3517 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3518 +)))
3519 +
3520 +(% class="wikigeneratedid" %)
3521 +**vehicleId **- id объекта.
3522 +
3523 +
3524 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3525 +
3526 +(% class="box infomessage" %)
3527 +(((
3528 +**GET /api/v3/vehicles/import/history/status**
3529 +)))
3530 +
3531 +
3532 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3533 +
3534 +(% class="box infomessage" %)
3535 +(((
3536 +**POST /api/v3/vehicles/export**
3537 +)))
3538 +
3539 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3540 +
3541 +Тело запроса:
3542 +
3543 +[
3544 + id
3545 +]
3546 +
3547 +Ответ: Success 200, получаете файлы с настройками.
3548 +
3549 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3550 +
3551 +(% class="box infomessage" %)
3552 +(((
3553 +**POST /api/v3/vehicles/export/history**
3554 +)))
3555 +
3556 +Метод возвращает список сообщений терминала объекта за выбранный период.
3557 +
3558 +Тело запроса:
3559 +
3560 +{
3561 + "vehicleId": 0,
3562 + "asArchive": true,
3563 + "from": "2023-09-27T12:17:45.973Z",
3564 + "to": "2023-09-27T12:17:45.973Z"
3565 +}
3566 +
3567 +Ответ:
3568 +
3569 +Получаете файл. Сообщение: Code 200/Success
3570 +
3571 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3572 +|vehicleId|ID объекта
3573 +|asArchive|true - Архивировать файл, False - не архивировать
3574 +|from|Дата и время начала запроса
3575 +|to|Дата и время окончания запроса
3576 +
3577 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3578 +
3579 +(% class="box infomessage" %)
3580 +(((
3581 +**GET /api/v3/vehicles/export/history/status**
3582 +)))
3583 +
3584 +Метод возвращает список сообщений терминала объекта за выбранный период.
3585 +
3586 +Ответ:
3587 +
3588 +{
3589 + "activity": true,
3590 + "progress": 0,
3591 + "message": "string"
3592 +}
3593 +
3594 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3595 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3596 +|progress|Прогресс экспорта, от 0 до 100%
3597 +|message|Текст описывающий статус
3598 +
3599 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3600 +
3601 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3602 +
3603 +(% class="box infomessage" %)
3604 +(((
3605 +**POST /api/v3/EcoDriving/rating**
3606 +)))
3607 +
3608 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3609 +
3610 +Тело запроса:
3611 +
3612 +{
3613 + "vehicleIds": [vehicleId],
3614 + "from": "2023-11-22T09:29:48.051Z",
3615 + "to": "2023-11-22T09:29:48.051Z"
3616 +}
3617 +
3618 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3619 +|vehicleIds|Массив ID объектов
3620 +|from|Дата начала запроса
3621 +|to|Дата окончания запроса
3622 +
3623 +Ответ:
3624 +
3625 +{
3626 + "items": [
3627 + {
3628 + "from": "2023-11-22T09:29:48.052Z",
3629 + "to": "2023-11-22T09:29:48.052Z",
3630 + "vehicleId": 0,
3631 + "vehicleName": "string",
3632 + "vehicleModel": "string",
3633 + "penalty": 0,
3634 + "score": 0,
3635 + "totalViolations": 0,
3636 + "violationsByType": {
3637 + "overspeedingViolations": 0,
3638 + "accelerationViolations": 0,
3639 + "brakingViolations": 0,
3640 + "turningViolations": 0,
3641 + "dangerousDrivingViolations": 0,
3642 + "sensorViolations": 0
3643 + },
3644 + "moveTime": 0,
3645 + "mileage": 0,
3646 + "tripsCount": 0,
3647 + "trips": [
3648 + {
3649 + "penalty": 0,
3650 + "score": 0,
3651 + "violationsCount": 0,
3652 + "violationsByType": {
3653 + "overspeedingViolations": 0,
3654 + "accelerationViolations": 0,
3655 + "brakingViolations": 0,
3656 + "turningViolations": 0,
3657 + "dangerousDrivingViolations": 0,
3658 + "sensorViolations": 0
3659 + },
3660 + "moveTime": 0,
3661 + "mileage": 0,
3662 + "motohours": 0,
3663 + "maxSpeed": 0,
3664 + "startAddress": "string",
3665 + "endAddress": "string",
3666 + "drivers": [
3667 + {
3668 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3669 + "driverName": "string",
3670 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3671 + }
3672 + ]
3673 + }
3674 + ]
3675 + }
3676 + ]
3677 +}
3678 +
3679 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3680 +|from|Дата начала запроса
3681 +|to|Дата  окончания
3682 +|vehicleId|ID объекта
3683 +|vehicleName|Имя объекта
3684 +|vehicleModel|Модель объекта
3685 +|penalty|Сумма штрафных баллов
3686 +|score|Оценка
3687 +|totalViolations|Суммарное количество нарушений
3688 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3689 +|overspeedingViolations|Превышение скорости
3690 +|accelerationViolations|Ускорение
3691 +|brakingViolations|Торможение
3692 +|turningViolations|Резкий поворот
3693 +|dangerousDrivingViolations|Резкое вождение
3694 +|sensorViolations|Нарушение по датчику
3695 +|moveTime|Время в движении
3696 +|mileage|Пробег
3697 +|tripsCount|Количество рейсов
3698 +|motohours|Моточасы
3699 +|maxSpeed|Максимальная скорость
3700 +|startAddress|Адрес начала рейса
3701 +|endAddress|Адрес окончания рейса
3702 +|drivers|Список водителей, которые были на объекте в течениии рейса
3703 +|driverGuid|Guid водителя
3704 +|driverName|Имя водителя
3705 +|driverRfid|Номер Карты-метки
3706 +
2380 2380  (% class="box" lang="en-US" style="text-align: center;" %)
2381 2381  (((
2382 2382  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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