Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 114.1 >
edited by Илья Крайнов
on 2023/10/20 16:06
To version < 104.1 >
edited by Илья Крайнов
on 2023/08/03 17:57
>
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" %)
... ... @@ -738,249 +738,6 @@
738 738  (% style="text-align:left" %)
739 739  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
740 740  
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 -
984 984  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
985 985  
986 986  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1803,314 +1803,10 @@
1803 1803  (% style="text-align:left" %)
1804 1804  (% style="color:#000000" %)}
1805 1805  
1806 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1807 1807  
1808 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1809 -
1810 -(% class="box infomessage" %)
1811 -(((
1812 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1813 -)))
1814 -
1815 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1816 -
1817 -(% style="color:#000000" %)Метод запроса: **GET**
1818 -
1819 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1820 -
1821 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1822 -
1823 -(% style="color:#000000" %)Ответ:
1824 -
1825 -(% style="color:#000000" %){
1826 -
1827 - "id": "", ~/~/ ID типа датчика 
1828 - "name": "", ~/~/ Название
1829 - "description": "", ~/~/ Описание
1830 -
1831 1831  (% style="text-align:left" %)
1832 -(% style="color:#000000" %)}
1509 +(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**
1833 1833  
1834 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1835 -
1836 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1837 -
1838 -(% class="box infomessage" style="text-align: left;" %)
1839 -(((
1840 -**POST /api/v3/terminalMessages/count**
1841 -)))
1842 -
1843 -(% style="text-align: left;" %)
1844 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1845 -
1846 -(% style="text-align: left;" %)
1847 -Метод запроса **POST**
1848 -
1849 -(% style="text-align: left;" %)
1850 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1851 -
1852 -(% style="text-align: left;" %)
1853 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1854 -
1855 -(% style="text-align: left;" %)
1856 -{
1857 - "vehicleIds": [
1858 - id ~/~/ здесь передается список идентификаторов объектов
1859 - ],
1860 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1861 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1862 -}
1863 -
1864 -(% style="text-align: left;" %)
1865 -Ответ:
1866 -
1867 -(% style="text-align: left;" %)
1868 -[
1869 - {
1870 - "vehicleId": 0, ~/~/ идентификатор объекта
1871 - "count": 0 ~/~/ количество сообщений за период
1872 - }
1873 -]
1874 -
1875 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1876 -
1877 -(% class="box infomessage" %)
1878 -(((
1879 -**POST /api/v3/terminalMessages**
1880 -)))
1881 -
1882 -Метод возвращает список сообщений терминала объекта за выбранный период.
1883 -
1884 -(% style="text-align: left;" %)
1885 -Метод запроса **POST**
1886 -
1887 -(% style="text-align: left;" %)
1888 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1889 -
1890 -(% style="text-align: left;" %)
1891 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1892 -
1893 -{
1894 - "vehicleId": 0, ~/~/ id объекта
1895 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1896 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1897 -}
1898 -
1899 -Ответ:
1900 -
1901 -[
1902 - {
1903 - "messages": [
1904 - {
1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1907 - "speed": 0, ~/~/ Скорость, км/ч
1908 - "altitude": 0, ~/~/ Высота, м
1909 - "latitude": 0, ~/~/ Широта [-90°;90°]
1910 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1911 - "satellites": 0, ~/~/ Кол-во спутников
1912 - "voltage": 0, ~/~/ Напряжение
1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1914 - "additionalProp1": "string",
1915 - "additionalProp2": "string",
1916 - "additionalProp3": "string"
1917 - },
1918 - "photoCount": 0 ~/~/ Кол-во фото
1919 - }
1920 - ]
1921 - }
1922 -]
1923 -
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 2114  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2115 2115  
2116 2116  (% class="box infomessage" %)
... ... @@ -2122,7 +2122,7 @@
2122 2122  
2123 2123  (% style="color:#000000" %)Метод запроса: **POST**
2124 2124  
2125 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
1522 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
2126 2126  
2127 2127  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2128 2128  
... ... @@ -2237,6 +2237,124 @@
2237 2237   }
2238 2238  ]
2239 2239  
1637 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1638 +
1639 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1640 +
1641 +(% class="box infomessage" %)
1642 +(((
1643 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1644 +)))
1645 +
1646 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1647 +
1648 +(% style="color:#000000" %)Метод запроса: **GET**
1649 +
1650 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1651 +
1652 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1653 +
1654 +(% style="color:#000000" %)Ответ:
1655 +
1656 +(% style="color:#000000" %){
1657 +
1658 + "id": "", ~/~/ ID типа датчика 
1659 + "name": "", ~/~/ Название
1660 + "description": "", ~/~/ Описание
1661 +
1662 +(% style="text-align:left" %)
1663 +(% style="color:#000000" %)}
1664 +
1665 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1666 +
1667 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1668 +
1669 +(% class="box infomessage" style="text-align: left;" %)
1670 +(((
1671 +**POST /api/v3/terminalMessages/count**
1672 +)))
1673 +
1674 +(% style="text-align: left;" %)
1675 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1676 +
1677 +(% style="text-align: left;" %)
1678 +Метод запроса **POST**
1679 +
1680 +(% style="text-align: left;" %)
1681 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1682 +
1683 +(% style="text-align: left;" %)
1684 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1685 +
1686 +(% style="text-align: left;" %)
1687 +{
1688 + "vehicleIds": [
1689 + id ~/~/ здесь передается список идентификаторов объектов
1690 + ],
1691 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1692 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1693 +}
1694 +
1695 +(% style="text-align: left;" %)
1696 +Ответ:
1697 +
1698 +(% style="text-align: left;" %)
1699 +[
1700 + {
1701 + "vehicleId": 0, ~/~/ идентификатор объекта
1702 + "count": 0 ~/~/ количество сообщений за период
1703 + }
1704 +]
1705 +
1706 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1707 +
1708 +(% class="box infomessage" %)
1709 +(((
1710 +**POST /api/v3/terminalMessages**
1711 +)))
1712 +
1713 +Метод возвращает список сообщений терминала объекта за выбранный период.
1714 +
1715 +(% style="text-align: left;" %)
1716 +Метод запроса **POST**
1717 +
1718 +(% style="text-align: left;" %)
1719 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1720 +
1721 +(% style="text-align: left;" %)
1722 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1723 +
1724 +{
1725 + "vehicleId": 0, ~/~/ id объекта
1726 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1727 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1728 +}
1729 +
1730 +Ответ:
1731 +
1732 +[
1733 + {
1734 + "messages": [
1735 + {
1736 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1737 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1738 + "speed": 0, ~/~/ Скорость, км/ч
1739 + "altitude": 0, ~/~/ Высота, м
1740 + "latitude": 0, ~/~/ Широта [-90°;90°]
1741 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1742 + "satellites": 0, ~/~/ Кол-во спутников
1743 + "voltage": 0, ~/~/ Напряжение
1744 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1745 + "additionalProp1": "string",
1746 + "additionalProp2": "string",
1747 + "additionalProp3": "string"
1748 + },
1749 + "photoCount": 0 ~/~/ Кол-во фото
1750 + }
1751 + ]
1752 + }
1753 +]
1754 +
2240 2240  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2241 2241  
2242 2242  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -3035,6 +3035,7 @@
3035 3035   }
3036 3036  ]
3037 3037  
2553 +
3038 3038  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3039 3039  
3040 3040  (% class="box infomessage" %)
... ... @@ -3057,6 +3057,7 @@
3057 3057   }
3058 3058  ]
3059 3059  
2576 +
3060 3060  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3061 3061  
3062 3062  (% class="box successmessage" %)
... ... @@ -3085,6 +3085,7 @@
3085 3085   "deleted": true
3086 3086  }
3087 3087  
2605 +
3088 3088  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3089 3089  
3090 3090  (% class="box warningmessage" %)
... ... @@ -3114,6 +3114,7 @@
3114 3114   "deleted": true
3115 3115  }
3116 3116  
2635 +
3117 3117  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3118 3118  
3119 3119  (% class="box errormessage" %)
... ... @@ -3121,7 +3121,7 @@
3121 3121  **DELETE /api/v3/Rfids/{rfidGuid}**
3122 3122  )))
3123 3123  
3124 -Передаем параметр **rfidGuid** - идентификатор карты-метки
2643 +Передаем параметр rfidGuid - идентификатор карты-метки
3125 3125  
3126 3126  Ответ:
3127 3127  
... ... @@ -3128,325 +3128,6 @@
3128 3128  Success
3129 3129  
3130 3130  
3131 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3132 -
3133 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3134 -
3135 -(% class="box infomessage" %)
3136 -(((
3137 -**GET /api/v3/Billing/client/balance/{clientId}**
3138 -)))
3139 -
3140 -Параметр запроса: **clientId **- идентификатор клиента.
3141 -
3142 -Ответ:
3143 -
3144 -{
3145 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3146 - "Balance": 0
3147 -}
3148 -
3149 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3150 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3151 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3152 -
3153 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3154 -
3155 -(% class="box infomessage" %)
3156 -(((
3157 -**GET /api/v3/Billing/client/constraint/{clientId}**
3158 -)))
3159 -
3160 -Параметр запроса: **clientId **- идентификатор клиента.
3161 -
3162 -Ответ:
3163 -
3164 -{
3165 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3166 - "CalculationType": 0,
3167 - "PermissibleBalance": 0,
3168 - "DefermentDays": 0,
3169 - "SendUiNotifications": true,
3170 - "SendEmailNotifications": true,
3171 - "IsPrivate": true,
3172 -}
3173 -
3174 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3175 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3176 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3177 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3178 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3179 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3180 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3181 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3182 -
3183 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3184 -
3185 -(% class="box infomessage" %)
3186 -(((
3187 -**GET /api/v3/Billing/client/plan/{clientId}**
3188 -)))
3189 -
3190 -Параметры запроса:
3191 -
3192 -**clientId **- идентификатор клиента.
3193 -
3194 -**planId **- идентификатор тарифного плана.
3195 -
3196 -Ответ:
3197 -
3198 -{
3199 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3200 - "Plan": { **~/~/ Описание тарифного плана**
3201 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3202 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3203 - "Name": "string",
3204 - "IsArchived": true,
3205 - "Constraint": {
3206 - "CalculationType": 0,
3207 - "PermissibleBalance": 0,
3208 - "DefermentDays": 0
3209 - },
3210 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3211 - {
3212 - "Feature": "string",
3213 - "IsFactual": true,
3214 - "Limit": 0,
3215 - "Price": 0,
3216 - "PeriodValue": 0,
3217 - "PeriodType": 0
3218 - }
3219 - ]
3220 - },
3221 - "DebitDate": "2023-10-18T12:46:24.213Z",
3222 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3223 - {
3224 - "Feature": "string",
3225 - "IsEnabled": true,
3226 - "IsPrivate": true,
3227 - "IsFactual": true,
3228 - "Limit": 0,
3229 - "Price": 0,
3230 - "DebitDate": "2023-10-18T12:46:24.213Z",
3231 - "PeriodValue": 0,
3232 - "PeriodType": 0
3233 - }
3234 - ]
3235 -}
3236 -
3237 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3238 -|ClientId|Идентификатор клиента
3239 -|Id|Идентификатор тарифного плана
3240 -|OwnerId|Идентификатор клиента-владельца
3241 -|Name|Наименование тарифного плана
3242 -|IsArchived|Признак, определяющий архивный тарифный план
3243 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3244 -|PermissibleBalance|Допустимый баланс
3245 -|DefermentDays|Отсрочка, количество дней
3246 -|Feature|Код услуги
3247 -|IsEnabled|Признак, определяющий активирована ли услуга
3248 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3249 -|IsFactual|Признак, определяющий расчёт по факту
3250 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3251 -|Price|Цена за единицу.
3252 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3253 -|PeriodValue|Значение периода.
3254 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3255 -
3256 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3257 -
3258 -(% class="box infomessage" %)
3259 -(((
3260 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3261 -)))
3262 -
3263 -Параметр запроса: **clientId **- идентификатор клиента.
3264 -
3265 -Ответ:
3266 -
3267 -[
3268 - {
3269 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3270 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3271 - "Name": "string",
3272 - "IsArchived": true,
3273 - "Constraint": {
3274 - "CalculationType": 0,
3275 - "PermissibleBalance": 0,
3276 - "DefermentDays": 0
3277 - },
3278 - "Features": [
3279 - {
3280 - "Feature": "string",
3281 - "IsFactual": true,
3282 - "Limit": 0,
3283 - "Price": 0,
3284 - "PeriodValue": 0,
3285 - "PeriodType": 0
3286 - }
3287 - ]
3288 - }
3289 -]
3290 -
3291 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3292 -|ClientId|Идентификатор клиента
3293 -|Id|Идентификатор тарифного плана
3294 -|OwnerId|Идентификатор клиента-владельца
3295 -|Name|Наименование тарифного плана
3296 -|IsArchived|Признак, определяющий архивный тарифный план
3297 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3298 -|PermissibleBalance|Допустимый баланс
3299 -|DefermentDays|Отсрочка, количество дней
3300 -|Feature|Код услуги
3301 -|IsFactual|Признак, определяющий расчёт по факту
3302 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3303 -|Price|Цена за единицу.
3304 -|PeriodValue|Значение периода.
3305 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3306 -
3307 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3308 -
3309 -(% class="box infomessage" %)
3310 -(((
3311 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3312 -)))
3313 -
3314 -Параметр запроса: **clientId **- идентификатор клиента.
3315 -
3316 -Ответ:
3317 -
3318 -[
3319 - {
3320 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3321 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3322 - "Name": "string",
3323 - "IsArchived": true,
3324 - "Constraint": {
3325 - "CalculationType": 0,
3326 - "PermissibleBalance": 0,
3327 - "DefermentDays": 0
3328 - },
3329 - "Features": [
3330 - {
3331 - "Feature": "string",
3332 - "IsFactual": true,
3333 - "Limit": 0,
3334 - "Price": 0,
3335 - "PeriodValue": 0,
3336 - "PeriodType": 0
3337 - }
3338 - ]
3339 - }
3340 -]
3341 -
3342 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3343 -|ClientId|Идентификатор клиента
3344 -|Id|Идентификатор тарифного плана
3345 -|OwnerId|Идентификатор клиента-владельца
3346 -|Name|Наименование тарифного плана
3347 -|IsArchived|Признак, определяющий архивный тарифный план
3348 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3349 -|PermissibleBalance|Допустимый баланс
3350 -|DefermentDays|Отсрочка, количество дней
3351 -|Feature|Код услуги
3352 -|IsFactual|Признак, определяющий расчёт по факту
3353 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3354 -|Price|Цена за единицу.
3355 -|PeriodValue|Значение периода.
3356 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3357 -
3358 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3359 -
3360 -(% class="box warningmessage" %)
3361 -(((
3362 -**PUT /api/v3/Billing/client/balance**
3363 -)))
3364 -
3365 -Тело запроса:
3366 -
3367 -{
3368 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3369 - "Balance": 0
3370 -}
3371 -
3372 -Ответ: Success
3373 -
3374 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3375 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3376 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3377 -
3378 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3379 -
3380 -(% class="box warningmessage" %)
3381 -(((
3382 -**PUT /api/v3/Billing/client/constraint**
3383 -)))
3384 -
3385 -Тело запроса:
3386 -
3387 -{
3388 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3389 - "CalculationType": 0,
3390 - "PermissibleBalance": 0,
3391 - "DefermentDays": 0,
3392 - "SendUiNotifications": true,
3393 - "SendEmailNotifications": true,
3394 - "IsPrivate": true,
3395 -}
3396 -
3397 -Ответ: Success
3398 -
3399 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3400 -|ClientId|Идентификатор клиента
3401 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3402 -|PermissibleBalance|Допустимый баланс
3403 -|DefermentDays|(((
3404 -Отсрочка, количество дней
3405 -)))
3406 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3407 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3408 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3409 -
3410 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3411 -
3412 -(% class="box warningmessage" %)
3413 -(((
3414 -**PUT /api/v3/Billing/client/plan**
3415 -)))
3416 -
3417 -Тело запроса:
3418 -
3419 -{
3420 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3421 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3422 - "Features": [
3423 - {
3424 - "Feature": "string",
3425 - "IsEnabled": true,
3426 - "IsFactual": true,
3427 - "Limit": 0,
3428 - "Price": 0,
3429 - "DebitDate": "2023-10-18T13:26:58.987Z",
3430 - "PeriodValue": 0,
3431 - "PeriodType": 0
3432 - }
3433 - ]
3434 -}
3435 -
3436 -Ответ: Success
3437 -
3438 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3439 -|ClientId|Идентификатор клиента
3440 -|PlanId|Идентификатор тарифного плана
3441 -|Feature|Код услуги
3442 -|IsEnabled|Признак, определяющий активирована ли услуга
3443 -|IsFactual|Признак, определяющий расчёт по факту
3444 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3445 -|Price|Цена за единицу.
3446 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3447 -|PeriodValue|Значение периода.
3448 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3449 -
3450 3450  (% class="box" lang="en-US" style="text-align: center;" %)
3451 3451  (((
3452 3452  (% 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 г.