Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 97.1 >
edited by Илья Крайнов
on 2023/06/30 15:40
To version < 115.1 >
edited by Илья Крайнов
on 2023/11/14 14:29
>
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,322 @@
1622 1622   }
1623 1623  ]
1624 1624  
1924 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1925 +
1926 +(% class="box infomessage" %)
1927 +(((
1928 +**POST /api/v3/vehicles/export/history**
1929 +)))
1930 +
1931 +Метод возвращает список сообщений терминала объекта за выбранный период.
1932 +
1933 +(% style="text-align: left;" %)
1934 +Метод запроса **POST**
1935 +
1936 +(% style="text-align: left;" %)
1937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1938 +
1939 +(% style="text-align: left;" %)
1940 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1941 +
1942 +{
1943 + "vehicleId": 0, ~/~/ ID объекта
1944 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1945 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1946 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1947 +}
1948 +
1949 +Ответ:
1950 +
1951 +Получаете файл. Сообщение: Code 200/Success
1952 +
1953 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1954 +
1955 +(% class="box infomessage" %)
1956 +(((
1957 +**GET /api/v3/vehicles/export/history/status**
1958 +)))
1959 +
1960 +Метод возвращает список сообщений терминала объекта за выбранный период.
1961 +
1962 +(% style="text-align: left;" %)
1963 +Метод запроса **GET**
1964 +
1965 +(% style="text-align: left;" %)
1966 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1967 +
1968 +(% style="text-align: left;" %)
1969 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1970 +
1971 +Ответ:
1972 +
1973 +{
1974 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1975 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1976 + "message": "string" ~/~/ текст описывающий статус.
1977 +}
1978 +
1979 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1980 +
1981 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1982 +
1983 +(% class="box infomessage" %)
1984 +(((
1985 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1986 +)))
1987 +
1988 +(% style="color:#000000" %)Метод запроса: **POST**
1989 +
1990 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
1991 +
1992 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1993 +
1994 +(% style="text-align:left" %)
1995 +Тело запроса:
1996 +
1997 +{
1998 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1999 + "vehicleIds": [0], ~/~/ Список ID объектов
2000 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2001 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2002 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2003 +}
2004 +
2005 +Ответ:
2006 +
2007 +[
2008 + {
2009 + "vehicleId": 0, ~/~/ ID объекта
2010 + "name": "string", ~/~/ Имя ТС
2011 + "periods": [ ~/~/ Периоды
2012 + {
2013 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2014 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2015 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2016 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2017 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2018 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2019 + }
2020 + ]
2021 + }
2022 +]
2023 +
2024 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2025 +
2026 +(% class="box infomessage" %)
2027 +(((
2028 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2029 +)))
2030 +
2031 +(% style="color:#000000" %)Метод запроса: **POST**
2032 +
2033 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2034 +
2035 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2036 +
2037 +(% style="text-align:left" %)
2038 +Тело запроса:
2039 +
2040 +{
2041 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2042 + "vehicleIds": [0], ~/~/ Список ID объектов
2043 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2044 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2045 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2046 +}
2047 +
2048 +Ответ:
2049 +
2050 +[
2051 + {
2052 + "vehicleId": 0, ~/~/ ID объекта
2053 + "name": "string", ~/~/ Имя ТС
2054 + "periods": [ ~/~/ Периоды
2055 + {
2056 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2057 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2058 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2059 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2060 + "fuelConsumption": 0, ~/~/ Расход топлива
2061 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2062 + }
2063 + ]
2064 + }
2065 +]
2066 +
2067 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2068 +
2069 +(% class="box infomessage" %)
2070 +(((
2071 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2072 +)))
2073 +
2074 +(% style="color:#000000" %)Метод запроса: **POST**
2075 +
2076 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2077 +
2078 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2079 +
2080 +(% style="text-align:left" %)
2081 +Тело запроса:
2082 +
2083 +{
2084 + "vehicleIds": [0], ~/~/ Список ID объектов
2085 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2086 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2087 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2088 +}
2089 +
2090 +Ответ:
2091 +
2092 +[
2093 + {
2094 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2095 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2096 + "vehicleId": 0, ~/~/ ID объекта
2097 + "name": "string", ~/~/ Имя объекта
2098 + "model": "string", ~/~/ Модель объекта
2099 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2100 + {
2101 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2102 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2103 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2104 + "valueFuel": 0, ~/~/ Количество
2105 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2106 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2107 + }
2108 + ]
2109 + }
2110 +]
2111 +
2112 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2113 +
2114 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2115 +
2116 +(% class="box infomessage" %)
2117 +(((
2118 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2119 +)))
2120 +
2121 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2122 +
2123 +(% style="color:#000000" %)Метод запроса: **POST**
2124 +
2125 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2126 +
2127 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2128 +
2129 +(% style="text-align:left" %)
2130 +Тело запроса:
2131 +
2132 +(% style="text-align:left" %)
2133 +{
2134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2135 +}
2136 +
2137 +(% style="text-align:left" %)
2138 +Ответ:
2139 +
2140 +[
2141 + {
2142 + "id": 0, ~/~/ Идентификатор объекта геозоны
2143 + "name": "string", ~/~/ Название объекта геозоны
2144 + "type": 0, ~/~/ Тип объекта геозоны
2145 + "fname": "string", ~/~/ Имя файла
2146 + "parentId": "string", ~/~/ Идентификатор клиента
2147 + "radius": 0, ~/~/ Радиус геообъекта
2148 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2149 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2150 + "description": "string", ~/~/ Описание
2151 + "area": 0, ~/~/ Площадь, м^^2^^
2152 + "perimetr": 0, ~/~/ Периметр, м
2153 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2154 + }
2155 +]
2156 +
2157 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2158 +
2159 +(% class="box infomessage" %)
2160 +(((
2161 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2162 +)))
2163 +
2164 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2165 +
2166 +(% style="color:#000000" %)Метод запроса: **POST**
2167 +
2168 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2169 +
2170 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2171 +
2172 +(% style="text-align:left" %)
2173 +Тело запроса:
2174 +
2175 +{
2176 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2177 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2178 + "ids": [ ], ~/~/ Массив id объектов
2179 + "byTime": 0, ~/~/ Объединение событий по времени 
2180 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2181 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2182 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2183 +}
2184 +
2185 +Ответ:
2186 +[
2187 + {
2188 + "geozoneId": 0, ~/~/ ID геообъекта
2189 + "geozoneName": "string", ~/~/ Название геообъекта
2190 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2191 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2192 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2193 + "vehicleId": 0, ~/~/ ID объекта
2194 + "vehicleName": "string" ~/~/ Имя объекта
2195 + }
2196 +]
2197 +
2198 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2199 +
2200 +(% class="box infomessage" %)
2201 +(((
2202 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2203 +)))
2204 +
2205 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2206 +
2207 +(% style="color:#000000" %)Метод запроса: **POST**
2208 +
2209 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2210 +
2211 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2212 +
2213 +(% style="text-align:left" %)
2214 +Тело запроса:
2215 +
2216 +{
2217 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2218 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2219 + "ids": [ ], ~/~/ Массив id геообъектов
2220 + "byTime": 0, ~/~/ Объединение событий по времени 
2221 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2222 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2223 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2224 +}
2225 +
2226 +Ответ:
2227 +
2228 +[
2229 + {
2230 + "geozoneId": 0, ~/~/ ID геообъекта
2231 + "geozoneName": "string", ~/~/ Название геообъекта
2232 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2233 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2234 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2235 + "vehicleId": 0, ~/~/ ID объекта
2236 + "vehicleName": "string" ~/~/ Имя объекта
2237 + }
2238 +]
2239 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1827,78 +1827,126 @@
1827 1827  
1828 1828  == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
1829 1829  
1830 -POST /api/v3/Drivers/find
2445 +(% class="box infomessage" %)
2446 +(((
2447 +**POST /api/v3/Drivers/find**
2448 +)))
1831 1831  
1832 -Передается: parentId - ID клиента-родителя
2450 +Передается параметр: parentId - ID клиента-родителя
1833 1833  
1834 1834  Ответ:
1835 1835  
1836 -{{{[
2454 +[
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 // Признак удаления
2456 + "name": "string", ~/~/ Определяет наименование
2457 + "description": "string", ~/~/ Определяет описание
2458 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2459 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2460 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2461 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2462 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2463 + "deleted": true ~/~/ Признак удаления
1846 1846   }
1847 -]}}}
2465 +]
1848 1848  
1849 -
1850 1850  == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
1851 1851  
1852 -GET /api/v3/Drivers/{driverGuid}
2469 +(% class="box infomessage" %)
2470 +(((
2471 +**GET /api/v3/Drivers/{driverGuid}**
2472 +)))
1853 1853  
1854 -Передается ID водителя
2474 +Передается параметр: ID водителя
1855 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 // Признак удаления
2478 +{
2479 + "name": "string", ~/~/ Определяет наименование
2480 + "description": "string", ~/~/ Определяет описание
2481 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2482 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2483 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2484 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2485 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2486 + "deleted": true ~/~/ Признак удаления
1867 1867  }
1868 -}}}
1869 1869  
1870 -
1871 1871  == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
1872 1872  
1873 -POST /api/v3/Drivers
2491 +(% class="box successmessage" %)
2492 +(((
2493 +**POST /api/v3/Drivers**
2494 +)))
1874 1874  
1875 -Передается:
2496 +Запрос:
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 }}}}
2498 +{
2499 + "name": "string",
2500 + "description": "string",
2501 + "hiredate": "2023-06-30T12:50:54.020Z",
2502 + "chopdate": "2023-06-30T12:50:54.020Z",
2503 + "exclusive": true,
2504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2505 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2506 + "deleted": true
2507 +}
1878 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 }}}}
2511 +{
2512 + "name": "string",
2513 + "description": "string",
2514 + "hiredate": "2023-06-30T12:50:54.051Z",
2515 + "chopdate": "2023-06-30T12:50:54.051Z",
2516 + "exclusive": true,
2517 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2518 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2519 + "deleted": true
2520 +}
1882 1882  
1883 1883  
1884 1884  == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
1885 1885  
1886 -PUT /api/v3/Drivers
2525 +(% class="box warningmessage" %)
2526 +(((
2527 +**PUT /api/v3/Drivers**
2528 +)))
1887 1887  
1888 -Передается:
2530 +Запрос:
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 }}}}
2532 +{
2533 + "name": "string",
2534 + "description": "string",
2535 + "hiredate": "2023-06-30T12:50:27.910Z",
2536 + "chopdate": "2023-06-30T12:50:27.910Z",
2537 + "exclusive": true,
2538 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2539 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2540 + "deleted": true
2541 +}
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 }}}}
2545 +{
2546 + "name": "string",
2547 + "description": "string",
2548 + "hiredate": "2023-06-30T12:50:27.929Z",
2549 + "chopdate": "2023-06-30T12:50:27.929Z",
2550 + "exclusive": true,
2551 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2552 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2553 + "deleted": true
2554 +}
1895 1895  
1896 1896  
1897 1897  == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
1898 1898  
1899 -DELETE /api/v3/Drivers/{driverGuid}
2559 +(% class="box errormessage" %)
2560 +(((
2561 +**DELETE /api/v3/Drivers/{driverGuid}**
2562 +)))
1900 1900  
1901 -Передается ID водителя
2564 +Передается параметр: ID водителя
1902 1902  
1903 1903  Ответ:
1904 1904  
... ... @@ -1911,15 +1911,24 @@
1911 1911  
1912 1912  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
1913 1913  
1914 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers
2577 +(% class="box infomessage" %)
2578 +(((
2579 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2580 +)))
1915 1915  
1916 -Передаем:
2582 +Запрос:
1917 1917  
1918 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T09:52:31.196Z", "EndTime": "2023-06-30T09:52:31.196Z" }}}}
2584 +{
2585 + "Ids": [
2586 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2587 + ],
2588 + "BeginTime": "2023-06-30T12:49:04.365Z",
2589 + "EndTime": "2023-06-30T12:49:04.365Z"
2590 +}
1919 1919  
1920 1920  Ответ:
1921 1921  
1922 -{{{[
2594 +[
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 -]}}}
2603 +]
1932 1932  
1933 1933  
1934 1934  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
1935 1935  
1936 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles
2608 +(% class="box infomessage" %)
2609 +(((
2610 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2611 +)))
1937 1937  
1938 -Передаем:
2613 +Запрос:
1939 1939  
1940 -{{{{ "Ids": [ 0 ], "BeginTime": "2023-06-30T09:54:01.583Z", "EndTime": "2023-06-30T09:54:01.583Z" }}}}
2615 +{
2616 + "Ids": [
2617 + 0
2618 + ],
2619 + "BeginTime": "2023-06-30T12:48:39.419Z",
2620 + "EndTime": "2023-06-30T12:48:39.419Z"
2621 +}
1941 1941  
1942 1942  Ответ:
1943 1943  
1944 -{{{[
2625 +[
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 -]}}}
2634 +]
1954 1954  
1955 1955  
1956 1956  === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
1957 1957  
1958 -POST /api/v3/DriversVehiclesAssignments
2639 +(% class="box successmessage" %)
2640 +(((
2641 +**POST /api/v3/DriversVehiclesAssignments**
2642 +)))
1959 1959  
1960 1960  Передается массив назначений
1961 1961  
1962 1962  Запрос:
1963 1963  
1964 -{{{[
2648 +[
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" // Момент времени окончания назначения. Необязательно.
2650 + "VehicleId": 0, ~/~/ Идентификатор объекта
2651 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2652 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2653 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2654 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
1971 1971   }
1972 -]}}}
2656 +]
1973 1973  
1974 1974  Ответ:
1975 1975  
1976 -{{{[
2660 +[
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 -]}}}
2669 +]
1986 1986  
1987 1987  
1988 1988  === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
1989 1989  
1990 -PUT /api/v3/DriversVehiclesAssignments
2674 +(% class="box warningmessage" %)
2675 +(((
2676 +**PUT /api/v3/DriversVehiclesAssignments**
2677 +)))
1991 1991  
1992 1992  Запрос:
1993 1993  
1994 -{{{[
2681 +[
1995 1995   {
1996 1996   "VehicleId": 0,
1997 1997   "CreateTime": "2023-06-30T11:14:08.117Z",
1998 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2685 + "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 -]}}}
2690 +]
2004 2004  
2005 2005  Ответ:
2006 2006  
2007 -{{{[
2694 +[
2008 2008   {
2009 2009   "VehicleId": 0,
2010 2010   "CreateTime": "2023-06-30T11:14:53.349Z",
... ... @@ -2013,38 +2013,25 @@
2013 2013   "BeginTime": "2023-06-30T11:14:53.349Z",
2014 2014   "EndTime": "2023-06-30T11:14:53.349Z"
2015 2015   }
2016 -]}}}
2703 +]
2017 2017  
2018 2018  
2019 2019  === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2020 2020  
2021 -DELETE /api/v3/DriversVehiclesAssignments
2708 +(% class="box errormessage" %)
2709 +(((
2710 +**DELETE /api/v3/DriversVehiclesAssignments**
2711 +)))
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 -]}}}
2715 +[
2716 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2717 +]
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 -]}}}
2721 +Success
2048 2048  
2049 2049  
2050 2050  == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
... ... @@ -2051,53 +2051,74 @@
2051 2051  
2052 2052  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2053 2053  
2054 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2728 +(% class="box infomessage" %)
2729 +(((
2730 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2731 +)))
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" }}}}
2735 +{
2736 + "Ids": [
2737 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2738 + ],
2739 + "BeginTime": "2023-06-30T12:47:12.162Z",
2740 + "EndTime": "2023-06-30T12:47:12.162Z"
2741 +}
2059 2059  
2060 2060  Ответ:
2061 2061  
2062 -{{{[
2745 +[
2063 2063   {
2064 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2065 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2066 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2747 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2748 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2749 + "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 -]}}}
2753 +]
2071 2071  
2072 2072  
2073 2073  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2074 2074  
2075 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2758 +(% class="box infomessage" %)
2759 +(((
2760 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2761 +)))
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" }}}}
2765 +{
2766 + "Ids": [
2767 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2768 + ],
2769 + "BeginTime": "2023-06-30T12:47:12.162Z",
2770 + "EndTime": "2023-06-30T12:47:12.162Z"
2771 +}
2080 2080  
2081 2081  Ответ:
2082 2082  
2083 -{{{[
2775 +[
2084 2084   {
2085 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2086 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2087 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2777 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2778 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2779 + "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 -]}}}
2783 +]
2092 2092  
2093 2093  
2094 2094  === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2095 2095  
2096 -POST /api/v3/DriversRfidsAssignments
2788 +(% class="box successmessage" %)
2789 +(((
2790 +**POST /api/v3/DriversRfidsAssignments**
2791 +)))
2097 2097  
2098 2098  Запрос:
2099 2099  
2100 -{{{[
2795 +[
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 -]}}}
2802 +]
2108 2108  
2109 2109  Ответ:
2110 2110  
2111 -{{{[
2806 +[
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 -]}}}
2814 +]
2120 2120  
2121 2121  
2122 2122  === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2123 2123  
2124 -PUT /api/v3/DriversRfidsAssignments
2819 +(% class="box warningmessage" %)
2820 +(((
2821 +**PUT /api/v3/DriversRfidsAssignments**
2822 +)))
2125 2125  
2126 2126  Запрос:
2127 2127  
2128 -{{{[
2826 +[
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 -]}}}
2834 +]
2137 2137  
2138 2138  Ответ:
2139 2139  
2140 -{{{[
2838 +[
2141 2141   {
2142 2142   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2143 2143   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2145,36 +2145,25 @@
2145 2145   "BeginTime": "2023-06-30T11:28:43.331Z",
2146 2146   "EndTime": "2023-06-30T11:28:43.331Z"
2147 2147   }
2148 -]}}}
2846 +]
2149 2149  
2150 2150  
2151 2151  === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2152 2152  
2153 -DELETE /api/v3/DriversRfidsAssignments
2851 +(% class="box errormessage" %)
2852 +(((
2853 +**DELETE /api/v3/DriversRfidsAssignments**
2854 +)))
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 -]}}}
2858 +[
2859 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2860 +]
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 -]}}}
2864 +Success
2178 2178  
2179 2179  
2180 2180  == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
... ... @@ -2181,15 +2181,24 @@
2181 2181  
2182 2182  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2183 2183  
2184 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
2871 +(% class="box infomessage" %)
2872 +(((
2873 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2874 +)))
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" }}}}
2878 +{
2879 + "Ids": [
2880 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2881 + ],
2882 + "BeginTime": "2023-06-30T12:45:10.852Z",
2883 + "EndTime": "2023-06-30T12:45:10.852Z"
2884 +}
2189 2189  
2190 2190  Ответ:
2191 2191  
2192 -{{{[
2888 +[
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 -]}}}
2896 +]
2201 2201  
2202 2202  
2203 2203  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2204 2204  
2205 -POST /api/v3/DriversFuelCardsAssignments/GetByCards
2901 +(% class="box infomessage" %)
2902 +(((
2903 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2904 +)))
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" }}}}
2908 +{
2909 + "Ids": [
2910 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2911 + ],
2912 + "BeginTime": "2023-06-30T12:45:10.852Z",
2913 + "EndTime": "2023-06-30T12:45:10.852Z"
2914 +}
2210 2210  
2211 2211  Ответ:
2212 2212  
2213 -{{{[
2918 +[
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 -]}}}
2926 +]
2222 2222  
2223 2223  
2224 2224  === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2225 2225  
2226 -POST /api/v3/DriversFuelCardsAssignments
2931 +(% class="box successmessage" %)
2932 +(((
2933 +**POST /api/v3/DriversFuelCardsAssignments**
2934 +)))
2227 2227  
2228 2228  Запрос:
2229 2229  
2230 -{{{[
2938 +[
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 -]}}}
2945 +]
2238 2238  
2239 2239  Ответ:
2240 2240  
2241 -{{{[
2949 +[
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 -]}}}
2957 +]
2250 2250  
2251 2251  
2252 2252  === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2253 2253  
2254 -PUT /api/v3/DriversFuelCardsAssignments
2962 +(% class="box warningmessage" %)
2963 +(((
2964 +**PUT /api/v3/DriversFuelCardsAssignments**
2965 +)))
2255 2255  
2256 2256  Запрос:
2257 2257  
2258 -{{{[
2969 +[
2259 2259   {
2260 2260   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2972 + "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"
2974 + "BeginTime": "2023-06-30T12:09:53.201Z",
2975 + "EndTime": "2023-06-30T12:09:53.201Z"
2264 2264   }
2265 -]}}}
2977 +]
2266 2266  
2267 2267  Ответ:
2268 2268  
2269 -{{{[
2981 +[
2270 2270   {
2271 2271   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2272 2272   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2274,100 +2274,175 @@
2274 2274   "BeginTime": "2023-06-30T12:09:53.201Z",
2275 2275   "EndTime": "2023-06-30T12:09:53.201Z"
2276 2276   }
2277 -]}}}
2989 +]
2278 2278  
2279 2279  
2280 2280  === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2281 2281  
2282 -DELETE /api/v3/DriversFuelCardsAssignments
2994 +(% class="box errormessage" %)
2995 +(((
2996 +**DELETE /api/v3/DriversFuelCardsAssignments**
2997 +)))
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 -]}}}
3001 +[
3002 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3003 +]
2294 2294  
2295 2295  Ответ:
2296 2296  
2297 -{{{[
3007 +Success
3008 +
3009 +
3010 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3011 +
3012 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3013 +
3014 +(% class="box infomessage" %)
3015 +(((
3016 +**POST /api/v3/Trailers**
3017 +)))
3018 +
3019 +Пример запроса:
3020 +
3021 +{
3022 + "startDate": "2023-11-14T10:48:03.671Z",
3023 + "endDate": "2023-11-14T10:48:03.671Z",
3024 + "ids": [ 0 ],
3025 + "timezone": 0
3026 +}
3027 +
3028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3029 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3030 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3031 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3032 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3033 +
3034 +Пример ответа:
3035 +
3036 +[
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"
3038 + "SD": "2023-11-14T10:48:03.717Z",
3039 + "ED": "2023-11-14T10:48:03.717Z", 
3040 + "id": 0,
3041 + "SLat": 0,
3042 + "SLon": 0,
3043 + "ELat": 0,
3044 + "ELon": 0,
3045 + "mileage": 0
3046 + "Duration": 0
3047 + "Address": "string",
3048 + "Address2": "string",
3049 + "name": "string",
3050 + "rid": "string",
3051 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3052 + "trailer": {
3053 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3054 + "Number": "string",
3055 + "Description": "string",
3056 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3057 + "ExternalID": "string",
3058 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 + "CreateTime": "2023-11-14T10:48:03.717Z",
3060 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3061 + "IsDeleted": true
3062 + },
3063 + "filesCount": 0,
2304 2304   }
2305 -]}}}
3065 +]
2306 2306  
3067 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3068 +|SD|Дата и время начала события
3069 +|ED|Дата и время окончания события
3070 +|id|ID объекта
3071 +|SLat|Широта начальной координаты
3072 +|SLon|Долгота начальной координаты
3073 +|ELat|Широта конечной координаты
3074 +|ELon|Долгота конечной координаты
3075 +|mileage|Пробег
3076 +|Duration|Продолжительность
3077 +|Address|Адрес начального местоположения
3078 +|Address2|Адрес конечного местоположения
3079 +|name|Имя радиометки
3080 +|rid|Номер радиометки
3081 +|rguid|ID радиометки
3082 +|trailer|Информация об агрегате
3083 +|ModelGuid|ID агрегата
3084 +|Number|Название/номер агрегата
3085 +|Description|Текст примечания агрегата
2307 2307  
3087 +
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
3092 +(% class="box infomessage" %)
3093 +(((
3094 +**POST /api/v3/Rfids/find**
3095 +)))
2313 2313  
2314 2314  Запрос:
2315 2315  
2316 -{{{{
3099 +{
2317 2317   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2318 -}}}}
3101 +}
2319 2319  
2320 2320  Ответ:
2321 2321  
2322 -{{{[
3105 +[
2323 2323   {
2324 2324   "name": "string",
2325 2325   "number": 0,
2326 - "period": 0, // Частота трансляции радиометки
3109 + "period": 0, ~/~/ Частота трансляции радиометки
2327 2327   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2328 2328   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2329 2329   "deleted": true
2330 2330   }
2331 2331  ]
2332 -}}}
2333 2333  
2334 2334  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2335 2335  
2336 -GET /api/v3/Rfids/{rfidGuid}
3118 +(% class="box infomessage" %)
3119 +(((
3120 +**GET /api/v3/Rfids/{rfidGuid}**
3121 +)))
2337 2337  
2338 2338  Передаем параметр rfidGuid - идентификатор карты-метки
2339 2339  
2340 2340  Ответ:
2341 2341  
2342 -{{{[
3127 +[
2343 2343   {
2344 2344   "name": "string",
2345 2345   "number": 0,
2346 - "period": 0, // Частота трансляции радиометки
3131 + "period": 0, ~/~/ Частота трансляции радиометки
2347 2347   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2348 2348   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2349 2349   "deleted": true
2350 2350   }
2351 2351  ]
2352 -}}}
2353 2353  
2354 2354  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2355 2355  
2356 -POST /api/v3/Rfids
3140 +(% class="box successmessage" %)
3141 +(((
3142 +**POST /api/v3/Rfids**
3143 +)))
2357 2357  
2358 2358  Запрос:
2359 2359  
2360 -{{{{
3147 +{
2361 2361   "name": "string",
2362 2362   "number": 0,
2363 2363   "period": 0,
2364 2364   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2365 2365   "deleted": true
2366 -}}}}
3153 +}
2367 2367  
2368 2368  Ответ:
2369 2369  
2370 -{{{{
3157 +{
2371 2371   "name": "string",
2372 2372   "number": 0,
2373 2373   "period": 0,
... ... @@ -2375,15 +2375,17 @@
2375 2375   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2376 2376   "deleted": true
2377 2377  }
2378 -}}}
2379 2379  
2380 2380  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2381 2381  
2382 -PUT /api/v3/Rfids
3168 +(% class="box warningmessage" %)
3169 +(((
3170 +**PUT /api/v3/Rfids**
3171 +)))
2383 2383  
2384 2384  Запрос:
2385 2385  
2386 -{{{{
3175 +{
2387 2387   "name": "string",
2388 2388   "number": 0,
2389 2389   "period": 0,
... ... @@ -2390,11 +2390,11 @@
2390 2390   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2391 2391   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2392 2392   "deleted": true
2393 -}}}}
3182 +}
2394 2394  
2395 2395  Ответ:
2396 2396  
2397 -{{{{
3186 +{
2398 2398   "name": "string",
2399 2399   "number": 0,
2400 2400   "period": 0,
... ... @@ -2402,13 +2402,15 @@
2402 2402   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2403 2403   "deleted": true
2404 2404  }
2405 -}}}
2406 2406  
2407 2407  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2408 2408  
2409 -DELETE /api/v3/Rfids/{rfidGuid}
3197 +(% class="box errormessage" %)
3198 +(((
3199 +**DELETE /api/v3/Rfids/{rfidGuid}**
3200 +)))
2410 2410  
2411 -Передаем параметр rfidGuid - идентификатор карты-метки
3202 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2412 2412  
2413 2413  Ответ:
2414 2414  
... ... @@ -2415,6 +2415,325 @@
2415 2415  Success
2416 2416  
2417 2417  
3209 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3210 +
3211 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3212 +
3213 +(% class="box infomessage" %)
3214 +(((
3215 +**GET /api/v3/Billing/client/balance/{clientId}**
3216 +)))
3217 +
3218 +Параметр запроса: **clientId **- идентификатор клиента.
3219 +
3220 +Ответ:
3221 +
3222 +{
3223 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3224 + "Balance": 0
3225 +}
3226 +
3227 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3228 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3229 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3230 +
3231 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3232 +
3233 +(% class="box infomessage" %)
3234 +(((
3235 +**GET /api/v3/Billing/client/constraint/{clientId}**
3236 +)))
3237 +
3238 +Параметр запроса: **clientId **- идентификатор клиента.
3239 +
3240 +Ответ:
3241 +
3242 +{
3243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3244 + "CalculationType": 0,
3245 + "PermissibleBalance": 0,
3246 + "DefermentDays": 0,
3247 + "SendUiNotifications": true,
3248 + "SendEmailNotifications": true,
3249 + "IsPrivate": true,
3250 +}
3251 +
3252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3253 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3254 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3255 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3256 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3257 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3258 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3259 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3260 +
3261 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3262 +
3263 +(% class="box infomessage" %)
3264 +(((
3265 +**GET /api/v3/Billing/client/plan/{clientId}**
3266 +)))
3267 +
3268 +Параметры запроса:
3269 +
3270 +**clientId **- идентификатор клиента.
3271 +
3272 +**planId **- идентификатор тарифного плана.
3273 +
3274 +Ответ:
3275 +
3276 +{
3277 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3278 + "Plan": { **~/~/ Описание тарифного плана**
3279 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3280 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3281 + "Name": "string",
3282 + "IsArchived": true,
3283 + "Constraint": {
3284 + "CalculationType": 0,
3285 + "PermissibleBalance": 0,
3286 + "DefermentDays": 0
3287 + },
3288 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3289 + {
3290 + "Feature": "string",
3291 + "IsFactual": true,
3292 + "Limit": 0,
3293 + "Price": 0,
3294 + "PeriodValue": 0,
3295 + "PeriodType": 0
3296 + }
3297 + ]
3298 + },
3299 + "DebitDate": "2023-10-18T12:46:24.213Z",
3300 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3301 + {
3302 + "Feature": "string",
3303 + "IsEnabled": true,
3304 + "IsPrivate": true,
3305 + "IsFactual": true,
3306 + "Limit": 0,
3307 + "Price": 0,
3308 + "DebitDate": "2023-10-18T12:46:24.213Z",
3309 + "PeriodValue": 0,
3310 + "PeriodType": 0
3311 + }
3312 + ]
3313 +}
3314 +
3315 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3316 +|ClientId|Идентификатор клиента
3317 +|Id|Идентификатор тарифного плана
3318 +|OwnerId|Идентификатор клиента-владельца
3319 +|Name|Наименование тарифного плана
3320 +|IsArchived|Признак, определяющий архивный тарифный план
3321 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3322 +|PermissibleBalance|Допустимый баланс
3323 +|DefermentDays|Отсрочка, количество дней
3324 +|Feature|Код услуги
3325 +|IsEnabled|Признак, определяющий активирована ли услуга
3326 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3327 +|IsFactual|Признак, определяющий расчёт по факту
3328 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3329 +|Price|Цена за единицу.
3330 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3331 +|PeriodValue|Значение периода.
3332 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3333 +
3334 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3335 +
3336 +(% class="box infomessage" %)
3337 +(((
3338 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3339 +)))
3340 +
3341 +Параметр запроса: **clientId **- идентификатор клиента.
3342 +
3343 +Ответ:
3344 +
3345 +[
3346 + {
3347 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3348 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3349 + "Name": "string",
3350 + "IsArchived": true,
3351 + "Constraint": {
3352 + "CalculationType": 0,
3353 + "PermissibleBalance": 0,
3354 + "DefermentDays": 0
3355 + },
3356 + "Features": [
3357 + {
3358 + "Feature": "string",
3359 + "IsFactual": true,
3360 + "Limit": 0,
3361 + "Price": 0,
3362 + "PeriodValue": 0,
3363 + "PeriodType": 0
3364 + }
3365 + ]
3366 + }
3367 +]
3368 +
3369 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3370 +|ClientId|Идентификатор клиента
3371 +|Id|Идентификатор тарифного плана
3372 +|OwnerId|Идентификатор клиента-владельца
3373 +|Name|Наименование тарифного плана
3374 +|IsArchived|Признак, определяющий архивный тарифный план
3375 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3376 +|PermissibleBalance|Допустимый баланс
3377 +|DefermentDays|Отсрочка, количество дней
3378 +|Feature|Код услуги
3379 +|IsFactual|Признак, определяющий расчёт по факту
3380 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3381 +|Price|Цена за единицу.
3382 +|PeriodValue|Значение периода.
3383 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3384 +
3385 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3386 +
3387 +(% class="box infomessage" %)
3388 +(((
3389 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3390 +)))
3391 +
3392 +Параметр запроса: **clientId **- идентификатор клиента.
3393 +
3394 +Ответ:
3395 +
3396 +[
3397 + {
3398 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3399 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 + "Name": "string",
3401 + "IsArchived": true,
3402 + "Constraint": {
3403 + "CalculationType": 0,
3404 + "PermissibleBalance": 0,
3405 + "DefermentDays": 0
3406 + },
3407 + "Features": [
3408 + {
3409 + "Feature": "string",
3410 + "IsFactual": true,
3411 + "Limit": 0,
3412 + "Price": 0,
3413 + "PeriodValue": 0,
3414 + "PeriodType": 0
3415 + }
3416 + ]
3417 + }
3418 +]
3419 +
3420 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3421 +|ClientId|Идентификатор клиента
3422 +|Id|Идентификатор тарифного плана
3423 +|OwnerId|Идентификатор клиента-владельца
3424 +|Name|Наименование тарифного плана
3425 +|IsArchived|Признак, определяющий архивный тарифный план
3426 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3427 +|PermissibleBalance|Допустимый баланс
3428 +|DefermentDays|Отсрочка, количество дней
3429 +|Feature|Код услуги
3430 +|IsFactual|Признак, определяющий расчёт по факту
3431 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3432 +|Price|Цена за единицу.
3433 +|PeriodValue|Значение периода.
3434 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3435 +
3436 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3437 +
3438 +(% class="box warningmessage" %)
3439 +(((
3440 +**PUT /api/v3/Billing/client/balance**
3441 +)))
3442 +
3443 +Тело запроса:
3444 +
3445 +{
3446 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3447 + "Balance": 0
3448 +}
3449 +
3450 +Ответ: Success
3451 +
3452 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3453 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3454 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3455 +
3456 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3457 +
3458 +(% class="box warningmessage" %)
3459 +(((
3460 +**PUT /api/v3/Billing/client/constraint**
3461 +)))
3462 +
3463 +Тело запроса:
3464 +
3465 +{
3466 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3467 + "CalculationType": 0,
3468 + "PermissibleBalance": 0,
3469 + "DefermentDays": 0,
3470 + "SendUiNotifications": true,
3471 + "SendEmailNotifications": true,
3472 + "IsPrivate": true,
3473 +}
3474 +
3475 +Ответ: Success
3476 +
3477 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3478 +|ClientId|Идентификатор клиента
3479 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3480 +|PermissibleBalance|Допустимый баланс
3481 +|DefermentDays|(((
3482 +Отсрочка, количество дней
3483 +)))
3484 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3485 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3486 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3487 +
3488 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3489 +
3490 +(% class="box warningmessage" %)
3491 +(((
3492 +**PUT /api/v3/Billing/client/plan**
3493 +)))
3494 +
3495 +Тело запроса:
3496 +
3497 +{
3498 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3499 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3500 + "Features": [
3501 + {
3502 + "Feature": "string",
3503 + "IsEnabled": true,
3504 + "IsFactual": true,
3505 + "Limit": 0,
3506 + "Price": 0,
3507 + "DebitDate": "2023-10-18T13:26:58.987Z",
3508 + "PeriodValue": 0,
3509 + "PeriodType": 0
3510 + }
3511 + ]
3512 +}
3513 +
3514 +Ответ: Success
3515 +
3516 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3517 +|ClientId|Идентификатор клиента
3518 +|PlanId|Идентификатор тарифного плана
3519 +|Feature|Код услуги
3520 +|IsEnabled|Признак, определяющий активирована ли услуга
3521 +|IsFactual|Признак, определяющий расчёт по факту
3522 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3523 +|Price|Цена за единицу.
3524 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3525 +|PeriodValue|Значение периода.
3526 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3527 +
2418 2418  (% class="box" lang="en-US" style="text-align: center;" %)
2419 2419  (((
2420 2420  (% 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 г.