Last modified by Андрей Калиновский on 2025/04/24 15:46
<
From version < 163.1 >
edited by Михаил Жучков
on 2024/08/02 12:00
To version < 7.1 >
edited by Андрей Калиновский
on 2022/08/31 14:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
1 +XWiki.Gadmin
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,4434 +1,454 @@
1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -**Содержание страницы:**
4 -)))
1 +== Описание ГЛОНАССSoft Public API ==
5 5  
6 -{{toc/}}
3 +== ==
7 7  
5 + **Действующие ограничения**
6 +
8 8  
9 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 +- Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
10 10  
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 -
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
13 +\\
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
15 + **Авторизация**
18 18  
19 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
19 +Метод запроса: GET
22 22  
23 -(% class="box successmessage" %)
24 -(((
25 -(% lang="en-US" %)**POST /api/v3/auth/login**
26 -)))
21 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
27 27  
28 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26 +
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
28 + **Получение списка объектов**
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
37 37  
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}
34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
42 42  
43 -(% style="color:#000000" %)**Ответ:**
36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
44 44  
45 -(% lang="en-US" %)
46 -(% style="color:#000000" %){
47 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
48 - "User": "testuser" , ~/~/ имя пользователя(%%)
49 -}
38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
50 50  
51 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
52 52  
53 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
54 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
55 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
56 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
57 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
42 +Метод запроса: POST
58 58  
59 -(% class="wikigeneratedid" %)
60 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
61 61  
62 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
46 +В заголовках запроса:
63 63  
64 -(% class="box infomessage" %)
65 -(((
66 -(% lang="en-US" %)**GET /api/v3/auth/check**
67 -)))
48 +−Content-Type: application/json
68 68  
69 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
50 +−X-Auth: Токен авторизации
70 70  
71 -(% style="color:#000000" %)Метод запроса: **GET**
52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
72 72  
73 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
54 +{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
74 74  
75 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
76 76  
77 -(% lang="en-US" %)
78 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
79 79  
80 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
81 81  
82 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
62 +0 - «Блокировка»
83 83  
84 -(% class="box infomessage" %)
85 -(((
86 -**GET api/v3/agents/{id}**
87 -)))
64 +1 - «Активен»,
88 88  
89 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
66 +2 - «Отменен»
90 90  
91 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
68 +3 - «Оборудован»
92 92  
93 -(% style="color:#000000" %)Метод запроса: **GET**
70 +4 - «Диагностика»
94 94  
95 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
72 +5 - «Сервис»
96 96  
97 -Запрос должен содержать данные параметра "**agentId**"
74 +6 - «Демонтаж»
98 98  
99 -(% style="color:#000000" %)Ответ:
100 -{
101 - "agentId": "",  (%%)
102 - "parentId": "",
103 - "parentName": "string",
104 - "name": "string",
105 - "fullName": "string",
106 - "agentInfoType": 0,
107 - "isForeign": true/false,
108 - "district": "string", 
109 - "region": "string",
110 - "city": "string",
111 - "inn": "string",
112 - "kpp": "string",
113 - "address": "string",
114 - "addressFact": "string",
115 - "email": "string",
116 - "director": "string",
117 - "bankName": "string",
118 - "bankBIK": "string",
119 - "bankRS": "string",
120 - "bankKS": "string"
121 - }
76 +7 - «Монтаж»
122 122  
123 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
124 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
125 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
126 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
127 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
128 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
129 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
130 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
131 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
132 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
133 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
134 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
135 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
136 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
137 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
138 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
139 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
140 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
141 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
142 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
143 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
78 +8 - «Дозаказ»
144 144  
145 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
80 +9 - «Обслужен»
146 146  
147 -(% class="box infomessage" %)
148 -(((
149 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
150 -)))
82 +10 - «Списан»
151 151  
152 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
84 +11 - «Неисправен»
153 153  
154 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
86 +12 - «Проверен»
155 155  
156 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
88 +13 - «Не эксплуатируется»
89 +
157 157  
158 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
91 + **Получение списка клиентов.**
159 159  
160 -(% style="color:#000000" %)Метод запроса: **POST**
93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
161 161  
162 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
163 163  
164 -(% style="color:#000000" %)Параметр запроса:
97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
165 165  
166 -(% style="color:#000000" %){
167 - "parentId": "string"
168 -}
99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
169 169  
170 -(% style="color:#000000" %)Ответ:
101 +Метод запроса: GET
171 171  
172 -{
173 - "agentId": "",(% style="color:#000000" %)   (%%)
174 - "parentId": "",
175 - "name": "string",
176 - "fullName": "string",
177 - "agentInfoType": 0,
178 -(% style="color:#000000" %) "status": "",
179 -}
103 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
180 180  
105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
181 181  
182 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
183 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
184 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
185 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
186 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
187 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
188 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
189 -
190 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
191 -
192 -(% class="box successmessage" %)
193 -(((
194 -**POST /api/v3/agents **
195 -)))
196 -
197 -Метод позволяет добавить клиента, указанного в запросе.
198 -
199 -Метод запроса: **POST**
200 -
201 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
202 -
203 203  В заголовках запроса: X-Auth: Токен авторизации
204 204  
205 -Параметры в теле запроса (JSON):
109 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
206 206  
207 -{
208 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
209 - "name": "string", ~/~/ имя
210 - "fullName": "string", ~/~/ полное наименование
211 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
212 - "isForeign": true, ~/~/ иностранный контрагент
213 - "district": "string", ~/~/ округ
214 - "region": "string", ~/~/ регион
215 - "city": "string", ~/~/ город
216 - "inn": "string", ~/~/ ИНН
217 - "kpp": "string", ~/~/ КПП
218 - "address": "string", ~/~/ юридический адрес
219 - "addressFact": "string", ~/~/ фактический адрес
220 - "email": "string", ~/~/ email
221 - "director": "string", ~/~/ ФИО руководителя
222 - "bankName": "string", ~/~/ банк
223 - "bankBIK": "string", ~/~/ БИК
224 - "bankRS": "string", ~/~/ номер счёта
225 - "bankKS": "string" ~/~/ корр. счёт
226 -}
111 +Примечание. Возможные значение параметра agentInfoType:
112 +
227 227  
228 -Ответ:
114 + **Получение списка пользователей.**
229 229  
230 -{
231 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
232 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
233 - "name": "string", ~/~/ имя
234 - "fullName": "string", ~/~/ полное наименование
235 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
236 - "isForeign": true, ~/~/ иностранный контрагент
237 - "district": "string", ~/~/ округ
238 - "region": "string", ~/~/ регион
239 - "city": "string", ~/~/ город
240 - "inn": "string", ~/~/ ИНН
241 - "kpp": "string", ~/~/ КПП
242 - "address": "string", ~/~/ юридический адрес
243 - "addressFact": "string", ~/~/ фактический адрес
244 - "email": "string", ~/~/ email
245 - "director": "string", ~/~/ ФИО руководителя
246 - "bankName": "string", ~/~/ банк
247 - "bankBIK": "string", ~/~/ БИК
248 - "bankRS": "string", ~/~/ номер счёта
249 - "bankKS": "string" ~/~/ корр. счёт
250 -}
116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
251 251  
252 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
253 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
254 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
255 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
256 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
257 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
258 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
259 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
260 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
261 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
262 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
263 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
264 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
265 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
266 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
267 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
268 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
269 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
270 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
271 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
272 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
273 273  
274 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
120 +Метод запроса: POST
275 275  
276 -(% class="box warningmessage" %)
277 -(((
278 -**PUT /api/v3/agents**
279 -)))
122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
280 280  
281 -Метод позволяет отредактировать клиента, указанного в запросе.
124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
282 282  
283 -Метод запроса: **PUT**
126 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
127 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
128 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
129 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
284 284  
285 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
286 -
287 -В заголовках запроса: X-Auth: Токен авторизации
288 -
289 -Параметры в теле запроса (JSON):
290 -
291 -{
292 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
293 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
294 - "name": "string", ~/~/ имя
295 - "fullName": "string", ~/~/ полное наименование
296 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
297 - "isForeign": true, ~/~/ иностранный контрагент
298 - "district": "string", ~/~/ округ
299 - "region": "string", ~/~/ регион
300 - "city": "string", ~/~/ город
301 - "inn": "string", ~/~/ ИНН
302 - "kpp": "string", ~/~/ КПП
303 - "address": "string", ~/~/ юридический адрес
304 - "addressFact": "string", ~/~/ фактический адрес
305 - "email": "string", ~/~/ email
306 - "director": "string", ~/~/ ФИО руководителя
307 - "bankName": "string", ~/~/ банк
308 - "bankBIK": "string", ~/~/ БИК
309 - "bankRS": "string", ~/~/ номер счёта
310 - "bankKS": "string" ~/~/ корр. счёт
311 311  }
312 312  
313 -Ответ:
133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
314 314  
315 -{
316 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
317 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
318 - "name": "string", ~/~/ имя
319 - "fullName": "string", ~/~/ полное наименование
320 - "isForeign": true, ~/~/ иностранный контрагент
321 - "district": "string", ~/~/ округ
322 - "region": "string", ~/~/ регион
323 - "city": "string", ~/~/ город
324 - "inn": "string", ~/~/ ИНН
325 - "kpp": "string", ~/~/ КПП
326 - "address": "string", ~/~/ юридический адрес
327 - "addressFact": "string", ~/~/ фактический адрес
328 - "email": "string", ~/~/ email
329 - "director": "string", ~/~/ ФИО руководителя
330 - "bankName": "string", ~/~/ банк
331 - "bankBIK": "string", ~/~/ БИК
332 - "bankRS": "string", ~/~/ номер счёта
333 - "bankKS": "string" ~/~/ корр. счёт
334 -}
135 +{{{ "sessionDuration": "", // длительность сессии в минутах}}}
335 335  
336 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
337 337  
338 -(% class="box errormessage" %)
339 -(((
340 -**DELETE /api/v3/agents/{clientId}**
341 -)))
140 + **Получение списка типов устройств**
342 342  
343 -Метод позволяет удалить клиента, указанного в строке запроса.
142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
344 344  
345 -Метод запроса: **DELETE**
144 +Метод запроса: GET
346 346  
347 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
146 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
348 348  
349 -Параметр запроса: **{clientId}** - Guid пользователя
148 +В заголовках запроса:X-Auth: Токен авторизации
350 350  
351 -В заголовках запроса: X-Auth: Токен авторизации
150 +Ответ: [
352 352  
353 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
152 +{{{ {
153 + "deviceTypeId" : "", // ID типа устройства
154 + "deviceTypeName" : "" // Название типа устройства
155 + },}}}
354 354  
355 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
157 +… ]
158 +
356 356  
357 -(% class="box warningmessage" %)
358 -(((
359 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
360 -)))
160 + **Получение списка типов датчиков**
361 361  
362 -Метод позволяет изменить статус клиента, указанного в запросе.
162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
363 363  
364 -В пути указывается GUID клиента и статус клиента.
164 +Метод запроса: GET
365 365  
366 -**status **- значение 0 - заблокирован, 1 - активен.
166 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
367 367  
368 -Ответ: Code 204
168 +В заголовках запроса:X-Auth: Токен авторизации
369 369  
370 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
170 +Ответ: [
371 371  
372 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
172 +{{{ {}}}
373 373  
374 -(% class="box successmessage" %)
375 -(((
376 -(% lang="en-US" %)**POST /api/v3/users**
377 -)))
174 +«id»: «», //ID типа датчика «name»: «», //Название
378 378  
379 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
176 +{{{ "description": "" // Описание
177 + },}}}
380 380  
381 -(% style="color:#000000" %)Метод запроса: **POST**
179 +… ]
180 +
382 382  
383 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
182 + **Получение информации об объекте**
384 384  
385 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
386 386  
387 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
388 388  
389 -(% style="color:#000000" %)
390 -{ 
391 - "lastName": "", ~/~/ фамилия
392 - "firstName": "", ~/~/ имя
393 - "position": "", ~/~/ должность
394 - "phone": "", ~/~/ телефон
395 - "organization": "", ~/~/ организация
396 - "login": "", ~/~/ логин (обязателен)
397 - "password": "", ~/~/ пароль (обязателен)
398 - "email": "", ~/~/ email (обязателен)
399 - "description": "string", ~/~/ Описание
400 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
401 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
402 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
403 - "parentId": "", ~/~/ Guid родительского агента
404 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
405 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
406 - "doubleAuth":
407 - {
408 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
409 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
410 - },
411 - "groups":
412 - [
413 - "string" ~/~/ группы пользователя, перечисление названия системных ролей
414 - ],
415 - "customGroups":
416 - [
417 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
418 - ],
419 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
420 -}
421 -{
422 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
423 - "lastName": "string",
424 - "firstName": "string",
425 - "position": "string",
426 - "phone": "string",
427 - "organization": "string",
428 - "login": "string",
429 - "password": "string",
430 - "email": "string",
188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
431 431  
432 -(% style="text-align:left" %)
433 -(% style="color:#000000; font-weight:normal" %)Ответ:
434 -{     
435 - "id": "" , ~/~/ ID пользователя
436 - "lastName": "" , ~/~/ Фамилия ,
437 - "firstName": "" , ~/~/ Имя
438 - "position": "" , ~/~/ Должность
439 - "phone": "" , ~/~/ Телефон
440 - "organization": "" , ~/~/ Организация
441 - "login": "" , ~/~/ Логин
442 - "password": "" , ~/~/ Пароль
443 - "email": "" , ~/~/ Email
444 - "description": "" , ~/~/ Описание
445 - "isEnabled": "" , ~/~/ Признак включения
446 - "parentId": "" , ~/~/ Guid родительского агента
447 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
448 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
449 - "kind": "" , ~/~/ тип аутентификации
450 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
451 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
452 -}
190 +Метод запроса: GET
453 453  
192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
454 454  
455 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
456 456  
457 -(% class="box infomessage" %)
458 -(((
459 -(% lang="en-US" %)**POST /api/v3/users/find**
460 -)))
196 +В заголовках запроса: X-Auth: Токен авторизации
461 461  
462 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
463 -
464 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
465 -
466 -(% style="color:#000000" %)Метод запроса: **POST**
467 -
468 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
469 -
470 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
471 -
472 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
473 -
474 -(% style="color:#000000" %){(%%)
475 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
476 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
477 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
478 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
479 -(% style="color:#000000" %)}
480 -
481 -(% style="color:#000000" %)Ответ:
482 -
483 -(% style="color:#000000" %){         (%%)
484 - "id": "" , ~/~/ идентификатор пользователя
485 - "lastName": "" , ~/~/ фамилия
486 - "firstName": "" , ~/~/ имя
487 - "position": "" , ~/~/ должность
488 - "phone": "" , ~/~/ телефон
489 - "parentId": "" , ~/~/ идентификатор клиента-родителя
490 - "parentName": "" , ~/~/ наименование клиента-родителя
491 - "organization": "" , ~/~/ организация
492 - "login": "" , ~/~/ логин
493 - "email": "" , ~/~/ E-mail
494 - "sessionDuration":"", ~/~/ длительность сессии в минутах
495 - "status": "1",  ~/~/ статус пользователя
496 - "lastLogged": "", ~/~/ дата/время последней авторизации
497 -(% style="color:#000000" %)}
498 -
499 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
500 -
501 -(% class="box infomessage" %)
502 -(((
503 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
504 -)))
505 -
506 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
507 -
508 -(% style="color:#000000" %)Метод запроса: **GET**
509 -
510 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
511 -
512 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
513 -
514 -(% style="color:#000000" %)Ответ:
515 -
516 -(((
517 -(((
518 -{
519 - "id": "", ~/~/ GUID пользователя
520 - "lastName": "", ~/~/ Фамилия 
521 - "firstName": "", ~/~/ Имя
522 - "position": "", ~/~/ Должность
523 - "phone": "", ~/~/ Номер телефона
524 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
525 - "parentName": "", Наименование клиента, которому принадлежит пользователь
526 - "organization": "", ~/~/ Организация
527 - "login": "", ~/~/ Логин пользователя
528 - "email": "", ~/~/ Адрес электронной почты
529 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
530 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
531 - "description": "", ~/~/ Описание
532 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
533 - "doubleAuth":
534 - {
535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 - },
538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
540 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
541 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
542 - "groups": [], ~/~/ Список ролей пользователя
543 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
544 - "authDevices": [ ], ~/~/ Список авторизованных устройств
545 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
546 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
547 -}
548 -)))
549 -)))
550 -
551 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
552 -
553 -(% class="box warningmessage" %)
554 -(((
555 -(% lang="en-US" %)**PUT /api/v3/users**
556 -)))
557 -
558 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
559 -
560 -(% style="color:#000000" %)Метод запроса: **PUT**
561 -
562 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
563 -
564 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
565 -
566 -(% lang="en-US" style="text-align:left" %)
567 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
568 -
569 -(% lang="en-US" style="text-align:left" %)
570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
571 - "id": "" , ~/~/ ID пользователя 
572 - "lastName": "" , ~/~/ фамилия
573 - "firstName": "" , ~/~/ имя
574 - "position": "" , ~/~/ должность
575 - "phone": "" , ~/~/ телефон
576 - "organization": "" , ~/~/ организация
577 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
578 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
579 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
580 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
581 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
582 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
583 - "isEnabled": "" , ~/~/ признак включения
584 - "parentId": "" , ~/~/ Guid родительского агента
585 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
586 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
587 - "doubleAuth":
588 - {
589 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
590 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
591 - },
592 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
593 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
594 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
595 -
596 -(% lang="en-US" style="text-align:left" %)
597 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
598 -
599 -(% lang="en-US" style="text-align:left" %)
600 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
601 - "id": "" , ~/~/ идентификатор пользователя
602 - "lastName": "" , ~/~/ фамилия
603 - "firstName": "" , ~/~/ имя
604 - "position": "" , ~/~/ должность
605 - "phone": "" , ~/~/ телефон
606 - "organization": "" , ~/~/ организация
607 - "login": "" , ~/~/ логин
608 - "password": "" , ~/~/ пароль 
609 - "email": "" , ~/~/ email
610 - "description": "" , ~/~/ описание
611 - "isEnabled": "" , ~/~/ признак включения
612 - "parentId": "" , ~/~/ Guid родительского агента
613 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
614 - "doubleAuth":
615 - {
616 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
617 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
618 - },
619 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
620 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
621 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
622 -}
623 -
624 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
625 -
626 -(% class="box warningmessage" %)
627 -(((
628 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
629 -)))
630 -
631 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
632 -
633 -(% style="color:#000000" %)Метод запроса: **PUT**
634 -
635 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
636 -
637 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
638 -
639 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
640 -
641 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
642 -
643 -(% style="color:#000000" %){(%%)
644 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
645 - "description": "" , ~/~/ описание
646 - "data": "" , ~/~/ данные, связанные со сменой статуса
647 -(% style="color:#000000" %)}
648 -
649 -(% style="text-align:left" %)
650 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
651 -
652 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
653 -
654 -(% class="box warningmessage" %)
655 -(((
656 -**POST /api/v3/users/disable**
657 -)))
658 -
659 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
660 -
661 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
662 -
663 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
664 -
665 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
666 -
667 - [ 
668 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
669 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
670 - ]
671 -
672 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
673 -
674 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
675 -
676 -(% class="box warningmessage" %)
677 -(((
678 -**POST /api/v3/users/enable**
679 -)))
680 -
681 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
682 -
683 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
684 -
685 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
686 -
687 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
688 -
689 - [ 
690 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
691 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
692 - ]
693 -
694 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
695 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
696 -
697 -(((
698 -В теле ответа:
699 -{
700 - "errorMessages": [
701 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
702 - ],
703 - "users": [
704 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
705 - ]
706 -}
707 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
708 -"users" - массив id пользователей, которых не удалось включить или отключить.
709 -)))
710 -
711 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
712 -
713 -(% class="box errormessage" %)
714 -(((
715 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
716 -)))
717 -
718 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
719 -
720 -(% style="color:#000000" %)Метод запроса: **DELETE**
721 -
722 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
723 -
724 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
725 -
726 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
727 -
728 -(% style="text-align:left" %)
729 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
730 -
731 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
732 -
733 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
734 -
735 -(% class="box infomessage" %)
736 -(((
737 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
738 -)))
739 -
740 -Метод возвращает полную информацию о модели объекта.
741 -
742 -(% style="color:#000000" %)Метод запроса: **GET**
743 -
744 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
745 -
746 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
747 -
748 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
749 -
750 -(% style="color:#000000" %)Ответ:
751 -
752 -(% style="color:#000000" %){
753 - "parentName": "string",
754 - "name": "string",
755 - "picture": "string",
756 - "minspeed": 0,
757 - "maxspeed": 0,
758 - "width": 0,
759 - "imbeddedtrailer": true,
760 - "hoppercapacity": 0,
761 - "hopperdischargespeed": 0,
762 - "modelType": 0,
763 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
764 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
765 - "deleted": true
766 -}
767 -
768 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
769 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
770 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
771 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
772 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
773 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
774 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
775 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
776 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
777 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
778 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
779 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
780 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
781 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
782 -
783 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
784 -
785 -(% class="box successmessage" %)
786 -(((
787 -(% lang="en-US" %)**POST /api/v3/models/find**
788 -)))
789 -
790 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
791 -
792 -(% style="color:#000000" %)Метод запроса: **POST**
793 -
794 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
795 -
796 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
797 -
798 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
799 -
800 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
801 -}
802 -
803 -(% style="color:#000000" %)Ответ:
804 -
805 -(% style="color:#000000" %)[
806 - {
807 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
808 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
809 - "parentName": "string",
810 - "name": "string",
811 - "modelType": 0
812 - }
813 -]
814 -
815 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
816 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
817 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
818 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
819 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
820 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
821 -
822 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
823 -
824 -(% class="box successmessage" %)
825 -(((
826 -(% lang="en-US" %)**POST /api/v3/models**
827 -)))
828 -
829 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
830 -
831 -(% style="color:#000000" %)Метод запроса: **POST**
832 -
833 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
834 -
835 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
836 -
837 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
838 -
839 -{
840 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
841 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
842 - "deleted": true,
843 - "extId": "string",
844 - "name": "string",
845 - "picture": "string",
846 - "minspeed": 0,
847 - "maxspeed": 0,
848 - "width": 0,
849 - "imbeddedtrailer": true,
850 - "fueloutlay": 0,
851 - "hoppercapacity": 0,
852 - "hopperdischargespeed": 0,
853 - "modelType": 0
854 -}
855 -
856 856  Ответ:
857 857  
858 858  {
859 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
860 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
861 - "deleted": true,
862 - "extId": "string",
863 - "name": "string",
864 - "picture": "string",
865 - "minspeed": 0,
866 - "maxspeed": 0,
867 - "width": 0,
868 - "imbeddedtrailer": true,
869 - "hoppercapacity": 0,
870 - "hopperdischargespeed": 0,
871 - "modelType": 0
872 -}
873 873  
874 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
875 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
876 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
877 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
878 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
879 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
880 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
881 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
882 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
883 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
884 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
885 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
886 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
887 -
888 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
889 -
890 -(% class="box warningmessage" %)
891 -(((
892 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
893 -)))
894 -
895 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
896 -
897 -(% style="color:#000000" %)Метод запроса: **PUT**
898 -
899 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
900 -
901 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
902 -
903 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
904 -
905 -{
906 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
907 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
908 - "deleted": true,
909 - "extId": "string",
910 - "name": "string",
911 - "picture": "string",
912 - "minspeed": 0,
913 - "maxspeed": 0,
914 - "width": 0,
915 - "imbeddedtrailer": true,
916 - "fueloutlay": 0,
917 - "hoppercapacity": 0,
918 - "hopperdischargespeed": 0,
919 - "modelType": 0
920 -}
921 -
922 -Ответ:
923 -
924 -{
925 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
926 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
927 - "deleted": true,
928 - "extId": "string",
929 - "name": "string",
930 - "picture": "string",
931 - "minspeed": 0,
932 - "maxspeed": 0,
933 - "width": 0,
934 - "imbeddedtrailer": true,
935 - "fueloutlay": 0,
936 - "hoppercapacity": 0,
937 - "hopperdischargespeed": 0,
938 - "modelType": 0
939 -}
940 -
941 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
942 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
943 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
944 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
945 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
946 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
947 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
948 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
949 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
950 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
951 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
952 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
953 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
954 -
955 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
956 -
957 -(% class="box errormessage" %)
958 -(((
959 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
960 -)))
961 -
962 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
963 -
964 -(% style="color:#000000" %)Метод запроса: **DELETE**
965 -
966 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
967 -
968 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
969 -
970 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
971 -
972 -Ответ: В случае успеха **Success 200**
973 -
974 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
975 -
976 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
977 -
978 -(% class="box infomessage" %)
979 -(((
980 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
981 -)))
982 -
983 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
984 -
985 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
986 -
987 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
988 -
989 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
990 -
991 -(% style="color:#000000" %)Метод запроса: **GET**
992 -
993 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
994 -
995 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
996 -
997 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
998 -
999 -(% style="color:#000000" %)Ответ:
1000 -
1001 -(((
1002 -{
1003 - "vehicleId": "", ~/~/ ID объекта
1004 - "name": "", ~/~/ Имя объекта
1005 - "imei": "", ~/~/ IMEI объекта
1006 - "deviceTypeId": , ~/~/ ID типа устройства
1007 - "deviceTypeName": "", ~/~/ Название типа устройства
1008 - "sim1": "", ~/~/ Номер SIM1
1009 - "sim2": "", ~/~/ Номер SIM2
1010 - "parentId": "", ~/~/ ID клиента-родителя
1011 - "parentName": "", ~/~/ Наименование клиента-родителя
1012 - "modelId": "", ~/~/ ID модели объекта
1013 - "modelName": "", ~/~/ Имя модели объекта
1014 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1015 - "unitName": "string", ~/~/ Наименование подразделения
1016 - "status": 0, ~/~/ Статус объекта
1017 - "createdAt": "", ~/~/ Дата создания объекта
1018 - },
1019 -"customFields": [ ~/~/ Произвольные поля
1020 - {
1021 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1022 - "name": "string", ~/~/ Имя поля
1023 - "value": "string", ~/~/ Значение поля
1024 - "forClient": true, ~/~/ Не используемая функция
1025 - "forTooltip": true, ~/~/ Отображать в подсказке
1026 - "forReport": true ~/~/ Отображать в отчете
1027 - }
1028 -
1029 -], ~/~/ Данные с вкладки нормы
1030 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1031 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1032 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1033 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1034 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1035 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1036 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1037 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1038 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1039 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1040 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1041 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1042 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1043 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1044 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1045 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1046 - "counters": { ~/~/ Счетчики
1047 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1048 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1049 - "mileage": 0, ~/~/ Текущий пробег
1050 - "motohours": 0, ~/~/ Текущие моточасы
1051 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1052 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
202 +{{{ "vehicleId": “”, // идентификатор объекта
203 + "name": "", // имя объекта
204 + "imei": "", // IMEI объекта
205 + "deviceTypeId": “”, // идентификатор устройства объекта
206 + "deviceTypeName": "" // наименование устройства объекта
207 + "parentId": "", // идентификатор клиента-родителя
208 + "parentName": "" // наименование клиента-родителя,
209 + "modelId": "", // идентификатор модели объекта
210 + "modelName": "" // наименование модели объекта,
211 + "unitId": "", // идентификатор подразделения
212 + "unitName": "", // наименование подразделения
213 + "status": “”, // статус объекта
214 + ...
1053 1053   },
216 + ...}}}
1054 1054  
1055 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1056 - "id": "string", ~/~/ ID объекта
1057 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1058 - "host": "string", ~/~/ CMSV6 Web Host
1059 - "login": "string", ~/~/ CMSV6 Account
1060 - "password": "string" ~/~/ CMSV6 Password
1061 - },
1062 -
1063 -"commandTemplates": [ ~/~/ Шаблоны команд
1064 - {
1065 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1066 - "name": "string", ~/~/ Наименование команды
1067 - "command": "string", ~/~/ Текст команды
1068 - "retries": 0 ~/~/ Количество попыток
1069 - }
1070 - ],
1071 - "sensors": [ ~/~/ Датчики
1072 - {
1073 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1074 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1075 - "type": 0, ~/~/ Тип датчика
1076 - "name": "string", ~/~/ Имя датчика
1077 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1078 - "inputNumber": 0, ~/~/ Номер входа
1079 - "pseudonym": "string", ~/~/ Псевдоним
1080 - "medianDegree": 0, ~/~/ Медианная фильтрация
1081 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1082 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1083 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1084 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1085 - {
1086 - "grades": [ ~/~/ Таблица тарировки 1
1087 - {
1088 - "input": 0, ~/~/ Входящее значение
1089 - "output": 0 ~/~/ Выходящее значение
1090 - }
1091 - ],
1092 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1093 - }
1094 - ],
1095 - "showInTooltip": true, ~/~/ Отображать в подсказке
1096 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1097 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1098 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1099 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1100 - "expr": "string", ~/~/ Формула
1101 - "children": [ ~/~/ массив дочерних датчиков
1102 - "string"
1103 - ],
1104 - "customParams": { ~/~/ прочие произвольные параметры
1105 - "additionalProp1": "string",
1106 - "additionalProp2": "string",
1107 - "additionalProp3": "string"
1108 - },
1109 -
1110 -~/~/ Характерные для произвольного:
1111 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1112 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1113 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1114 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1115 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1116 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1117 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1118 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1119 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1120 -~/~/ "ValueOn": "Вкл.",
1121 -~/~/ "ValueOff": "Выкл."
1122 - "summaryMaxValue": 0 ~/~/ Макс. значение
1123 - }
1124 - "drivers": [ ~/~/ Водители
1125 - {
1126 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1127 - "name": "string", ~/~/ Наименование
1128 - "description": "string",
1129 - "isDefault": true ~/~/ По умолчанию
1130 - }
1131 - ],
1132 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1133 - {
1134 - "id": "", ~/~/ ID  задания
1135 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1136 - "name": "", ~/~/ Наименование задания
1137 - "description": "", ~/~/ Описание задания
1138 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1139 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1140 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1141 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1142 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1143 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1144 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1145 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1146 - }
1147 - ],
1148 -"statusHistory": [ ~/~/ История статусов
1149 - {
1150 - "status": 0,
1151 - "date": "2023-05-22T09:57:39.562Z",
1152 - "description": "string",
1153 - "additionalInfo": "string"
1154 - }
1155 - ]
1156 1156  }
1157 -)))
1158 1158  
1159 -(% style="text-align:left" %)
1160 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
1161 1161  
1162 -(% style="text-align:left" %)
1163 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
223 + **Добавление пользователя**
1164 1164  
225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1165 1165  
1166 -== **Отправить команду на терминал** ==
227 +Метод запроса: POST
1167 1167  
1168 -(% class="box successmessage" %)
1169 -(((
1170 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1171 -)))
229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1172 1172  
1173 -Команда для отправки на тс.
231 +В заголовках запроса: X-Auth: Токен авторизации
1174 1174  
1175 -{  
1176 -"id": "", ~/~/идентификатор произвольного поля
1177 -"command": "", ~/~/ Текст команды
1178 -"retries": "", ~/~/ Количество попыток
1179 -"idTemplate": "" ~/~/ ID шаблона команды
1180 -}
233 +Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
1181 1181  
235 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
236 +
1182 1182  
1183 -== **Получить ответ на отправленную на ТС команду** ==
238 + **Редактирование пользователя**
1184 1184  
1185 -(% class="box infomessage" %)
1186 -(((
1187 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1188 -)))
240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1189 1189  
1190 -Идентификатор команды: cmdid
242 +Метод запроса: PUT
1191 1191  
1192 -Запрос от терминала на ответ команды
244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1193 1193  
1194 -Пример ответ от терминала:
246 +В заголовках запроса: X-Auth: Токен авторизации
1195 1195  
1196 -ID= "" ~/~/ идентификатор произвольного поля
1197 -Soft="" ~/~/ версия софта
1198 -GPS=4 ~/~/ тип трекера
1199 -Time=11:05:43 28.06.24 ~/~/ время запроса
1200 -Lat=45.056221 ~/~/ широта
1201 -Lon=39.035938 ~/~/ долгота
1202 -Speed=0.0 ~/~/ скорость
1203 -Course=181.4 ~/~/направление
248 +Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
1204 1204  
1205 -(((
1206 -== **Список отправленных объекту команд с ответами** ==
250 +{{{ "description": "", // описание
251 + "data": "" // данные, связанные со сменой статуса}}}
1207 1207  
1208 -(% class="box infomessage" %)
1209 -(((
1210 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1211 -)))
1212 -
1213 -Идентификатор ТС: vehicleId
1214 -
1215 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1216 -
1217 -Пример ответа терминала
1218 -
1219 -[ 
1220 -{    
1221 -"id": "", ~/~/ идентификатор пользователя
1222 -"commandText": "", ~/~/Текст команды.
1223 -"templateId": "", ~/~/Идентификатор шаблона
1224 -"updated": "", ~/~/ Время отправки  
1225 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1226 -"answer": "", ~/~/ Ответ терминала.
1227 -"status": "" ~/~/ Статус отправки
1228 1228  }
1229 -]
1230 -)))
1231 1231  
1232 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
1233 1233  
1234 -(% class="box successmessage" %)
1235 -(((
1236 -(% lang="en-US" %)**POST /api/v3/vehicles**
1237 -)))
258 + **Удаление пользователя**
1238 1238  
1239 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1240 1240  
1241 -(% style="color:#000000" %)Метод запроса: **POST**
262 +Метод запроса: DELETE
1242 1242  
1243 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
1244 1244  
1245 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1246 1246  
1247 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
1248 1248  
1249 -(% style="color:#000000" %){(%%)
1250 - "parentId": "" , ~/~/ ID клиента
1251 - "name": "" , ~/~/ имя ТС
1252 - "imei": "" , ~/~/ IMEI
1253 - "deviceTypeId": "" , ~/~/ ID типа устройства
1254 - "modelId": "" , ~/~/ ID модели
1255 - "unitId": "" , ~/~/ ID подразделения
1256 - "sim1": "" , ~/~/ Номер SIM 1
1257 - "sim2": "" , ~/~/ Номер SIM2
1258 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1259 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1260 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1261 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1262 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1263 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1264 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1265 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1266 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1267 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1268 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1269 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1270 - "mileageCalcMethod": 0,
1271 - "mileageCoeff": 0,
1272 - "locationByCellId": true,
1273 - "dottedLineTrackWhenNoCoords": true,
1274 - "counters": ~/~/ счетчики
1275 - {
1276 - "mileage": "" , ~/~/ пробег
1277 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1278 - "motohours": "" , ~/~/ моточасы
1279 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1280 - },
1281 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1282 - "enabled": true, ~/~/ флаг включения
1283 - "id": "" , ~/~/ идентификатор
1284 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1285 - "login": "" , ~/~/ имя учетной записи
1286 - "password": "" ~/~/ пароль учетной записи
1287 - },
1288 - "inspectionTasks": ~/~/ задания на ТО
1289 - {
1290 - "enabled": "" , ~/~/ Признак включения
1291 - "name": "" , ~/~/ Имя задания
1292 - "description": "" , ~/~/ Описание задания
1293 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1294 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1295 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1296 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1297 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1298 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1299 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1300 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1301 - }
1302 -"drivers": [ ~/~/ Водители
1303 - {
1304 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1305 - "isDefault": true
1306 - }
1307 - ],
1308 - "commandTemplates": [ ~/~/ Шаблон команды
1309 - {
1310 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1311 - "name": "string",
1312 - "command": "string",
1313 - "retries": 0
1314 - }
1315 - ],
1316 -"sensors": [ ~/~/ Датчики
1317 - {
1318 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1319 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1320 - "type": 0, ~/~/ Тип датчика
1321 - "name": "string", ~/~/ Имя датчика
1322 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1323 - "inputNumber": 0, ~/~/ Номер входа
1324 - "pseudonym": "string", ~/~/ Псевдоним
1325 - "medianDegree": 0, ~/~/ Медианная фильтрация
1326 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1327 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1328 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1329 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1330 - {
1331 - "grades": [ ~/~/ Таблица тарировки 1
1332 - {
1333 - "input": 0, ~/~/ Входящее значение
1334 - "output": 0 ~/~/ Выходящее значение
1335 - }
1336 - ],
1337 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1338 - }
1339 - ],
1340 - "showInTooltip": true, ~/~/ Отображать в подсказке
1341 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1342 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1343 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1344 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1345 - "expr": "string", ~/~/ Формула
1346 - "children": [ ~/~/ массив дочерних датчиков
1347 - "string"
1348 - ],
1349 - "customParams": { ~/~/ прочие произвольные параметры
1350 - "additionalProp1": "string",
1351 - "additionalProp2": "string",
1352 - "additionalProp3": "string"
1353 - },
1354 -~/~/ Характерные для произвольного:
1355 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1356 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1357 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1358 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1359 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1360 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1361 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1362 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1363 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1364 -~/~/ "ValueOn": "Вкл.",
1365 -~/~/ "ValueOff": "Выкл."
1366 - "summaryMaxValue": 0 ~/~/ Макс. значение
1367 - }
1368 - ],
1369 - "customFields": [ ~/~/ Произвольные поля
1370 - {
1371 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1372 - "name": "string",
1373 - "value": "string",
1374 - "forClient": true,
1375 - "forTooltip": true,
1376 - "forReport": true
1377 - }
1378 - ]
1379 -}
271 + **Добавление объекта**
1380 1380  
1381 -(% style="color:#000000" %)Ответ:
273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1382 1382  
1383 -(% style="color:#000000" %){(%%)
1384 - "vehicleId": "", ~/~/ID ТС 
1385 - "parentId": "", ~/~/Guid владельца ТС
1386 - "name": "", ~/~/Имя объекта
1387 - "imei": "", ~/~/IMEI
1388 - "deviceTypeId": "", ~/~/ID типа устройства
1389 - "modelId": "", ~/~/ID модели
1390 - "unitId": "", ~/~/ID подразделения
1391 - "sim1": "", ~/~/SIM1
1392 - "sim2": "", ~/~/SIM2
1393 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1394 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1395 - "counters": { ~/~/Счётчики
1396 - "mileageEnabled": true,
1397 - "motohoursEnabled": true,
1398 - "mileage": "",
1399 - "motohours": 345.0
1400 - },
1401 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1402 - "id": null,
1403 - "enabled": true, ~/~/флаг включения
1404 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1405 - "login": "", ~/~/ имя учетной записи
1406 - "password": "" ~/~/ пароль учетной записи
1407 - },
1408 - "inspectionTasks": { ~/~/ задания на ТО
1409 - "id": "", ~/~/ ID задачи
1410 - "enabled": false, ~/~/ Признак включения
1411 - "name": "", ~/~/ Имя задания
1412 - "description": "", ~/~/ Описание задания
1413 - "mileageCondition": "", ~/~/ Условие по пробегу
1414 - "lastMileage": "", ~/~/ Пробег (в метрах)
1415 - "motohoursCondition": "", ~/~/ Условие по моточасам
1416 - "lastMotohours": "", ~/~/ Моточасы
1417 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1418 - "kind": "", ~/~/ Вид периодичности по времени 
1419 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1420 - }
1421 -(% style="color:#000000" %)}
275 +Метод запроса: POST
1422 1422  
1423 -**Валидация:**
1424 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1425 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1426 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1427 1427  
1428 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
279 +В заголовках запроса: X-Auth: Токен авторизации
1429 1429  
1430 -(% class="box infomessage" %)
1431 -(((
1432 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
1433 -)))
281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1434 1434  
1435 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1436 -
1437 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1438 -
1439 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1440 -
1441 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1442 -
1443 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1444 -
1445 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1446 -
1447 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1448 -
1449 -(% style="color:#000000" %)Метод запроса: **POST**
1450 -
1451 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1452 -
1453 -(% style="color:#000000" %)В заголовках запроса:
1454 -
1455 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1456 -
1457 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1458 -
1459 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1460 -
1461 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1462 -
1463 -{
1464 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1465 - "name": null, ~/~/ Имя ТС (string, опционально)
1466 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1467 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1468 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1469 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1470 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1471 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1472 -}
1473 -
1474 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1475 -
1476 -(% style="color:#000000" %)Ответ:
1477 -
1478 -(% style="color:#000000" %){
1479 - "vehicleId": "" ~/~/ идентификатор объекта
1480 - "name": "" ~/~/ наименование объекта
1481 - "imei": "" ~/~/ IMEI объекта
1482 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1483 - "deviceTypeName": "" ~/~/ наименование типа устройства
1484 - "sim1": "" ~/~/ первый номер телефона
1485 - "sim2": "" ~/~/ второй номер телефона
1486 - "parentId": "" ~/~/ идентификатор клиента-родителя
1487 - "parentName": "" ~/~/ наименование клиента-родителя
1488 - "modelId": "" ~/~/ идентификатор модели объекта
1489 - "modelName": "" ~/~/ наименование модели объекта
1490 - "unitId": "" ~/~/ идентификатор подразделения
1491 - "unitName": "" ~/~/ наименование подразделения
1492 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1493 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1494 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1495 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1496 - "customFields": [ 
1497 - {
1498 - "id": "", ~/~/ идентификатор произвольного поля
1499 - "name": "", ~/~/ имя произвольного поля
1500 - "value": "", ~/~/ значение произвольного поля
1501 - "forClient": true, ~/~/ право на отображение у клиента
1502 - "forTooltip": false, ~/~/ право на отображение в подсказке
1503 - "forReport": false ~/~/ право на отображение в отчетах
1504 - }(%%)
1505 -(% style="color:#000000" %)}
1506 -
1507 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1508 -
1509 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1510 -
1511 -(% class="box successmessage" %)
1512 -(((
1513 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1514 -)))
1515 -
1516 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1517 -
1518 -(% style="color:#000000" %)Метод запроса: **POST**
1519 -
1520 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1521 -
1522 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1523 -
1524 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1525 -
1526 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1527 -
1528 -(% style="color:#000000" %){
1529 -
1530 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1531 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1532 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1533 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1534 - "description": "", ~/~/ Описание
1535 - "data": "", ~/~/ Данные
1536 - "overwrite": false, ~/~/ Флаг перезаписи
1537 - "stage": "", ~/~/ Состояние, может быть null
1538 -(% style="color:#000000" %)}
1539 -
1540 -(% style="color:#000000" %)Ответ:
1541 -
1542 -(% style="color:#000000" %){(%%)
1543 - "status": "", ~/~/ значение статуса
1544 - "date": "", ~/~/ Дата смены статуса 
1545 - "description": "", ~/~/ Описание
1546 - "data": "", ~/~/ Данные
1547 - "overwrite": false, ~/~/ Флаг перезаписи
1548 - "stage": "", ~/~/ Состояние
1549 -(% style="color:#000000" %) }
1550 -
1551 -== ==
1552 -
1553 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1554 -
1555 -(% class="box warningmessage" %)
1556 -(((
1557 -(% lang="en-US" %)**PUT /api/v3/vehicles**
1558 -)))
1559 -
1560 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1561 -
1562 -(% style="color:#000000" %)Метод запроса: **PUT**
1563 -
1564 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1565 -
1566 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1567 -
1568 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1569 -
1570 -(% style="color:#000000" %){
1571 - "vehicleId": , ~/~/ ID объекта
1572 - "parentId": "" , ~/~/ ID клиента
1573 - "name": "" , ~/~/ имя ТС
1574 - "imei": "" , ~/~/ IMEI
1575 - "deviceTypeId": "" , ~/~/ ID типа устройства
1576 - "modelId": "" , ~/~/ ID модели
1577 - "unitId": "" , ~/~/ ID подразделения
1578 - "sim1": "" , ~/~/ Номер SIM 1
1579 - "sim2": "" , ~/~/ Номер SIM2
1580 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1581 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1582 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1583 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1584 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1585 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1586 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1587 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1588 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1589 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1590 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1591 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1592 -
1593 - "mileageCalcMethod": 0,
1594 - "mileageCoeff": 0,
1595 - "locationByCellId": true,
1596 - "dottedLineTrackWhenNoCoords": true,
1597 - "counters": ~/~/ счетчики
1598 - {
1599 - "mileage": "" , ~/~/ пробег
1600 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1601 - "motohours": "" , ~/~/ моточасы
1602 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
283 +{{{ "parentId": "", // ID клиента
284 + "name": "", // имя ТС
285 + "imei": "", // IMEI
286 + "deviceTypeId": "",// ID типа устройства
287 + "modelId": "",
288 + "unitId": "", // ID подразделения
289 + "sim1": "", // Номер SIM 1
290 + "sim2": "", // Номер SIM2
291 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
292 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
293 + "consumptionIdle": "",// Расход топлива на холостом ходу
294 + "counters": {
295 + "mileage": "", // пробег
296 + "mileageEnabled": true, // флаг активности счётчика "пробег"
297 + "motohours":"", // моточасы
298 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
299 + },
300 + "cmsv6Parameters": { // параметры CMSv6
301 + "enabled": true, // флаг включения
302 + //"id": "", // идентификатор
303 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
304 + "login": "", // имя учетной записи
305 + "password": "" // пароль учетной записи
1603 1603   },
1604 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1605 - "enabled": true, ~/~/ флаг включения
1606 - "id": "" , ~/~/ идентификатор
1607 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1608 - "login": "" , ~/~/ имя учетной записи
1609 - "password": "" ~/~/ пароль учетной записи
1610 - },
1611 - "inspectionTasks": ~/~/ задания на ТО
307 + "inspectionTasks": [ // задания на ТО
1612 1612   {
1613 - "enabled": "" , ~/~/ Признак включения
1614 - "name": "" , ~/~/ Имя задания
1615 - "description": "" , ~/~/ Описание задания
1616 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1617 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1618 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1619 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1620 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1621 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1622 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1623 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1624 - }
1625 -
1626 -"drivers": [ ~/~/ Водители
1627 - {
1628 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1629 - "isDefault": true
1630 - }
1631 - ],
1632 - "commandTemplates": [ ~/~/ Шаблон команды
1633 - {
1634 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1635 - "name": "string",
1636 - "command": "string",
1637 - "retries": 0
1638 - }
1639 - ],
1640 -"sensors": [ ~/~/ Датчики
1641 - {
1642 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1643 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1644 - "type": 0, ~/~/ Тип датчика
1645 - "name": "string", ~/~/ Имя датчика
1646 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1647 - "inputNumber": 0, ~/~/ Номер входа
1648 - "pseudonym": "string", ~/~/ Псевдоним
1649 - "medianDegree": 0, ~/~/ Медианная фильтрация
1650 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1651 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1652 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1653 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1654 - {
1655 - "grades": [ ~/~/ Таблица тарировки 1
1656 - {
1657 - "input": 0, ~/~/ Входящее значение
1658 - "output": 0 ~/~/ Выходящее значение
1659 - }
1660 - ],
1661 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1662 - }
1663 - ],
1664 - "showInTooltip": true, ~/~/ Отображать в подсказке
1665 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1666 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1667 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1668 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1669 - "expr": "string", ~/~/ Формула
1670 - "children": [ ~/~/ массив дочерних датчиков
1671 - "string"
1672 - ],
1673 - "customParams": { ~/~/ прочие произвольные параметры
1674 - "additionalProp1": "string",
1675 - "additionalProp2": "string",
1676 - "additionalProp3": "string"
309 + "enabled": "", // Признак включения
310 + "name": "", // Имя задания
311 + "description": "", // Описание задания
312 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
313 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
314 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
315 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
316 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
317 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
318 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
319 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1677 1677   },
1678 -~/~/ Характерные для произвольного:
1679 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1680 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1681 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1682 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1683 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1684 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1685 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1686 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1687 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1688 -~/~/ "ValueOn": "Вкл.",
1689 -~/~/ "ValueOff": "Выкл."
1690 - "summaryMaxValue": 0 ~/~/ Макс. значение
1691 - }
1692 - ],
1693 - "customFields": [ ~/~/ Произвольные поля
1694 - {
1695 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1696 - "name": "string",
1697 - "value": "string",
1698 - "forClient": true,
1699 - "forTooltip": true,
1700 - "forReport": true
1701 - }
1702 - ]
1703 -}
321 + ]}}}
1704 1704  
1705 -(% style="color:#000000" %)Ответ:
323 +… }
1706 1706  
1707 -(% lang="en-US" style="text-align:left" %)
1708 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1709 - "vehicleId": "", ~/~/ ID ТС
1710 - "parentId": "", ~/~/ ID клиента
1711 - "name": "", ~/~/ имя ТС
1712 - "imei": "", ~/~/ IMEI
1713 - "deviceTypeId": "", ~/~/ типа устройства
1714 - "modelId": "", ~/~/ ID модели
1715 - "unitId": "", ~/~/ ID подразделения
1716 - "sim1": "", ~/~/ SIM 1
1717 - "sim2": "", ~/~/ SIM2
1718 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1719 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1720 - "counters": 
1721 - {
1722 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1723 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1724 - "mileage": "", ~/~/ пробег
1725 - "motohours": "", ~/~/ моточасы
1726 - }
1727 - "cmsv6Parameters": ~/~/ параметры CMSv6
1728 - {
1729 - "id": ~/~/ идентификатор
1730 - "enabled": true, ~/~/ флаг включения
1731 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1732 - "login": "", ~/~/ имя учетной записи
1733 - "password": "", ~/~/ пароль учетной записи
1734 - }
1735 - "inspectionTasks": ~/~/ задания на ТО
1736 - {
1737 - "id": "", ~/~/ ID задания
1738 - "enabled": false, ~/~/ Признак включения
1739 - "name": "", ~/~/ Имя задания
1740 - "description": "", ~/~/ Описание задания
1741 - "mileageCondition": "", ~/~/ Условие по пробегу
1742 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1743 - "motohoursCondition": "", ~/~/ Условие по моточасам
1744 - "lastMotohours": "", ~/~/ Моточасы
1745 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1746 - "kind": "", ~/~/ Вид периодичности по времени
1747 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1748 - }
1749 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1750 -
1751 -**Валидация:**
1752 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1753 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1754 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1755 -
1756 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1757 -
1758 -(% class="box errormessage" %)
1759 -(((
1760 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1761 -)))
1762 -
1763 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1764 -
1765 -(% style="color:#000000" %)Метод запроса: **DELETE**
1766 -
1767 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1768 -
1769 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1770 -
1771 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1772 -
1773 -(% style="text-align:left" %)
1774 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1775 -
1776 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1777 -
1778 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1779 -
1780 -(% class="box infomessage" %)
1781 -(((
1782 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1783 -)))
1784 -
1785 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1786 -
1787 -(% style="color:#000000" %)Метод запроса: **GET**
1788 -
1789 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1790 -
1791 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1792 -
1793 -(% style="color:#000000" %)Ответ:
1794 -
1795 -(% style="color:#000000" %){(%%)
1796 - "deviceTypeId" : "", ~/~/ ID типа устройства
1797 - "deviceTypeName" : "" ~/~/ Название типа устройства
1798 -(% style="color:#000000" %)}
1799 -
1800 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1801 -
1802 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1803 -
1804 -(% class="box infomessage" %)
1805 -(((
1806 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1807 -)))
1808 -
1809 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1810 -
1811 -(% style="color:#000000" %)Метод запроса: **GET**
1812 -
1813 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1814 -
1815 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1816 -
1817 -(% style="color:#000000" %)Ответ:
1818 -
1819 -(% style="color:#000000" %){(%%)
1820 - "id": "", ~/~/ ID типа датчика 
1821 - "name": "", ~/~/ Название
1822 - "description": "", ~/~/ Описание
1823 -(% style="color:#000000" %)}
1824 -
1825 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1826 -
1827 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1828 -
1829 -(% class="box infomessage" style="text-align: left;" %)
1830 -(((
1831 -**POST /api/v3/terminalMessages/count**
1832 -)))
1833 -
1834 -(% style="text-align: left;" %)
1835 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1836 -
1837 -(% style="text-align: left;" %)
1838 -Метод запроса **POST**
1839 -
1840 -(% style="text-align: left;" %)
1841 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1842 -
1843 -(% style="text-align: left;" %)
1844 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1845 -
1846 -(% style="text-align: left;" %)
1847 -{
1848 - "vehicleIds": [
1849 - id ~/~/ здесь передается список идентификаторов объектов
1850 - ],
1851 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1852 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1853 -}
1854 -
1855 -(% style="text-align: left;" %)
1856 1856  Ответ:
1857 1857  
1858 -(% style="text-align: left;" %)
1859 -[
1860 - {
1861 - "vehicleId": 0, ~/~/ идентификатор объекта
1862 - "count": 0 ~/~/ количество сообщений за период
1863 - }
1864 -]
1865 -
1866 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1867 -
1868 -(% class="box infomessage" style="text-align: left;" %)
1869 -(((
1870 -**POST /api/v3/terminalMessages/mapping**
1871 -)))
1872 -
1873 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1874 -
1875 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1876 -
1877 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1878 -
1879 1879  {
1880 - "protocolType": 0,
1881 - "params": ["string"]
1882 -}
1883 1883  
1884 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1885 -|protocolType|ID типа протокола
1886 -|params|(((
1887 -Массив наименований параметров в сообщении
1888 -)))
1889 -
1890 -Ответ:
1891 -
1892 -{
1893 - "protocolType": 0,
1894 - "mapping": {
1895 - "additionalProp1": {
1896 - "inputType": 0,
1897 - "inputNumber": 0
1898 - },
1899 - "additionalProp2": {
1900 - "inputType": 0,
1901 - "inputNumber": 0
1902 - }
1903 - }
1904 -}
1905 -
1906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 -|protocolType|Тип протокола
1908 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1909 -|inputNumber|(((
1910 -Номер входа
1911 -)))
1912 -
1913 -(% class="wikigeneratedid" %)
1914 -Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
1915 -
1916 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1917 -
1918 -(% class="box infomessage" %)
1919 -(((
1920 -**POST /api/v3/terminalMessages**
1921 -)))
1922 -
1923 -Метод возвращает список сообщений терминала объекта за выбранный период.
1924 -
1925 -(% style="text-align: left;" %)
1926 -Метод запроса **POST**
1927 -
1928 -(% style="text-align: left;" %)
1929 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1930 -
1931 -(% style="text-align: left;" %)
1932 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1933 -
1934 -{
1935 - "vehicleId": 0, ~/~/ id объекта
1936 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1937 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1938 -}
1939 -
1940 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1941 -|vehicleId|ID объекта
1942 -|from|Дата и время начала периода запроса
1943 -|to|Дата и время окончания периода запроса
1944 -
1945 -Ответ:
1946 -
1947 -[
1948 - {
1949 - "messages": [
329 +{{{ "vehicleId": "", //ID ТС
330 + "parentId": "", //Guid владельца ТС
331 + "name": "", //Имя объекта
332 + "imei": "", //IMEI
333 + "deviceTypeId": "", //ID типа устройства
334 + "modelId": "", //ID модели
335 + "unitId": "", //ID подразделения
336 + "sim1": "", //SIM1
337 + "sim2": "", //SIM2
338 + "consumptionPer100Km": "", //Расход топлива на 100 км
339 + "consumptionIdle": "", //Расход топлива на холостом ходу
340 + "counters": { //Счётчики
341 + "mileageEnabled": true,
342 + "motohoursEnabled": true,
343 + "mileage": "",
344 + "motohours": 345.0
345 + },
346 + "cmsv6Parameters": { //Параметры CmsV6
347 + "id": null,
348 + "enabled": true, //флаг включения
349 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
350 + "login": "", // имя учетной записи
351 + "password": "" // пароль учетной записи
352 + },
353 + "inspectionTasks": [ // задания на ТО
1950 1950   {
1951 - "deviceTime": "2023-11-29T07:40:44.052Z",
1952 - "serverTime": "2023-11-29T07:40:44.052Z",
1953 - "speed": 0,
1954 - "altitude": 0,
1955 - "latitude": 0,
1956 - "longitude": 0,
1957 - "satellites": 0,
1958 - "course": 0,
1959 - "voltage": 0,
1960 - "parameters": {
1961 - "additionalProp1": "string",
1962 - "additionalProp2": "string",
1963 - "additionalProp3": "string"
1964 - },
1965 - "photoCount": 0,
1966 - "lbsCorrectedCoords": true,
1967 - "protocolType": 0
1968 - }
1969 - ]
1970 - }
1971 -]
355 + "id": "", // ID задачи
356 + "enabled": false, // Признак включения
357 + "name": "", // Имя задания
358 + "description": "", // Описание задания
359 + "mileageCondition": "", // Условие по пробегу
360 + "lastMileage": "", // Пробег (в метрах)
361 + "motohoursCondition": "", // Условие по моточасам
362 + "lastMotohours": "", // Моточасы
363 + "periodicCondition": "", // Условие периодичности по времени}}}
1972 1972  
1973 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1974 -|deviceTime|Время сообщения терминала
1975 -|serverTime|Время когда сообщение поступило на сервер
1976 -|speed|Скорость
1977 -|altitude|Высота над уровнем моря
1978 -|latitude|Широта
1979 -|longitude|Долгота
1980 -|satellites|Кол-во спутников
1981 -|course|Курс
1982 -|voltage|Бортовое напряжение
1983 -|parameters|Список параметров и их значений
1984 -|photoCount|Количество фото
1985 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1986 -|protocolType|ID типа протокола
1987 -
1988 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1989 -
1990 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1991 -
1992 -(% class="box infomessage" %)
1993 -(((
1994 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1995 -)))
1996 -
1997 -(% style="color:#000000" %)Метод запроса: **POST**
1998 -
1999 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2000 -
2001 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2002 -
2003 -(% style="text-align:left" %)
2004 -Тело запроса:
2005 -
2006 -{
2007 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2008 - "vehicleIds": [0], ~/~/ Список ID объектов
2009 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2010 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2011 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2012 -}
2013 -
2014 -Ответ:
2015 -
2016 -[
2017 - {
2018 - "vehicleId": 0, ~/~/ ID объекта
2019 - "name": "string", ~/~/ Имя ТС
2020 - "periods": [ ~/~/ Периоды
2021 - {
2022 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2023 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2024 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2025 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2026 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2027 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
365 +{{{ "kind": "", // Вид периодичности по времени
366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
2028 2028   }
2029 - ]
2030 - }
2031 -]
368 + ]}}}
2032 2032  
2033 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2034 -
2035 -(% class="box infomessage" %)
2036 -(((
2037 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2038 -)))
2039 -
2040 -(% style="color:#000000" %)Метод запроса: **POST**
2041 -
2042 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2043 -
2044 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2045 -
2046 -(% style="text-align:left" %)
2047 -Тело запроса:
2048 -
2049 -{
2050 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2051 - "vehicleIds": [0], ~/~/ Список ID объектов
2052 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2053 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2054 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2055 2055  }
371 +
2056 2056  
2057 -Ответ:
373 + **Удаление объекта**
2058 2058  
2059 -[
2060 - {
2061 - "vehicleId": 0, ~/~/ ID объекта
2062 - "name": "string", ~/~/ Имя ТС
2063 - "periods": [ ~/~/ Периоды
2064 - {
2065 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2066 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2067 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2068 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2069 - "fuelConsumption": 0, ~/~/ Расход топлива
2070 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2071 - }
2072 - ]
2073 - }
2074 -]
375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2075 2075  
2076 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
377 +Метод запроса: DELETE
2077 2077  
2078 -(% class="box infomessage" %)
2079 -(((
2080 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2081 -)))
379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
2082 2082  
2083 -(% style="color:#000000" %)Метод запроса: **POST**
381 +Параметр запроса: {id} - Guid объекта
2084 2084  
2085 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2086 -
2087 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2088 -
2089 -(% style="text-align:left" %)
2090 -Тело запроса:
2091 -
2092 -{
2093 - "vehicleIds": [0], ~/~/ Список ID объектов
2094 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2095 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2096 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2097 -}
2098 -
2099 -Ответ:
2100 -
2101 -[
2102 - {
2103 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2104 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2105 - "vehicleId": 0, ~/~/ ID объекта
2106 - "name": "string", ~/~/ Имя объекта
2107 - "model": "string", ~/~/ Модель объекта
2108 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2109 - {
2110 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2111 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2112 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2113 - "valueFuel": 0, ~/~/ Количество
2114 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2115 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2116 - }
2117 - ]
2118 - }
2119 -]
2120 -
2121 -
2122 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2123 -
2124 -(% class="box infomessage" %)
2125 -(((
2126 -**POST /api/v3/vehicles/moveStop**
2127 -)))
2128 -
2129 -Метод запроса: **POST**
2130 -
2131 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2132 -
2133 2133  В заголовках запроса: X-Auth: Токен авторизации
2134 2134  
385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
2135 2135  
2136 -Тело запроса:
388 + **Редактирование объекта**
2137 2137  
2138 -{
2139 - "vehicleIds": [ ], ~/~/ Список ID объектов
2140 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2141 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2142 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2143 -}
390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2144 2144  
2145 -Ответ:
392 +Метод запроса: PUT
2146 2146  
2147 -[ 
2148 - {
2149 - "vehicleId": 0, ~/~/ ID объекта
2150 - "vehicleName": "string", ~/~/ Имя объекта
2151 - "moves": [ ~/~/ Событие движения
2152 - {
2153 - "mileage": 0, ~/~/ Пробег, км
2154 - "eventId": 0, ~/~/ Идентификатор события
2155 - "eventName": "string", ~/~/ Название события
2156 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2157 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2158 - "duration": 0 ~/~/ Продолжительность события, секунд
2159 - }
2160 - ],
2161 - "stops": [ ~/~/ События стоянок
2162 - {
2163 - "address": "string", ~/~/ Адрес события
2164 - "eventId": 0, ~/~/ Идентификатор события
2165 - "eventName": "string", ~/~/ Название события
2166 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2167 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2168 - "duration": 0 ~/~/ Продолжительность события, секунд
2169 - }
2170 - ]
2171 - }
2172 -]
394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
2173 2173  
2174 -
2175 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2176 -
2177 -(% class="box infomessage" %)
2178 -(((
2179 -**POST /api/v3/vehicles/getlastdata**
2180 -)))
2181 -
2182 -Метод запроса: **POST**
2183 -
2184 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2185 -
2186 2186  В заголовках запроса: X-Auth: Токен авторизации
2187 2187  
398 +Параметры в теле запроса (JSON):
2188 2188  
2189 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
400 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
2190 2190  
2191 2191  Ответ:
2192 - {
2193 - "vehicleId": 0, ~/~/Идентификатор объекта.
2194 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2195 - "vehicleNumber": "string",~/~/Номер объекта.
2196 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2197 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2198 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2199 - "speed": 0,~/~/Скорость объекта.
2200 - "course": 0,~/~/Курс движения [0;360]
2201 - "latitude": 0,~/~/Широта [-90°;90°].
2202 - "longitude": 0,~/~/Долгота [-180°;180°].
2203 - "address": "string",~/~/Адрес.
2204 - "geozones": [ ~/~/Сведения по геозонам.
2205 - {
2206 - "id": 0,
2207 - "name": "string"
2208 - }
2209 -
2210 2210  
2211 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
404 +{ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
405 +
2212 2212  
2213 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
407 + **Изменение статуса объекта**
2214 2214  
2215 -(% class="box infomessage" %)
2216 -(((
2217 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2218 -)))
409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2219 2219  
2220 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
411 +Метод запроса: POST
2221 2221  
2222 -(% style="color:#000000" %)Метод запроса: **POST**
413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
2223 2223  
2224 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
415 +Параметр запроса: {vehicleId} - ID ТС
2225 2225  
2226 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2227 -
2228 -(% style="text-align:left" %)
2229 -Тело запроса:
2230 -
2231 -(% style="text-align:left" %)
2232 -{
2233 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2234 -}
2235 -
2236 -(% style="text-align:left" %)
2237 -Ответ:
2238 -
2239 -[
2240 - {
2241 - "id": 0, ~/~/ Идентификатор объекта геозоны
2242 - "name": "string", ~/~/ Название объекта геозоны
2243 - "type": 0, ~/~/ Тип объекта геозоны
2244 - "fname": "string", ~/~/ Имя файла
2245 - "parentId": "string", ~/~/ Идентификатор клиента
2246 - "radius": 0, ~/~/ Радиус геообъекта
2247 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2248 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2249 - "description": "string", ~/~/ Описание
2250 - "area": 0, ~/~/ Площадь, м^^2^^
2251 - "perimetr": 0, ~/~/ Периметр, м
2252 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2253 - }
2254 -]
2255 -
2256 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2257 -
2258 -(% class="box infomessage" %)
2259 -(((
2260 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2261 -)))
2262 -
2263 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2264 -
2265 -(% style="color:#000000" %)Метод запроса: **POST**
2266 -
2267 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2268 -
2269 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2270 -
2271 -(% style="text-align:left" %)
2272 -Тело запроса:
2273 -
2274 -{
2275 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2276 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2277 - "ids": [ ], ~/~/ Массив id объектов
2278 - "byTime": 0, ~/~/ Объединение событий по времени 
2279 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2280 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2281 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2282 -}
2283 -
2284 -Ответ:
2285 -[
2286 - {
2287 - "geozoneId": 0, ~/~/ ID геообъекта
2288 - "geozoneName": "string", ~/~/ Название геообъекта
2289 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2290 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2291 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2292 - "vehicleId": 0, ~/~/ ID объекта
2293 - "vehicleName": "string" ~/~/ Имя объекта
2294 - }
2295 -]
2296 -
2297 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2298 -
2299 -(% class="box infomessage" %)
2300 -(((
2301 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2302 -)))
2303 -
2304 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2305 -
2306 -(% style="color:#000000" %)Метод запроса: **POST**
2307 -
2308 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2309 -
2310 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2311 -
2312 -(% style="text-align:left" %)
2313 -Тело запроса:
2314 -
2315 -{
2316 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2317 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2318 - "ids": [ ], ~/~/ Массив id геообъектов
2319 - "byTime": 0, ~/~/ Объединение событий по времени 
2320 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2321 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2322 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2323 -}
2324 -
2325 -Ответ:
2326 -
2327 -[
2328 - {
2329 - "geozoneId": 0, ~/~/ ID геообъекта
2330 - "geozoneName": "string", ~/~/ Название геообъекта
2331 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2332 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2333 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2334 - "vehicleId": 0, ~/~/ ID объекта
2335 - "vehicleName": "string" ~/~/ Имя объекта
2336 - }
2337 -]
2338 -
2339 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2340 -
2341 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2342 -
2343 -(% class="box infomessage" %)
2344 -(((
2345 -**POST /api/v3/notifications/find**
2346 -)))
2347 -
2348 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2349 -
2350 -(% style="text-align: left;" %)
2351 -Метод запроса **POST**
2352 -
2353 -(% style="text-align: left;" %)
2354 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2355 -
2356 -(% style="text-align: left;" %)
2357 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2358 -
2359 -{
2360 - "parentId": "" ~/~/ id клиента
2361 -}
2362 -
2363 -Ответ:
2364 -
2365 -[
2366 - {
2367 - "id": 0, ~/~/ ID уведомления
2368 - "name": "string", ~/~/ Название уведомления
2369 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2370 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2371 - "userId": "", ~/~/ Пользователь, создавший уведомление
2372 - "parentId": "", ~/~/ Идентификатор клиента
2373 - "parentName": "string" ~/~/ Имя клиента
2374 - }
2375 -]
2376 -
2377 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2378 -
2379 -(% class="box infomessage" %)
2380 -(((
2381 -**GET /api/v3/notifications/{id}**
2382 -)))
2383 -
2384 -Метод возвращает данные правил формирования выбранного уведомления.
2385 -
2386 -(% style="text-align: left;" %)
2387 -Метод запроса **GET**
2388 -
2389 -(% style="text-align: left;" %)
2390 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2391 -
2392 -(% style="text-align: left;" %)
2393 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2394 -
2395 -(% style="text-align: left;" %)
2396 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2397 -
2398 -(% style="text-align: left;" %)
2399 -(% style="color:#000000" %)Ответ:
2400 -
2401 -(% style="text-align: left;" %)
2402 -(% style="color:#000000" %){
2403 - "id": 0, ~/~/ (%%)id уведомления
2404 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2405 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2406 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2407 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2408 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2409 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2410 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2411 -(% style="color:#000000" %) 0
2412 - ],
2413 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2414 -(% style="color:#000000" %) 0
2415 - ],
2416 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2417 -(% style="color:#000000" %) 0
2418 - ],
2419 - "settings": { ~/~/ Список параметров уведомления
2420 - "additionalProp1": "string",
2421 - "additionalProp2": "string",
2422 - "additionalProp3": "string"
2423 - },
2424 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2425 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2426 -(% style="color:#000000" %) ""
2427 - ],
2428 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2429 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2430 -(% style="color:#000000" %) "string"
2431 - ],
2432 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2433 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2434 -(% style="color:#000000" %) {
2435 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2436 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2437 -(% style="color:#000000" %) }
2438 - ],
2439 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2440 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2441 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2442 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2443 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2444 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2445 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2446 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2447 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2448 -(% style="color:#000000" %)}
2449 -
2450 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2451 -
2452 -(% class="box warningmessage" %)
2453 -(((
2454 -**PUT /api/v3/notifications/**
2455 -)))
2456 -
2457 -Метод позволяет отредактировать уведомление.
2458 -
2459 -Метод запроса **PUT**
2460 -
2461 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2462 -
2463 2463  В заголовках запроса: X-Auth: Токен авторизации
2464 2464  
2465 -Тело запроса:
2466 -{
2467 - "id": 0, ~/~/ id уведомления
2468 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2469 - "userId": "", ~/~/ Пользователь, создавший уведомление
2470 - "parentId": "", ~/~/ Идентификатор клиента
2471 - "parentName": "string", ~/~/ Имя клиента
2472 - "name": "string", ~/~/ Название уведомления
2473 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2474 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2475 - 0
2476 - ],
2477 - "geoids": [ ~/~/ Список id геообъектов для анализа
2478 - 0
2479 - ],
2480 - "fieldids": [ ~/~/ Список id полей для анализа
2481 - 0
2482 - ],
2483 - "settings": { ~/~/ Список параметров уведомления
2484 - "additionalProp1": "string",
2485 - "additionalProp2": "string",
2486 - "additionalProp3": "string"
2487 - },
2488 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2489 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2490 - ""
2491 - ],
2492 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2493 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2494 - "string"
2495 - ],
2496 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2497 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2498 - {
2499 - "id": 0, ~/~/ Идентификатор участника чата
2500 - "info": "string" ~/~/ Дополнительные сведения
2501 - }
2502 - ],
2503 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2504 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2505 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2506 - "kind": 0, ~/~/ Определяет вид уведомления
2507 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2508 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2509 - "timezone": 0, ~/~/ Сдвиг часового пояса
2510 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2511 - "autoProlongation": true ~/~/ Автопродление срока действия
2512 -}
419 +Параметры в теле запроса (JSON): {
2513 2513  
2514 -Ответ:
421 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
422 + "date": "", // Дата смены статуса (null если сменить немедленно)
423 + "description": "", // Описание
424 + "data": "", // Данные
425 + "overwrite": false, // Флаг перезаписи
426 + "stage": "", // Состояние, может быть null}}}
2515 2515  
2516 -Success
2517 -
2518 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2519 -
2520 -(% class="box errormessage" %)
2521 -(((
2522 -**DELETE /api/v3/notifications/{id}**
2523 -)))
2524 -
2525 -Метод позволяет удалить выбранное уведомление.
2526 -
2527 -Метод запроса **DELETE**
2528 -
2529 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2530 -
2531 -Передаваемый параметр: {id} - id уведомления
2532 -
2533 -В заголовках запроса: X-Auth: Токен авторизации
2534 -
2535 -Ответ:
2536 -
2537 -Success
2538 -
2539 -
2540 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2541 -
2542 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2543 -
2544 -(% class="box infomessage" %)
2545 -(((
2546 -**POST /api/v3/Drivers/find**
2547 -)))
2548 -
2549 -Передается параметр: parentId - ID клиента-родителя
2550 -
2551 -Ответ:
2552 -
2553 -[
2554 - {
2555 - "name": "string", ~/~/ Определяет наименование
2556 - "description": "string", ~/~/ Определяет описание
2557 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2558 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2559 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2560 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2561 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2562 - "deleted": true ~/~/ Признак удаления
2563 - }
2564 -]
2565 -
2566 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2567 -
2568 -(% class="box infomessage" %)
2569 -(((
2570 -**GET /api/v3/Drivers/{driverGuid}**
2571 -)))
2572 -
2573 -Передается параметр: ID водителя
2574 -
2575 -Ответ:
2576 -
2577 -{
2578 - "name": "string", ~/~/ Определяет наименование
2579 - "description": "string", ~/~/ Определяет описание
2580 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2581 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2582 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2583 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2584 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2585 - "deleted": true ~/~/ Признак удаления
2586 2586  }
2587 2587  
2588 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
430 +Ответ: {
2589 2589  
2590 -(% class="box successmessage" %)
2591 -(((
2592 -**POST /api/v3/Drivers**
2593 -)))
432 +{{{ "status": "", // значение статуса
433 + "date": "", // Дата смены статуса
434 + "description": "", // Описание
435 + "data": "", // Данные
436 + "overwrite": false, // Флаг перезаписи
437 + "stage": "", // Состояние}}}
2594 2594  
2595 -Запрос:
2596 -
2597 -{
2598 - "name": "string",
2599 - "description": "string",
2600 - "hiredate": "2023-06-30T12:50:54.020Z",
2601 - "chopdate": "2023-06-30T12:50:54.020Z",
2602 - "exclusive": true,
2603 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2604 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2605 - "deleted": true
2606 2606  }
2607 -
2608 -Ответ:
2609 -
2610 -{
2611 - "name": "string",
2612 - "description": "string",
2613 - "hiredate": "2023-06-30T12:50:54.051Z",
2614 - "chopdate": "2023-06-30T12:50:54.051Z",
2615 - "exclusive": true,
2616 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2617 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2618 - "deleted": true
2619 -}
2620 -
2621 -
2622 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2623 -
2624 -(% class="box warningmessage" %)
2625 -(((
2626 -**PUT /api/v3/Drivers**
2627 -)))
2628 -
2629 -Запрос:
2630 -
2631 -{
2632 - "name": "string",
2633 - "description": "string",
2634 - "hiredate": "2023-06-30T12:50:27.910Z",
2635 - "chopdate": "2023-06-30T12:50:27.910Z",
2636 - "exclusive": true,
2637 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2638 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2639 - "deleted": true
2640 -}
2641 -
2642 -Ответ:
2643 -
2644 -{
2645 - "name": "string",
2646 - "description": "string",
2647 - "hiredate": "2023-06-30T12:50:27.929Z",
2648 - "chopdate": "2023-06-30T12:50:27.929Z",
2649 - "exclusive": true,
2650 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2651 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2652 - "deleted": true
2653 -}
2654 -
2655 -
2656 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2657 -
2658 -(% class="box errormessage" %)
2659 -(((
2660 -**DELETE /api/v3/Drivers/{driverGuid}**
2661 -)))
2662 -
2663 -Передается параметр: ID водителя
2664 -
2665 -Ответ:
2666 -
2667 -Success
2668 -
2669 -
2670 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2671 -
2672 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2673 -
2674 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2675 -
2676 -(% class="box infomessage" %)
2677 -(((
2678 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2679 -)))
2680 -
2681 -Запрос:
2682 -
2683 -{
2684 - "Ids": [
2685 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2686 - ],
2687 - "BeginTime": "2023-06-30T12:49:04.365Z",
2688 - "EndTime": "2023-06-30T12:49:04.365Z"
2689 -}
2690 -
2691 -Ответ:
2692 -
2693 -[
2694 - {
2695 - "VehicleId": 0,
2696 - "CreateTime": "2023-06-30T09:52:31.240Z",
2697 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2698 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2699 - "BeginTime": "2023-06-30T09:52:31.240Z",
2700 - "EndTime": "2023-06-30T09:52:31.240Z"
2701 - }
2702 -]
2703 -
2704 -
2705 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2706 -
2707 -(% class="box infomessage" %)
2708 -(((
2709 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2710 -)))
2711 -
2712 -Запрос:
2713 -
2714 -{
2715 - "Ids": [
2716 - 0
2717 - ],
2718 - "BeginTime": "2023-06-30T12:48:39.419Z",
2719 - "EndTime": "2023-06-30T12:48:39.419Z"
2720 -}
2721 -
2722 -Ответ:
2723 -
2724 -[
2725 - {
2726 - "VehicleId": 0,
2727 - "CreateTime": "2023-06-30T09:54:01.631Z",
2728 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2729 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2730 - "BeginTime": "2023-06-30T09:54:01.631Z",
2731 - "EndTime": "2023-06-30T09:54:01.631Z"
2732 - }
2733 -]
2734 -
2735 -
2736 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2737 -
2738 -(% class="box successmessage" %)
2739 -(((
2740 -**POST /api/v3/DriversVehiclesAssignments**
2741 -)))
2742 -
2743 -Передается массив назначений
2744 -
2745 -Запрос:
2746 -
2747 -[
2748 - {
2749 - "VehicleId": 0, ~/~/ Идентификатор объекта
2750 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2751 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2752 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2753 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2754 - }
2755 -]
2756 -
2757 -Ответ:
2758 -
2759 -[
2760 - {
2761 - "VehicleId": 0,
2762 - "CreateTime": "2023-06-30T11:04:46.903Z",
2763 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2764 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2765 - "BeginTime": "2023-06-30T11:04:46.903Z",
2766 - "EndTime": "2023-06-30T11:04:46.903Z"
2767 - }
2768 -]
2769 -
2770 -
2771 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2772 -
2773 -(% class="box warningmessage" %)
2774 -(((
2775 -**PUT /api/v3/DriversVehiclesAssignments**
2776 -)))
2777 -
2778 -Запрос:
2779 -
2780 -[
2781 - {
2782 - "VehicleId": 0,
2783 - "CreateTime": "2023-06-30T11:14:08.117Z",
2784 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2785 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2786 - "BeginTime": "2023-06-30T11:14:08.117Z",
2787 - "EndTime": "2023-06-30T11:14:08.117Z"
2788 - }
2789 -]
2790 -
2791 -Ответ:
2792 -
2793 -[
2794 - {
2795 - "VehicleId": 0,
2796 - "CreateTime": "2023-06-30T11:14:53.349Z",
2797 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2798 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2799 - "BeginTime": "2023-06-30T11:14:53.349Z",
2800 - "EndTime": "2023-06-30T11:14:53.349Z"
2801 - }
2802 -]
2803 -
2804 -
2805 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2806 -
2807 -(% class="box errormessage" %)
2808 -(((
2809 -**DELETE /api/v3/DriversVehiclesAssignments**
2810 -)))
2811 -
2812 -Запрос:
2813 -
2814 -[
2815 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2816 -]
2817 -
2818 -Ответ:
2819 -
2820 -Success
2821 -
2822 -
2823 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2824 -
2825 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2826 -
2827 -(% class="box infomessage" %)
2828 -(((
2829 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2830 -)))
2831 -
2832 -Запрос:
2833 -
2834 -{
2835 - "Ids": [
2836 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2837 - ],
2838 - "BeginTime": "2023-06-30T12:47:12.162Z",
2839 - "EndTime": "2023-06-30T12:47:12.162Z"
2840 -}
2841 -
2842 -Ответ:
2843 -
2844 -[
2845 - {
2846 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2847 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2848 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2849 - "BeginTime": "2023-06-30T11:19:40.703Z",
2850 - "EndTime": "2023-06-30T11:19:40.703Z"
2851 - }
2852 -]
2853 -
2854 -
2855 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2856 -
2857 -(% class="box infomessage" %)
2858 -(((
2859 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2860 -)))
2861 -
2862 -Запрос:
2863 -
2864 -{
2865 - "Ids": [
2866 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2867 - ],
2868 - "BeginTime": "2023-06-30T12:47:12.162Z",
2869 - "EndTime": "2023-06-30T12:47:12.162Z"
2870 -}
2871 -
2872 -Ответ:
2873 -
2874 -[
2875 - {
2876 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2877 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2878 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2879 - "BeginTime": "2023-06-30T11:19:40.703Z",
2880 - "EndTime": "2023-06-30T11:19:40.703Z"
2881 - }
2882 -]
2883 -
2884 -
2885 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2886 -
2887 -(% class="box successmessage" %)
2888 -(((
2889 -**POST /api/v3/DriversRfidsAssignments**
2890 -)))
2891 -
2892 -Запрос:
2893 -
2894 -[
2895 - {
2896 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2897 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2898 - "BeginTime": "2023-06-30T11:27:08.635Z",
2899 - "EndTime": "2023-06-30T11:27:08.635Z"
2900 - }
2901 -]
2902 -
2903 -Ответ:
2904 -
2905 -[
2906 - {
2907 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2908 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2909 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2910 - "BeginTime": "2023-06-30T11:27:08.677Z",
2911 - "EndTime": "2023-06-30T11:27:08.677Z"
2912 - }
2913 -]
2914 -
2915 -
2916 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2917 -
2918 -(% class="box warningmessage" %)
2919 -(((
2920 -**PUT /api/v3/DriversRfidsAssignments**
2921 -)))
2922 -
2923 -Запрос:
2924 -
2925 -[
2926 - {
2927 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2928 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2929 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2930 - "BeginTime": "2023-06-30T11:28:43.330Z",
2931 - "EndTime": "2023-06-30T11:28:43.330Z"
2932 - }
2933 -]
2934 -
2935 -Ответ:
2936 -
2937 -[
2938 - {
2939 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2940 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2941 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2942 - "BeginTime": "2023-06-30T11:28:43.331Z",
2943 - "EndTime": "2023-06-30T11:28:43.331Z"
2944 - }
2945 -]
2946 -
2947 -
2948 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2949 -
2950 -(% class="box errormessage" %)
2951 -(((
2952 -**DELETE /api/v3/DriversRfidsAssignments**
2953 -)))
2954 -
2955 -Запрос:
2956 -
2957 -[
2958 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2959 -]
2960 -
2961 -Ответ:
2962 -
2963 -Success
2964 -
2965 -
2966 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2967 -
2968 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2969 -
2970 -(% class="box infomessage" %)
2971 -(((
2972 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2973 -)))
2974 -
2975 -Запрос:
2976 -
2977 -{
2978 - "Ids": [
2979 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2980 - ],
2981 - "BeginTime": "2023-06-30T12:45:10.852Z",
2982 - "EndTime": "2023-06-30T12:45:10.852Z"
2983 -}
2984 -
2985 -Ответ:
2986 -
2987 -[
2988 - {
2989 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2990 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2991 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2992 - "BeginTime": "2023-06-30T11:58:04.695Z",
2993 - "EndTime": "2023-06-30T11:58:04.695Z"
2994 - }
2995 -]
2996 -
2997 -
2998 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2999 -
3000 -(% class="box infomessage" %)
3001 -(((
3002 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3003 -)))
3004 -
3005 -Запрос:
3006 -
3007 -{
3008 - "Ids": [
3009 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3010 - ],
3011 - "BeginTime": "2023-06-30T12:45:10.852Z",
3012 - "EndTime": "2023-06-30T12:45:10.852Z"
3013 -}
3014 -
3015 -Ответ:
3016 -
3017 -[
3018 - {
3019 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3020 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3021 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3022 - "BeginTime": "2023-06-30T11:58:04.695Z",
3023 - "EndTime": "2023-06-30T11:58:04.695Z"
3024 - }
3025 -]
3026 -
3027 -
3028 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3029 -
3030 -(% class="box successmessage" %)
3031 -(((
3032 -**POST /api/v3/DriversFuelCardsAssignments**
3033 -)))
3034 -
3035 -Запрос:
3036 -
3037 -[
3038 - {
3039 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3040 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3041 - "BeginTime": "2023-06-30T12:09:53.175Z",
3042 - "EndTime": "2023-06-30T12:09:53.175Z"
3043 - }
3044 -]
3045 -
3046 -Ответ:
3047 -
3048 -[
3049 - {
3050 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3051 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3052 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3053 - "BeginTime": "2023-06-30T12:09:53.201Z",
3054 - "EndTime": "2023-06-30T12:09:53.201Z"
3055 - }
3056 -]
3057 -
3058 -
3059 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3060 -
3061 -(% class="box warningmessage" %)
3062 -(((
3063 -**PUT /api/v3/DriversFuelCardsAssignments**
3064 -)))
3065 -
3066 -Запрос:
3067 -
3068 -[
3069 - {
3070 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3071 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3072 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3073 - "BeginTime": "2023-06-30T12:09:53.201Z",
3074 - "EndTime": "2023-06-30T12:09:53.201Z"
3075 - }
3076 -]
3077 -
3078 -Ответ:
3079 -
3080 -[
3081 - {
3082 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 - "BeginTime": "2023-06-30T12:09:53.201Z",
3086 - "EndTime": "2023-06-30T12:09:53.201Z"
3087 - }
3088 -]
3089 -
3090 -
3091 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3092 -
3093 -(% class="box errormessage" %)
3094 -(((
3095 -**DELETE /api/v3/DriversFuelCardsAssignments**
3096 -)))
3097 -
3098 -Запрос:
3099 -
3100 -[
3101 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3102 -]
3103 -
3104 -Ответ:
3105 -
3106 -Success
3107 -
3108 -
3109 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3110 -
3111 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3112 -
3113 -(% class="box infomessage" %)
3114 -(((
3115 -**POST /api/v3/Trailers**
3116 -)))
3117 -
3118 -Пример запроса:
3119 -
3120 -{
3121 - "startDate": "2023-11-14T10:48:03.671Z",
3122 - "endDate": "2023-11-14T10:48:03.671Z",
3123 - "ids": [ 0 ],
3124 - "timezone": 0
3125 -}
3126 -
3127 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3128 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3129 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3130 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3131 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3132 -
3133 -Пример ответа:
3134 -
3135 -[
3136 - {
3137 - "SD": "2023-11-14T10:48:03.717Z",
3138 - "ED": "2023-11-14T10:48:03.717Z", 
3139 - "id": 0,
3140 - "SLat": 0,
3141 - "SLon": 0,
3142 - "ELat": 0,
3143 - "ELon": 0,
3144 - "mileage": 0
3145 - "Duration": 0
3146 - "Address": "string",
3147 - "Address2": "string",
3148 - "name": "string",
3149 - "rid": "string",
3150 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 - "trailer": {
3152 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3153 - "Number": "string",
3154 - "Description": "string",
3155 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 - "ExternalID": "string",
3157 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3158 - "CreateTime": "2023-11-14T10:48:03.717Z",
3159 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3160 - "IsDeleted": true
3161 - },
3162 - "filesCount": 0,
3163 - }
3164 -]
3165 -
3166 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3167 -|SD|Дата и время начала события
3168 -|ED|Дата и время окончания события
3169 -|id|ID объекта
3170 -|SLat|Широта начальной координаты
3171 -|SLon|Долгота начальной координаты
3172 -|ELat|Широта конечной координаты
3173 -|ELon|Долгота конечной координаты
3174 -|mileage|Пробег
3175 -|Duration|Продолжительность
3176 -|Address|Адрес начального местоположения
3177 -|Address2|Адрес конечного местоположения
3178 -|name|Имя радиометки
3179 -|rid|Номер радиометки
3180 -|rguid|ID радиометки
3181 -|trailer|Информация об агрегате
3182 -|ModelGuid|ID агрегата
3183 -|Number|Название/номер агрегата
3184 -|Description|Текст примечания агрегата
3185 -
3186 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3187 -
3188 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3189 -
3190 -(% class="box infomessage" %)
3191 -(((
3192 -**POST /api/v3/Rfids/find**
3193 -)))
3194 -
3195 -Запрос:
3196 -
3197 -{
3198 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3199 -}
3200 -
3201 -Ответ:
3202 -
3203 -[
3204 - {
3205 - "name": "string",
3206 - "number": 0,
3207 - "period": 0,
3208 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 - }
3211 -]
3212 -
3213 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3214 -|parentId|ID клиента
3215 -|name|Название карты-метки
3216 -|number|Номер
3217 -|period|Период запросов в секундах (работает только для агрегатов)
3218 -|id|ID карты-метки
3219 -
3220 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3221 -
3222 -(% class="box infomessage" %)
3223 -(((
3224 -**GET /api/v3/Rfids/{rfidGuid}**
3225 -)))
3226 -
3227 -Передаем параметр rfidGuid - идентификатор карты-метки
3228 -
3229 -Ответ:
3230 -
3231 -[
3232 - {
3233 - "name": "string",
3234 - "number": 0,
3235 - "period": 0,
3236 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3237 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3238 - }
3239 -]
3240 -
3241 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3242 -|name|Название карты-метки
3243 -|number|Номер
3244 -|period|Период запросов в секундах (работает только для агрегатов)
3245 -|id|ID карты-метки
3246 -|parentId|ID клиента
3247 -
3248 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3249 -
3250 -(% class="box successmessage" %)
3251 -(((
3252 -**POST /api/v3/Rfids**
3253 -)))
3254 -
3255 -Запрос:
3256 -
3257 -{
3258 - "name": "string",
3259 - "number": 0,
3260 - "period": 0,
3261 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3262 -}
3263 -
3264 -Ответ:
3265 -
3266 -{
3267 - "name": "string",
3268 - "number": 0,
3269 - "period": 0,
3270 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3271 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3272 -}
3273 -
3274 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3275 -|name|Название карты-метки
3276 -|number|Номер
3277 -|period|Период запросов в секундах (работает только для агрегатов)
3278 -|id|ID карты-метки
3279 -|parentId|ID клиента
3280 -
3281 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3282 -
3283 -(% class="box warningmessage" %)
3284 -(((
3285 -**PUT /api/v3/Rfids**
3286 -)))
3287 -
3288 -Запрос:
3289 -
3290 -{
3291 - "name": "string",
3292 - "number": 0,
3293 - "period": 0,
3294 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3295 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3296 -}
3297 -
3298 -Ответ:
3299 -
3300 -{
3301 - "name": "string",
3302 - "number": 0,
3303 - "period": 0,
3304 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3306 -}
3307 -
3308 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3309 -|name|Название карты-метки
3310 -|number|Номер
3311 -|period|Период запросов в секундах (работает только для агрегатов)
3312 -|id|ID карты-метки
3313 -|parentId|ID клиента
3314 -
3315 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3316 -
3317 -(% class="box errormessage" %)
3318 -(((
3319 -**DELETE /api/v3/Rfids/{rfidGuid}**
3320 -)))
3321 -
3322 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3323 -
3324 -Ответ:
3325 -
3326 -Success
3327 -
3328 -
3329 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3330 -
3331 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3332 -
3333 -(% class="box infomessage" %)
3334 -(((
3335 -**GET /api/v3/Billing/client/balance/{clientId}**
3336 -)))
3337 -
3338 -Параметр запроса: **clientId **- идентификатор клиента.
3339 -
3340 -Ответ:
3341 -
3342 -{
3343 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3344 - "Balance": 0
3345 -}
3346 -
3347 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3348 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3349 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3350 -
3351 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3352 -
3353 -(% class="box infomessage" %)
3354 -(((
3355 -**GET /api/v3/Billing/client/constraint/{clientId}**
3356 -)))
3357 -
3358 -Параметр запроса: **clientId **- идентификатор клиента.
3359 -
3360 -Ответ:
3361 -
3362 -{
3363 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3364 - "CalculationType": 0,
3365 - "PermissibleBalance": 0,
3366 - "DefermentDays": 0,
3367 - "SendUiNotifications": true,
3368 - "SendEmailNotifications": true,
3369 - "IsPrivate": true,
3370 -}
3371 -
3372 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3373 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3374 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3375 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3376 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3377 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3378 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3379 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3380 -
3381 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3382 -
3383 -(% class="box infomessage" %)
3384 -(((
3385 -**GET /api/v3/Billing/client/plan/{clientId}**
3386 -)))
3387 -
3388 -Параметры запроса:
3389 -
3390 -**clientId **- идентификатор клиента.
3391 -
3392 -**planId **- идентификатор тарифного плана.
3393 -
3394 -Ответ:
3395 -
3396 -{
3397 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3398 - "Plan": { **~/~/ Описание тарифного плана**
3399 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3401 - "Name": "string",
3402 - "IsArchived": true,
3403 - "Constraint": {
3404 - "CalculationType": 0,
3405 - "PermissibleBalance": 0,
3406 - "DefermentDays": 0
3407 - },
3408 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3409 - {
3410 - "Feature": "string",
3411 - "IsFactual": true,
3412 - "Limit": 0,
3413 - "Price": 0,
3414 - "PeriodValue": 0,
3415 - "PeriodType": 0
3416 - }
3417 - ]
3418 - },
3419 - "DebitDate": "2023-10-18T12:46:24.213Z",
3420 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3421 - {
3422 - "Feature": "string",
3423 - "IsEnabled": true,
3424 - "IsPrivate": true,
3425 - "IsFactual": true,
3426 - "Limit": 0,
3427 - "Price": 0,
3428 - "DebitDate": "2023-10-18T12:46:24.213Z",
3429 - "PeriodValue": 0,
3430 - "PeriodType": 0
3431 - }
3432 - ]
3433 -}
3434 -
3435 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3436 -|ClientId|Идентификатор клиента
3437 -|Id|Идентификатор тарифного плана
3438 -|OwnerId|Идентификатор клиента-владельца
3439 -|Name|Наименование тарифного плана
3440 -|IsArchived|Признак, определяющий архивный тарифный план
3441 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3442 -|PermissibleBalance|Допустимый баланс
3443 -|DefermentDays|Отсрочка, количество дней
3444 -|Feature|Код услуги
3445 -|IsEnabled|Признак, определяющий активирована ли услуга
3446 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3447 -|IsFactual|Признак, определяющий расчёт по факту
3448 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3449 -|Price|Цена за единицу.
3450 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3451 -|PeriodValue|Значение периода.
3452 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3453 -
3454 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3455 -
3456 -(% class="box infomessage" %)
3457 -(((
3458 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3459 -)))
3460 -
3461 -Параметр запроса: **clientId **- идентификатор клиента.
3462 -
3463 -Ответ:
3464 -
3465 -[
3466 - {
3467 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3469 - "Name": "string",
3470 - "IsArchived": true,
3471 - "Constraint": {
3472 - "CalculationType": 0,
3473 - "PermissibleBalance": 0,
3474 - "DefermentDays": 0
3475 - },
3476 - "Features": [
3477 - {
3478 - "Feature": "string",
3479 - "IsFactual": true,
3480 - "Limit": 0,
3481 - "Price": 0,
3482 - "PeriodValue": 0,
3483 - "PeriodType": 0
3484 - }
3485 - ]
3486 - }
3487 -]
3488 -
3489 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3490 -|ClientId|Идентификатор клиента
3491 -|Id|Идентификатор тарифного плана
3492 -|OwnerId|Идентификатор клиента-владельца
3493 -|Name|Наименование тарифного плана
3494 -|IsArchived|Признак, определяющий архивный тарифный план
3495 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3496 -|PermissibleBalance|Допустимый баланс
3497 -|DefermentDays|Отсрочка, количество дней
3498 -|Feature|Код услуги
3499 -|IsFactual|Признак, определяющий расчёт по факту
3500 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3501 -|Price|Цена за единицу.
3502 -|PeriodValue|Значение периода.
3503 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3504 -
3505 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3506 -
3507 -(% class="box infomessage" %)
3508 -(((
3509 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3510 -)))
3511 -
3512 -Параметр запроса: **clientId **- идентификатор клиента.
3513 -
3514 -Ответ:
3515 -
3516 -[
3517 - {
3518 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3520 - "Name": "string",
3521 - "IsArchived": true,
3522 - "Constraint": {
3523 - "CalculationType": 0,
3524 - "PermissibleBalance": 0,
3525 - "DefermentDays": 0
3526 - },
3527 - "Features": [
3528 - {
3529 - "Feature": "string",
3530 - "IsFactual": true,
3531 - "Limit": 0,
3532 - "Price": 0,
3533 - "PeriodValue": 0,
3534 - "PeriodType": 0
3535 - }
3536 - ]
3537 - }
3538 -]
3539 -
3540 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3541 -|ClientId|Идентификатор клиента
3542 -|Id|Идентификатор тарифного плана
3543 -|OwnerId|Идентификатор клиента-владельца
3544 -|Name|Наименование тарифного плана
3545 -|IsArchived|Признак, определяющий архивный тарифный план
3546 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3547 -|PermissibleBalance|Допустимый баланс
3548 -|DefermentDays|Отсрочка, количество дней
3549 -|Feature|Код услуги
3550 -|IsFactual|Признак, определяющий расчёт по факту
3551 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3552 -|Price|Цена за единицу.
3553 -|PeriodValue|Значение периода.
3554 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3555 -
3556 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3557 -
3558 -(% class="box warningmessage" %)
3559 -(((
3560 -**PUT /api/v3/Billing/client/balance**
3561 -)))
3562 -
3563 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3564 -
3565 -Тело запроса:
3566 -
3567 -{
3568 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 - "Balance": 0
3570 -}
3571 -
3572 -Ответ: Success
3573 -
3574 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3575 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3576 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3577 -
3578 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3579 -
3580 -(% class="box warningmessage" %)
3581 -(((
3582 -**PUT /api/v3/billing/client/balance/deposit**
3583 -)))
3584 -
3585 -Создает операцию **Пополнение **с указанной суммой
3586 -
3587 -Тело запроса:
3588 -
3589 -{
3590 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3591 - "Balance": 0
3592 -}
3593 -
3594 -Ответ: Success
3595 -
3596 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3597 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3598 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3599 -
3600 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3601 -
3602 -Создает операцию **Списание **с указанной суммой
3603 -
3604 -(% class="box warningmessage" %)
3605 -(((
3606 -**PUT /api/v3/billing/client/balance/withdraw**
3607 -)))
3608 -
3609 -Тело запроса:
3610 -
3611 -{
3612 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3613 - "Balance": 0
3614 -}
3615 -
3616 -Ответ: Success
3617 -
3618 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3619 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3620 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3621 -
3622 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3623 -
3624 -(% class="box warningmessage" %)
3625 -(((
3626 -**PUT /api/v3/Billing/client/constraint**
3627 -)))
3628 -
3629 -Тело запроса:
3630 -
3631 -{
3632 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3633 - "CalculationType": 0,
3634 - "PermissibleBalance": 0,
3635 - "DefermentDays": 0,
3636 - "SendUiNotifications": true,
3637 - "SendEmailNotifications": true,
3638 - "IsPrivate": true,
3639 -}
3640 -
3641 -Ответ: Success
3642 -
3643 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3644 -|ClientId|Идентификатор клиента
3645 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3646 -|PermissibleBalance|Допустимый баланс
3647 -|DefermentDays|(((
3648 -Отсрочка, количество дней
3649 -)))
3650 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3651 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3652 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3653 -
3654 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3655 -
3656 -(% class="box warningmessage" %)
3657 -(((
3658 -**PUT /api/v3/Billing/client/plan**
3659 -)))
3660 -
3661 -Тело запроса:
3662 -
3663 -{
3664 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3665 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3666 - "Features": [
3667 - {
3668 - "Feature": "string",
3669 - "IsEnabled": true,
3670 - "IsFactual": true,
3671 - "Limit": 0,
3672 - "Price": 0,
3673 - "DebitDate": "2023-10-18T13:26:58.987Z",
3674 - "PeriodValue": 0,
3675 - "PeriodType": 0
3676 - }
3677 - ]
3678 -}
3679 -
3680 -Ответ: Success
3681 -
3682 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3683 -|ClientId|Идентификатор клиента
3684 -|PlanId|Идентификатор тарифного плана
3685 -|Feature|Код услуги
3686 -|IsEnabled|Признак, определяющий активирована ли услуга
3687 -|IsFactual|Признак, определяющий расчёт по факту
3688 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3689 -|Price|Цена за единицу.
3690 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3691 -|PeriodValue|Значение периода.
3692 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3693 -
3694 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3695 -
3696 -(% class="box warningmessage" %)
3697 -(((
3698 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3699 -)))
3700 -
3701 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3702 -
3703 -(% class="box infomessage" %)
3704 -(((
3705 -**POST /api/v3/vehicles/import/{agentId}**
3706 -)))
3707 -
3708 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3709 -
3710 -В пути указывается **agentId** - id клиента.
3711 -
3712 -**Заголовок**
3713 -
3714 -**X-Auth: [токен авторизации]**
3715 -
3716 -**Параметры**
3717 -
3718 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3719 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3720 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3721 -
3722 -В теле использовать тип **form-data,** тип значения** file**
3723 -
3724 -**Ключи**
3725 -
3726 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3727 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3728 -|csv|В значении передаем файл датчиков, формат **csv**
3729 -
3730 -Ответ:
3731 -
3732 -{
3733 - "vehicleId": 0,
3734 - "name": "string",
3735 - "errors": ["string"]
3736 -}
3737 -
3738 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3739 -|vehicleId|ID созданного объекта
3740 -|name|Имя созданного объекта
3741 -|errors|Ошибки и их описание
3742 -
3743 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3744 -
3745 -(% class="box infomessage" %)
3746 -(((
3747 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3748 -)))
3749 -
3750 -(% class="wikigeneratedid" %)
3751 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3752 -
3753 -(% class="wikigeneratedid" %)
3754 -В пути указывается **vehicleId **- id объекта.
3755 -
3756 -**Заголовок**
3757 -
3758 -**X-Auth: [токен авторизации]**
3759 -
3760 -В теле использовать тип **form-data.**
3761 -
3762 -Ключи:
3763 -
3764 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3765 -|**history**|В значении передавать файл с историей
3766 -
3767 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3768 -
3769 -Ответ:
3770 -
3771 -{
3772 - "results": [
3773 - {
3774 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3775 - "vehicleId": 0,
3776 - "errors": [
3777 - "string"
3778 - ],
3779 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3780 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3781 - "producedCount": 0,
3782 - "msgCount": 0
3783 - }
3784 - ]
3785 -}
3786 -
3787 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3788 -|results|Результаты импорта в разрезе ТС
3789 -|vehicleGuid|Guid ТС
3790 -|vehicleId|ID ТС
3791 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3792 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3793 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3794 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3795 -|msgCount|Кол-во обработанных сообщений всего
3796 -
3797 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3798 -
3799 -(% class="box infomessage" %)
3800 -(((
3801 -**GET /api/v3/vehicles/import/history/status**
3802 -)))
3803 -
3804 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3805 -
3806 -Ответ:
3807 -
3808 -{
3809 - "activity": true,
3810 - "progress": 0,
3811 - "message": "string"
3812 -}
3813 -
3814 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3815 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3816 -|progress|Guid ТС
3817 -
3818 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3819 -
3820 -(% class="box infomessage" %)
3821 -(((
3822 -**POST /api/v3/vehicles/export**
3823 -)))
3824 -
3825 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3826 -
3827 -Тело запроса:
3828 -
3829 -[
3830 - id
3831 -]
3832 -
3833 -Ответ: Success 200, получаете файлы с настройками.
3834 -
3835 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3836 -
3837 -(% class="box infomessage" %)
3838 -(((
3839 -**POST /api/v3/vehicles/export/history**
3840 -)))
3841 -
3842 -Метод возвращает список сообщений терминала объекта за выбранный период.
3843 -
3844 -Тело запроса:
3845 -
3846 -{
3847 - "vehicleId": 0,
3848 - "asArchive": true,
3849 - "from": "2023-09-27T12:17:45.973Z",
3850 - "to": "2023-09-27T12:17:45.973Z"
3851 -}
3852 -
3853 -Ответ:
3854 -
3855 -Получаете файл. Сообщение: Code 200/Success
3856 -
3857 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3858 -|vehicleId|ID объекта
3859 -|asArchive|true - Архивировать файл, False - не архивировать
3860 -|from|Дата и время начала запроса
3861 -|to|Дата и время окончания запроса
3862 -
3863 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3864 -
3865 -(% class="box infomessage" %)
3866 -(((
3867 -**GET /api/v3/vehicles/export/history/status**
3868 -)))
3869 -
3870 -Метод возвращает список сообщений терминала объекта за выбранный период.
3871 -
3872 -Ответ:
3873 -
3874 -{
3875 - "activity": true,
3876 - "progress": 0,
3877 - "message": "string"
3878 -}
3879 -
3880 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3881 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3882 -|progress|Прогресс экспорта, от 0 до 100%
3883 -|message|Текст описывающий статус
3884 -
3885 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3886 -
3887 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3888 -
3889 -(% class="box infomessage" %)
3890 -(((
3891 -**POST /api/v3/EcoDriving/rating**
3892 -)))
3893 -
3894 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3895 -
3896 -Тело запроса:
3897 -
3898 -{
3899 - "vehicleIds": [vehicleId],
3900 - "from": "2023-11-22T09:29:48.051Z",
3901 - "to": "2023-11-22T09:29:48.051Z"
3902 -}
3903 -
3904 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3905 -|vehicleIds|Массив ID объектов
3906 -|from|Дата начала запроса
3907 -|to|Дата окончания запроса
3908 -
3909 -Ответ:
3910 -
3911 -{
3912 - "items": [
3913 - {
3914 - "from": "2023-11-22T09:29:48.052Z",
3915 - "to": "2023-11-22T09:29:48.052Z",
3916 - "vehicleId": 0,
3917 - "vehicleName": "string",
3918 - "vehicleModel": "string",
3919 - "penalty": 0,
3920 - "score": 0,
3921 - "totalViolations": 0,
3922 - "violationsByType": {
3923 - "overspeedingViolations": 0,
3924 - "accelerationViolations": 0,
3925 - "brakingViolations": 0,
3926 - "turningViolations": 0,
3927 - "dangerousDrivingViolations": 0,
3928 - "sensorViolations": 0
3929 - },
3930 - "moveTime": 0,
3931 - "mileage": 0,
3932 - "tripsCount": 0,
3933 - "trips": [
3934 - {
3935 - "penalty": 0,
3936 - "score": 0,
3937 - "violationsCount": 0,
3938 - "violationsByType": {
3939 - "overspeedingViolations": 0,
3940 - "accelerationViolations": 0,
3941 - "brakingViolations": 0,
3942 - "turningViolations": 0,
3943 - "dangerousDrivingViolations": 0,
3944 - "sensorViolations": 0
3945 - },
3946 - "moveTime": 0,
3947 - "mileage": 0,
3948 - "motohours": 0,
3949 - "maxSpeed": 0,
3950 - "startAddress": "string",
3951 - "endAddress": "string",
3952 - "drivers": [
3953 - {
3954 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3955 - "driverName": "string",
3956 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3957 - }
3958 - ]
3959 - }
3960 - ]
3961 - }
3962 - ]
3963 -}
3964 -
3965 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3966 -|from|Дата начала запроса
3967 -|to|Дата  окончания
3968 -|vehicleId|ID объекта
3969 -|vehicleName|Имя объекта
3970 -|vehicleModel|Модель объекта
3971 -|penalty|Сумма штрафных баллов
3972 -|score|Оценка
3973 -|totalViolations|Суммарное количество нарушений
3974 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3975 -|overspeedingViolations|Превышение скорости
3976 -|accelerationViolations|Ускорение
3977 -|brakingViolations|Торможение
3978 -|turningViolations|Резкий поворот
3979 -|dangerousDrivingViolations|Резкое вождение
3980 -|sensorViolations|Нарушение по датчику
3981 -|moveTime|Время в движении
3982 -|mileage|Пробег
3983 -|tripsCount|Количество рейсов
3984 -|motohours|Моточасы
3985 -|maxSpeed|Максимальная скорость
3986 -|startAddress|Адрес начала рейса
3987 -|endAddress|Адрес окончания рейса
3988 -|drivers|Список водителей, которые были на объекте в течениии рейса
3989 -|driverGuid|Guid водителя
3990 -|driverName|Имя водителя
3991 -|driverRfid|Номер Карты-метки
3992 -
3993 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3994 -
3995 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
3996 -
3997 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
3998 -
3999 -(% class="box infomessage" %)
4000 -(((
4001 -POST /api/v3/fuelcards/transactions
4002 -)))
4003 -
4004 -Метод запроса: POST
4005 -
4006 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4007 -\\В заголовках запроса: X-Auth: Токен авторизации
4008 -
4009 -Параметры в теле запроса (JSON):
4010 -
4011 -{
4012 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4013 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4014 - "ids": [ 
4015 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4016 - ],
4017 - "timezone": 0 ~/~/Таймзона
4018 -}
4019 -
4020 -
4021 -Ответ:
4022 - {
4023 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4024 - "driver": "string", ~/~/Водители, привязанные к ТК
4025 - "object": "string", ~/~/Наименование ТС
4026 - "amount": 0, ~/~/Количество топлива
4027 - "amountDut": 0, ~/~/Количество по ДУТ
4028 - "amountDiff": 0, ~/~/Разница, л
4029 - "amountDiffPerc": 0, ~/~/Разница, %
4030 - "summa": 0, ~/~/Стоимость, руб
4031 - "serviceName": "string", ~/~/Тип топлива
4032 - "price": 0, ~/~/Цена за литр, руб
4033 - "cardName": "string", ~/~/Наименование ТК
4034 - "cardNum": "string", ~/~/Номер ТК
4035 - "operator": "string", ~/~/Оператор ТК
4036 - "address": "string" ~/~/Адрес АЗС
4037 - }
4038 -
4039 -
4040 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4041 -
4042 -
4043 -== **Получение полных данных о ретрансляторе** ==
4044 -
4045 -(% class="box infomessage" %)
4046 -(((
4047 -**GET ** **/api/v3/retranslations/{id}**
4048 -)))
4049 -
4050 -Идентификатор запроса: ID
4051 -
4052 -
4053 -Пример ответа:
4054 -
4055 -{  
4056 -"description": "", ~/~/ Определяет описание
4057 -"subscriberId": "", ~/~/ Подписчик
4058 -"protocolType": 0, ~/~/ Тип протокола
4059 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4060 -"address": "string", ~/~/ Адрес события
4061 -"objects": [ ~/~/Объекты для ретрансляции
4062 -{      
4063 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4064 -"name": "", ~/~/ Наименование объекта ретрансляции
4065 -"imei": "", ~/~/ IMEI объекта  
4066 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4067 -}
4068 - ],  
4069 -"id": "", ~/~/ идентификатор пользователя   
4070 -"parentId": "", ~/~/Guid родителя
4071 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4072 -}
4073 -
4074 -
4075 -== **Удаление данных ретранслятора** ==
4076 -
4077 -(% class="box infomessage" %)
4078 -(((
4079 -**DELETE** **/api/v3/retranslations/{id}**
4080 -)))
4081 -
4082 -Параметр запроса: ID
4083 -
4084 -
4085 -== **Создание ретранслятора** ==
4086 -
4087 -(% class="box infomessage" %)
4088 -(((
4089 -**POST ** **/api/v3/retranslations/{id}**
4090 -)))
4091 -
4092 -Запрос:
4093 -
4094 -{  
4095 -"description": "", ~/~/ Описание
4096 -"subscriberId": "", ~/~/ Подписчик
4097 -"protocolType": 0, ~/~/ Тип протокола
4098 -"address": "", ~/~/ Адрес ретрансляции
4099 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4100 -"objects": [ ~/~/Объекты для ретрансляции
4101 -{      
4102 -"id": "", ~/~/ идентификатор пользователя     
4103 -"imei": "", ~/~/IMEI объекта
4104 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4105 -}
4106 - ]
4107 -}
4108 -
4109 -
4110 -Ответ:
4111 -
4112 -{  
4113 -"description": "string", ~/~/ Определяет описание
4114 -"subscriberId": "", ~/~/ идентификатор запроса
4115 -"protocolType": 0, ~/~/ Тип протокола
4116 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4117 -"address": "", ~/~/ Адрес события
4118 -"objects": [ ~/~/Объекты для ретрансляции
4119 -{      
4120 -"id": "", ~/~/ идентификатор пользователя    
4121 -"name": "string", ~/~/ Название уведомления
4122 -"imei": "string", ~/~/IMEI объекта  
4123 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4124 -}
4125 - ],  
4126 -"id": "", ~/~/ идентификатор пользователя  
4127 -"parentId": "", ~/~/ Guid идентификатор родителя
4128 -"deleted": true ~/~/ Признак удаления
4129 -}
4130 -
4131 -
4132 -== **Редактирование ретранслятора** ==
4133 -
4134 -(% class="box infomessage" %)
4135 -(((
4136 -**PUT** **/api/v3/retranslations**
4137 -)))
4138 -
4139 -Пример запроса:
4140 -
4141 -{  
4142 -"id": "", ~/~/ идентификатор пользователя   
4143 -"description": "string", ~/~/ Определяет описание
4144 -"subscriberId": "", ~/~/ идентификатор запроса
4145 -"protocolType": 0, ~/~/ Тип протокола
4146 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4147 -"address": "string", ~/~/ Адрес события
4148 -"objects": ~/~/Объекты для ретрансляции
4149 -[    
4150 -{      
4151 -"id": "",  ~/~/ идентификатор пользователя         
4152 -"imei": "", ~/~/IMEI объекта
4153 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4154 -}
4155 - ]
4156 -}
4157 -
4158 -
4159 -Пример ответа:
4160 -
4161 -{  
4162 -"description": "", ~/~/ Определяет описание
4163 -"subscriberId": "", ~/~/ идентификатор запроса
4164 -"protocolType": 0, ~/~/ Тип протокола
4165 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4166 -"address": "string", ~/~/ Адрес события
4167 -"objects": [ ~/~/Объекты для ретрансляции
4168 -{      
4169 -"id": "", ~/~/ идентификатор пользователя     
4170 -"name": "string", ~/~/ Название уведомления    
4171 -"imei": "", ~/~/IMEI объекта
4172 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4173 -}
4174 - ],
4175 -"id": "", ~/~/ идентификатор пользователя   
4176 -"parentId": "", ~/~/ Guid идентификатор родителя
4177 -"deleted": true ~/~/ Признак удаления
4178 -}
4179 -
4180 -
4181 -== **Получение списка ретранслятора клиента** ==
4182 -
4183 -(% class="box infomessage" %)
4184 -(((
4185 -**POST /api/v3/retranslations/find**
4186 -)))
4187 -
4188 -Пример запроса:
4189 -
4190 -{  
4191 -"id": "", ~/~/ идентификатор пользователя   
4192 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4193 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4194 -}
4195 -
4196 -Ответ:
4197 -
4198 -[ 
4199 -{    
4200 -"description": "", ~/~/ Определяет описание
4201 -"subscriberId": "", ~/~/ идентификатор запроса
4202 -"protocolType": 0, ~/~/ Тип протокола
4203 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4204 -"address": "string", ~/~/ Адрес события
4205 -"id": "", ~/~/ идентификатор пользователя   
4206 -"parentId": "", ~/~/ Guid идентификатор родителя
4207 -"deleted": true ~/~/ Признак удаления
4208 -}
4209 -]
4210 -
4211 -
4212 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4213 -
4214 -== **API для отчета по выгрузке комбайнов** ==
4215 -
4216 -(% class="box infomessage" %)
4217 -(((
4218 -POST **/api/v3/Reports/harvesterUnloading**
4219 -)))
4220 -
4221 -Пример запроса:
4222 -
4223 -{
4224 - "byTime": 0, ~/~/ Объединение событий по времени
4225 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4226 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4227 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4228 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4229 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4230 - 0
4231 - ],
4232 - "from": "", ~/~/ Дата и время начало запроса
4233 - "to": "", ~/~/ Дата и время окончания запроса
4234 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4235 -}
4236 -
4237 -Пример ответа:
4238 -
4239 -[ 
4240 - {
4241 - "harvesterName": "", ~/~/Комбайн, номер
4242 - "harvesterId": 0, ~/~/Комбайн, id
4243 -"harvesterModel": "", ~/~/ Модель комбайна
4244 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4245 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4246 - "events": [ ~/~/Список событий в разрезе комбайна
4247 - {
4248 - "driverId": "", ~/~/Идентификатор водителя
4249 - "driverName": "", ~/~/Водитель комбайна, ФИО
4250 - "RFID": "", ~/~/ идентификатор карты-метки
4251 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4252 - "vehicleId": 0, ~/~/идентификатор объекта
4253 - "vehicleName": "string", ~/~/ Имя объекта
4254 - "modelName": "string", ~/~/ Имя модели объекта
4255 - "nearestVehicles": [ ~/~/Объекты рядом
4256 - {
4257 - "vehicleId": 0, ~/~/идентификатор объекта
4258 - "vehicleName": "string" ~/~/ Имя объекта
4259 - }
4260 - ],
4261 - "fields": [ ~/~/Поля, где происходила выгрузка
4262 - {
4263 - "id": 0, ~/~/ идентификатор пользователя 
4264 - "name": "string" ~/~/ имя пользователя 
4265 - }
4266 - ],
4267 - "event": "string", ~/~/Событие
4268 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4269 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4270 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4271 - "cultureName": "string", ~/~/ название культуры
4272 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4273 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4274 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4275 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4276 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4277 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4278 - "issued": 0, ~/~/Выдано, бункеров
4279 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4280 - "latitude": 0, ~/~/Широта
4281 - "longitude": 0, ~/~/ Долгота
4282 - "litresAway": 0, ~/~/Отдано, л
4283 - "m3Away": 0 ~/~/Отдано, м3
4284 - }
4285 - ]
4286 - }
4287 -]
4288 -
4289 -
4290 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4291 -
4292 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4293 -
4294 -
4295 -(% class="box infomessage" %)
4296 -(((
4297 -GET api/v3/Vehicles/recyclebin/all
4298 -)))
4299 -
4300 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4301 -
4302 -Параметр запроса: {parentId} - идентификатор агента
4303 -
4304 -В заголовках запроса: X-Auth: Токен авторизации
4305 -
4306 -Ответ:
4307 -
4308 -[ 
4309 - {
4310 - "recordTime": "", ~/~/Время записи
4311 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4312 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4313 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4314 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4315 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4316 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4317 - "items": [ ~/~/ 
4318 -nullable: true ~/~/Детали
4319 - {
4320 - "name": "string", ~/~/наименование столбца
4321 - "value": "string" ~/~/содержание столбца
4322 - }
4323 - ]
4324 - },
4325 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4326 - "string"
4327 - ]
4328 - }
4329 -]
4330 -
4331 -
4332 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4333 -
4334 -(% class="box infomessage" %)
4335 -(((
4336 -POST/api/v3/Vehicles/recyclebin/erase
4337 -)))
4338 -
4339 -В заголовках запроса: X-Auth: Токен авторизации
4340 -
4341 -Пример запроса:
4342 -
4343 -[
4344 -0
4345 -]
4346 4346  
4347 4347  
4348 -Пример ответа:
442 + **Проверка авторизации**
4349 4349  
4350 -[ 
4351 -{
4352 - "recordTime": "", ~/~/Время записи
4353 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4354 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4355 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4356 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4357 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4358 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4359 - "items": [ ~/~/Детали
4360 - {
4361 - "name": "", ~/~/Имя свойства
4362 - "value": "" ~/~/Значение свойства
4363 - }
4364 - ]
4365 - },
4366 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4367 - ""
4368 - ]
4369 - }
4370 -]
444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
4371 4371  
4372 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
446 +Метод запроса: GET
4373 4373  
4374 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
448 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
4375 4375  
4376 -(% class="box infomessage" %)
4377 -(((
4378 -POST/api/v3/Vehicles/recyclebin/restore
4379 -)))
4380 -
4381 4381  В заголовках запроса: X-Auth: Токен авторизации
4382 4382  
4383 -Параметры в теле запроса (JSON):
452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
4384 4384  
4385 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4386 -
4387 -В заголовках запроса: X-Auth: Токен авторизации
4388 -
4389 -
4390 -Пример запроса:
4391 -
4392 -(((
4393 -[
4394 -)))
4395 -
4396 -(((
4397 - 0
4398 -)))
4399 -
4400 -(((
4401 -]
4402 -)))
4403 -
4404 -
4405 -Пример ответа:
4406 -
4407 -[
4408 -{
4409 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4410 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4411 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4412 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4413 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4414 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4415 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4416 - "items": [ ~/~/Детали
4417 - {
4418 - "name": "string", ~/~/Имя свойства
4419 - "value": "string" ~/~/Значение свойства
4420 - }
4421 - ]
4422 - },
4423 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4424 - "string"
4425 - ]
4426 - }
4427 -]
4428 -
4429 -
4430 -
4431 -(% class="box" lang="en-US" style="text-align: center;" %)
4432 -(((
4433 -(% 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]] **
4434 -)))
454 +**Расширенное описание API доступно по запросу на 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 г.