Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 115.1 >
edited by Илья Крайнов
on 2023/11/14 14:29
To version < 109.2 >
edited by Илья Крайнов
on 2023/10/18 15:33
>
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 successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,12 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -98,51 +98,30 @@
98 98  Запрос должен содержать данные параметра "**agentId**"
99 99  
100 100  (% style="color:#000000" %)Ответ:
96 +А
101 101  {
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"
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" ~/~/ Корр. счет
122 122   }
123 123  
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 -
146 146  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 147  
148 148  (% class="box infomessage" %)
... ... @@ -156,7 +156,7 @@
156 156  
157 157  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158 158  
159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **POST**
162 162  
... ... @@ -171,25 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "parentName": "string",
177 - "name": "string",
178 - "fullName": "string",
179 - "agentInfoType": 0,
180 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
181 181  }
182 182  
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 -
193 193  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
194 194  
195 195  (% class="box successmessage" %)
... ... @@ -208,7 +208,7 @@
208 208  Параметры в теле запроса (JSON):
209 209  
210 210  {
211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 212   "name": "string", ~/~/ имя
213 213   "fullName": "string", ~/~/ полное наименование
214 214   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -253,28 +253,6 @@
253 253   "bankKS": "string" ~/~/ корр. счёт
254 254  }
255 255  
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 -
278 278  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
279 279  
280 280  (% class="box warningmessage" %)
... ... @@ -290,6 +290,7 @@
290 290  
291 291  В заголовках запроса: X-Auth: Токен авторизации
292 292  
235 +
293 293  Параметры в теле запроса (JSON):
294 294  
295 295  {
... ... @@ -314,6 +314,7 @@
314 314   "bankKS": "string" ~/~/ корр. счёт
315 315  }
316 316  
260 +
317 317  Ответ:
318 318  
319 319  {
... ... @@ -419,6 +419,7 @@
419 419   "password": "string",
420 420   "email": "string",
421 421  
366 +
422 422  (% style="text-align:left" %)
423 423  (% style="color:#000000; font-weight:normal" %)Ответ:
424 424  
... ... @@ -447,7 +447,6 @@
447 447  (% style="text-align:left" %)
448 448  (% style="color:#000000; font-weight:normal" %)}
449 449  
450 -
451 451  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
452 452  
453 453  (% class="box infomessage" %)
... ... @@ -767,6 +767,7 @@
767 767   "maxspeed": 0,
768 768   "width": 0,
769 769   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
770 770   "hoppercapacity": 0,
771 771   "hopperdischargespeed": 0,
772 772   "modelType": 0,
... ... @@ -783,8 +783,9 @@
783 783  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
784 784  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
785 785  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
786 786  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
787 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
788 788  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
789 789  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
790 790  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -876,24 +876,12 @@
876 876   "maxspeed": 0,
877 877   "width": 0,
878 878   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
879 879   "hoppercapacity": 0,
880 880   "hopperdischargespeed": 0,
881 881   "modelType": 0
882 882  }
883 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 897  
898 898  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
899 899  
... ... @@ -948,20 +948,6 @@
948 948   "modelType": 0
949 949  }
950 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 965  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
966 966  
967 967  (% class="box errormessage" %)
... ... @@ -3007,84 +3007,6 @@
3007 3007  Success
3008 3008  
3009 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 -[
3037 - {
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,
3064 - }
3065 -]
3066 -
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|Текст примечания агрегата
3086 -
3087 -
3088 3088  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3089 3089  
3090 3090  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3113,6 +3113,7 @@
3113 3113   }
3114 3114  ]
3115 3115  
2958 +
3116 3116  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3117 3117  
3118 3118  (% class="box infomessage" %)
... ... @@ -3135,6 +3135,7 @@
3135 3135   }
3136 3136  ]
3137 3137  
2981 +
3138 3138  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3139 3139  
3140 3140  (% class="box successmessage" %)
... ... @@ -3163,6 +3163,7 @@
3163 3163   "deleted": true
3164 3164  }
3165 3165  
3010 +
3166 3166  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3167 3167  
3168 3168  (% class="box warningmessage" %)
... ... @@ -3192,6 +3192,7 @@
3192 3192   "deleted": true
3193 3193  }
3194 3194  
3040 +
3195 3195  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3196 3196  
3197 3197  (% class="box errormessage" %)
... ... @@ -3199,7 +3199,7 @@
3199 3199  **DELETE /api/v3/Rfids/{rfidGuid}**
3200 3200  )))
3201 3201  
3202 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3048 +Передаем параметр rfidGuid - идентификатор карты-метки
3203 3203  
3204 3204  Ответ:
3205 3205  
... ... @@ -3206,325 +3206,6 @@
3206 3206  Success
3207 3207  
3208 3208  
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 -
3528 3528  (% class="box" lang="en-US" style="text-align: center;" %)
3529 3529  (((
3530 3530  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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