Last modified by Андрей Калиновский on 2025/04/24 15:46
<
From version < 165.1 >
edited by Андрей Калиновский
on 2024/08/12 16:26
To version < 6.1 >
edited by Андрей Калиновский
on 2022/08/31 14:13
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,4456 +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  
17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
19 19  
20 -(% style="color:#000000; font-size:16px" %)**Рекомендации**
19 +Метод запроса: GET
21 21  
22 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
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]]
23 23  
24 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
25 25  
26 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26 +
27 27  
28 -(% class="box successmessage" %)
29 -(((
30 -(% lang="en-US" %)**POST /api/v3/auth/login**
31 -)))
28 + **Получение списка объектов**
32 32  
33 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
34 34  
35 -(% style="color:#000000" %)Метод запроса: **POST**
32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
36 36  
37 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
38 38  
39 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
40 40  
41 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
42 42  
43 -(% style="color:#000000" %){
44 - "login": "testuser",
45 - "password": "testuser"
46 -}
40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
47 47  
48 -(% style="color:#000000" %)**Ответ:**
42 +Метод запроса: POST
49 49  
50 -(% lang="en-US" %)
51 -(% style="color:#000000" %){
52 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
53 - "User": "testuser" , ~/~/ имя пользователя(%%)
54 -}
44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
55 55  
56 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
46 +В заголовках запроса:
57 57  
58 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
59 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
61 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
62 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
48 +−Content-Type: application/json
63 63  
64 -(% class="wikigeneratedid" %)
65 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
50 +−X-Auth: Токен авторизации
66 66  
67 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
68 68  
69 -(% class="box infomessage" %)
70 -(((
71 -(% lang="en-US" %)**GET /api/v3/auth/check**
72 -)))
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, опционально)}}}}
73 73  
74 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
75 75  
76 -(% style="color:#000000" %)Метод запроса: **GET**
58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
77 77  
78 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
79 79  
80 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
62 +0 - «Блокировка»
81 81  
82 -(% lang="en-US" %)
83 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
64 +1 - «Активен»,
84 84  
85 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
66 +2 - «Отменен»
86 86  
87 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
68 +3 - «Оборудован»
88 88  
89 -(% class="box infomessage" %)
90 -(((
91 -**GET api/v3/agents/{id}**
92 -)))
70 +4 - «Диагностика»
93 93  
94 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
72 +5 - «Сервис»
95 95  
96 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
74 +6 - «Демонтаж»
97 97  
98 -(% style="color:#000000" %)Метод запроса: **GET**
76 +7 - «Монтаж»
99 99  
100 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
78 +8 - «Дозаказ»
101 101  
102 -Запрос должен содержать данные параметра "**agentId**"
80 +9 - «Обслужен»
103 103  
104 -(% style="color:#000000" %)Ответ:
105 -{
106 - "agentId": "",  (%%)
107 - "parentId": "",
108 - "parentName": "string",
109 - "name": "string",
110 - "fullName": "string",
111 - "agentInfoType": 0,
112 - "isForeign": true/false,
113 - "district": "string", 
114 - "region": "string",
115 - "city": "string",
116 - "inn": "string",
117 - "kpp": "string",
118 - "address": "string",
119 - "addressFact": "string",
120 - "email": "string",
121 - "director": "string",
122 - "bankName": "string",
123 - "bankBIK": "string",
124 - "bankRS": "string",
125 - "bankKS": "string"
126 - }
82 +10 - «Списан»
127 127  
128 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
129 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
130 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
131 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
132 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
133 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
134 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
135 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
136 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
137 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
138 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
139 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
140 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
141 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
142 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
143 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
144 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
145 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
146 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
147 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
148 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
84 +11 - «Неисправен»
149 149  
150 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
86 +12 - «Проверен»
151 151  
152 -(% class="box infomessage" %)
153 -(((
154 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
155 -)))
88 +13 - «Не эксплуатируется»
89 +
156 156  
157 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
91 + **Получение списка клиентов.**
158 158  
159 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
160 160  
161 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
162 162  
163 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
164 164  
165 -(% style="color:#000000" %)Метод запроса: **POST**
99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
166 166  
167 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
101 +Метод запроса: GET
168 168  
169 -(% style="color:#000000" %)Параметр запроса:
103 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
170 170  
171 -(% style="color:#000000" %){
172 - "parentId": "string"
173 -}
105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
174 174  
175 -(% style="color:#000000" %)Ответ:
176 -
177 -{
178 - "agentId": "",(% style="color:#000000" %)   (%%)
179 - "parentId": "",
180 - "name": "string",
181 - "fullName": "string",
182 - "agentInfoType": 0,
183 -(% style="color:#000000" %) "status": "",
184 -}
185 -
186 -
187 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
188 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
189 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
190 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
191 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
192 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
193 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
194 -
195 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
196 -
197 -(% class="box successmessage" %)
198 -(((
199 -**POST /api/v3/agents **
200 -)))
201 -
202 -Метод позволяет добавить клиента, указанного в запросе.
203 -
204 -Метод запроса: **POST**
205 -
206 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
207 -
208 208  В заголовках запроса: X-Auth: Токен авторизации
209 209  
210 -Параметры в теле запроса (JSON):
109 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
211 211  
212 -{
213 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
214 - "name": "string", ~/~/ имя
215 - "fullName": "string", ~/~/ полное наименование
216 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
217 - "isForeign": true, ~/~/ иностранный контрагент
218 - "district": "string", ~/~/ округ
219 - "region": "string", ~/~/ регион
220 - "city": "string", ~/~/ город
221 - "inn": "string", ~/~/ ИНН
222 - "kpp": "string", ~/~/ КПП
223 - "address": "string", ~/~/ юридический адрес
224 - "addressFact": "string", ~/~/ фактический адрес
225 - "email": "string", ~/~/ email
226 - "director": "string", ~/~/ ФИО руководителя
227 - "bankName": "string", ~/~/ банк
228 - "bankBIK": "string", ~/~/ БИК
229 - "bankRS": "string", ~/~/ номер счёта
230 - "bankKS": "string" ~/~/ корр. счёт
231 -}
111 +Примечание. Возможные значение параметра agentInfoType:
112 +
232 232  
233 -Ответ:
114 + **Получение списка пользователей.**
234 234  
235 -{
236 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
237 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
238 - "name": "string", ~/~/ имя
239 - "fullName": "string", ~/~/ полное наименование
240 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
241 - "isForeign": true, ~/~/ иностранный контрагент
242 - "district": "string", ~/~/ округ
243 - "region": "string", ~/~/ регион
244 - "city": "string", ~/~/ город
245 - "inn": "string", ~/~/ ИНН
246 - "kpp": "string", ~/~/ КПП
247 - "address": "string", ~/~/ юридический адрес
248 - "addressFact": "string", ~/~/ фактический адрес
249 - "email": "string", ~/~/ email
250 - "director": "string", ~/~/ ФИО руководителя
251 - "bankName": "string", ~/~/ банк
252 - "bankBIK": "string", ~/~/ БИК
253 - "bankRS": "string", ~/~/ номер счёта
254 - "bankKS": "string" ~/~/ корр. счёт
255 -}
116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
256 256  
257 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
278 278  
279 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
120 +Метод запроса: POST
280 280  
281 -(% class="box warningmessage" %)
282 -(((
283 -**PUT /api/v3/agents**
284 -)))
122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
285 285  
286 -Метод позволяет отредактировать клиента, указанного в запросе.
124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
287 287  
288 -Метод запроса: **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 - неважно}}}
289 289  
290 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
291 -
292 -В заголовках запроса: X-Auth: Токен авторизации
293 -
294 -Параметры в теле запроса (JSON):
295 -
296 -{
297 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
298 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
299 - "name": "string", ~/~/ имя
300 - "fullName": "string", ~/~/ полное наименование
301 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
302 - "isForeign": true, ~/~/ иностранный контрагент
303 - "district": "string", ~/~/ округ
304 - "region": "string", ~/~/ регион
305 - "city": "string", ~/~/ город
306 - "inn": "string", ~/~/ ИНН
307 - "kpp": "string", ~/~/ КПП
308 - "address": "string", ~/~/ юридический адрес
309 - "addressFact": "string", ~/~/ фактический адрес
310 - "email": "string", ~/~/ email
311 - "director": "string", ~/~/ ФИО руководителя
312 - "bankName": "string", ~/~/ банк
313 - "bankBIK": "string", ~/~/ БИК
314 - "bankRS": "string", ~/~/ номер счёта
315 - "bankKS": "string" ~/~/ корр. счёт
316 316  }
317 317  
318 -Ответ:
133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
319 319  
320 -{
321 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
322 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
323 - "name": "string", ~/~/ имя
324 - "fullName": "string", ~/~/ полное наименование
325 - "isForeign": true, ~/~/ иностранный контрагент
326 - "district": "string", ~/~/ округ
327 - "region": "string", ~/~/ регион
328 - "city": "string", ~/~/ город
329 - "inn": "string", ~/~/ ИНН
330 - "kpp": "string", ~/~/ КПП
331 - "address": "string", ~/~/ юридический адрес
332 - "addressFact": "string", ~/~/ фактический адрес
333 - "email": "string", ~/~/ email
334 - "director": "string", ~/~/ ФИО руководителя
335 - "bankName": "string", ~/~/ банк
336 - "bankBIK": "string", ~/~/ БИК
337 - "bankRS": "string", ~/~/ номер счёта
338 - "bankKS": "string" ~/~/ корр. счёт
339 -}
135 +{{{ "sessionDuration": "", // длительность сессии в минутах}}}
340 340  
341 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
342 342  
343 -(% class="box errormessage" %)
344 -(((
345 -**DELETE /api/v3/agents/{clientId}**
346 -)))
140 + **Получение списка типов устройств**
347 347  
348 -Метод позволяет удалить клиента, указанного в строке запроса.
142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
349 349  
350 -Метод запроса: **DELETE**
144 +Метод запроса: GET
351 351  
352 -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]]
353 353  
354 -Параметр запроса: **{clientId}** - Guid пользователя
148 +В заголовках запроса:X-Auth: Токен авторизации
355 355  
356 -В заголовках запроса: X-Auth: Токен авторизации
150 +Ответ: [
357 357  
358 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
152 +{{{ {
153 + "deviceTypeId" : "", // ID типа устройства
154 + "deviceTypeName" : "" // Название типа устройства
155 + },}}}
359 359  
360 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
157 +… ]
158 +
361 361  
362 -(% class="box warningmessage" %)
363 -(((
364 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 -)))
160 + **Получение списка типов датчиков**
366 366  
367 -Метод позволяет изменить статус клиента, указанного в запросе.
162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
368 368  
369 -В пути указывается GUID клиента и статус клиента.
164 +Метод запроса: GET
370 370  
371 -**status **- значение 0 - заблокирован, 1 - активен.
166 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
372 372  
373 -Ответ: Code 204
168 +В заголовках запроса:X-Auth: Токен авторизации
374 374  
375 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
170 +Ответ: [
376 376  
377 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
172 +{{{ {}}}
378 378  
379 -(% class="box successmessage" %)
380 -(((
381 -(% lang="en-US" %)**POST /api/v3/users**
382 -)))
174 +«id»: «», //ID типа датчика «name»: «», //Название
383 383  
384 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
176 +{{{ "description": "" // Описание
177 + },}}}
385 385  
386 -(% style="color:#000000" %)Метод запроса: **POST**
179 +… ]
180 +
387 387  
388 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
182 + **Получение информации об объекте**
389 389  
390 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
391 391  
392 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
393 393  
394 -(% style="color:#000000" %)
395 -{ 
396 - "lastName": "", ~/~/ фамилия
397 - "firstName": "", ~/~/ имя
398 - "position": "", ~/~/ должность
399 - "phone": "", ~/~/ телефон
400 - "organization": "", ~/~/ организация
401 - "login": "", ~/~/ логин (обязателен)
402 - "password": "", ~/~/ пароль (обязателен)
403 - "email": "", ~/~/ email (обязателен)
404 - "description": "string", ~/~/ Описание
405 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
406 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
407 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
408 - "parentId": "", ~/~/ Guid родительского агента
409 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
410 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
411 - "doubleAuth":
412 - {
413 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
414 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
415 - },
416 - "groups":
417 - [
418 - "string" ~/~/ группы пользователя, перечисление названия системных ролей
419 - ],
420 - "customGroups":
421 - [
422 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
423 - ],
424 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
425 -}
426 -{
427 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
428 - "lastName": "string",
429 - "firstName": "string",
430 - "position": "string",
431 - "phone": "string",
432 - "organization": "string",
433 - "login": "string",
434 - "password": "string",
435 - "email": "string",
188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
436 436  
437 -(% style="text-align:left" %)
438 -(% style="color:#000000; font-weight:normal" %)Ответ:
439 -{     
440 - "id": "" , ~/~/ ID пользователя
441 - "lastName": "" , ~/~/ Фамилия ,
442 - "firstName": "" , ~/~/ Имя
443 - "position": "" , ~/~/ Должность
444 - "phone": "" , ~/~/ Телефон
445 - "organization": "" , ~/~/ Организация
446 - "login": "" , ~/~/ Логин
447 - "password": "" , ~/~/ Пароль
448 - "email": "" , ~/~/ Email
449 - "description": "" , ~/~/ Описание
450 - "isEnabled": "" , ~/~/ Признак включения
451 - "parentId": "" , ~/~/ Guid родительского агента
452 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
453 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
454 - "kind": "" , ~/~/ тип аутентификации
455 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
456 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
457 -}
190 +Метод запроса: GET
458 458  
192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
459 459  
460 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
461 461  
462 -(% class="box infomessage" %)
463 -(((
464 -(% lang="en-US" %)**POST /api/v3/users/find**
465 -)))
196 +В заголовках запроса: X-Auth: Токен авторизации
466 466  
467 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
468 -
469 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
470 -
471 -(% style="color:#000000" %)Метод запроса: **POST**
472 -
473 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
474 -
475 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
476 -
477 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
478 -
479 -(% style="color:#000000" %){(%%)
480 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
481 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
482 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
483 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
484 -(% style="color:#000000" %)}
485 -
486 -(% style="color:#000000" %)Ответ:
487 -
488 -(% style="color:#000000" %){         (%%)
489 - "id": "" , ~/~/ идентификатор пользователя
490 - "lastName": "" , ~/~/ фамилия
491 - "firstName": "" , ~/~/ имя
492 - "position": "" , ~/~/ должность
493 - "phone": "" , ~/~/ телефон
494 - "parentId": "" , ~/~/ идентификатор клиента-родителя
495 - "parentName": "" , ~/~/ наименование клиента-родителя
496 - "organization": "" , ~/~/ организация
497 - "login": "" , ~/~/ логин
498 - "email": "" , ~/~/ E-mail
499 - "sessionDuration":"", ~/~/ длительность сессии в минутах
500 - "status": "1",  ~/~/ статус пользователя
501 - "lastLogged": "", ~/~/ дата/время последней авторизации
502 -(% style="color:#000000" %)}
503 -
504 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
505 -
506 -(% class="box infomessage" %)
507 -(((
508 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
509 -)))
510 -
511 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
512 -
513 -(% style="color:#000000" %)Метод запроса: **GET**
514 -
515 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
516 -
517 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
518 -
519 -(% style="color:#000000" %)Ответ:
520 -
521 -(((
522 -(((
523 -{
524 - "id": "", ~/~/ GUID пользователя
525 - "lastName": "", ~/~/ Фамилия 
526 - "firstName": "", ~/~/ Имя
527 - "position": "", ~/~/ Должность
528 - "phone": "", ~/~/ Номер телефона
529 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
530 - "parentName": "", Наименование клиента, которому принадлежит пользователь
531 - "organization": "", ~/~/ Организация
532 - "login": "", ~/~/ Логин пользователя
533 - "email": "", ~/~/ Адрес электронной почты
534 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
535 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
536 - "description": "", ~/~/ Описание
537 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
538 - "doubleAuth":
539 - {
540 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
541 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
542 - },
543 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
544 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
545 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
546 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
547 - "groups": [], ~/~/ Список ролей пользователя
548 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
549 - "authDevices": [ ], ~/~/ Список авторизованных устройств
550 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
551 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
552 -}
553 -)))
554 -)))
555 -
556 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
557 -
558 -(% class="box warningmessage" %)
559 -(((
560 -(% lang="en-US" %)**PUT /api/v3/users**
561 -)))
562 -
563 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
564 -
565 -(% style="color:#000000" %)Метод запроса: **PUT**
566 -
567 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
568 -
569 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
570 -
571 -(% lang="en-US" style="text-align:left" %)
572 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
573 -
574 -(% lang="en-US" style="text-align:left" %)
575 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
576 - "id": "" , ~/~/ ID пользователя 
577 - "lastName": "" , ~/~/ фамилия
578 - "firstName": "" , ~/~/ имя
579 - "position": "" , ~/~/ должность
580 - "phone": "" , ~/~/ телефон
581 - "organization": "" , ~/~/ организация
582 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
583 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
584 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
585 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
586 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
587 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
588 - "isEnabled": "" , ~/~/ признак включения
589 - "parentId": "" , ~/~/ Guid родительского агента
590 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
591 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
592 - "doubleAuth":
593 - {
594 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
595 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
596 - },
597 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
598 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
599 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
600 -
601 -(% lang="en-US" style="text-align:left" %)
602 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
603 -
604 -(% lang="en-US" style="text-align:left" %)
605 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
606 - "id": "" , ~/~/ идентификатор пользователя
607 - "lastName": "" , ~/~/ фамилия
608 - "firstName": "" , ~/~/ имя
609 - "position": "" , ~/~/ должность
610 - "phone": "" , ~/~/ телефон
611 - "organization": "" , ~/~/ организация
612 - "login": "" , ~/~/ логин
613 - "password": "" , ~/~/ пароль 
614 - "email": "" , ~/~/ email
615 - "description": "" , ~/~/ описание
616 - "isEnabled": "" , ~/~/ признак включения
617 - "parentId": "" , ~/~/ Guid родительского агента
618 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
619 - "doubleAuth":
620 - {
621 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
622 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
623 - },
624 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
625 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
626 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
627 -}
628 -
629 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
630 -
631 -(% class="box warningmessage" %)
632 -(((
633 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
634 -)))
635 -
636 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
637 -
638 -(% style="color:#000000" %)Метод запроса: **PUT**
639 -
640 -(% 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}
641 -
642 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
643 -
644 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
645 -
646 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
647 -
648 -(% style="color:#000000" %){(%%)
649 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
650 - "description": "" , ~/~/ описание
651 - "data": "" , ~/~/ данные, связанные со сменой статуса
652 -(% style="color:#000000" %)}
653 -
654 -(% style="text-align:left" %)
655 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
656 -
657 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
658 -
659 -(% class="box warningmessage" %)
660 -(((
661 -**POST /api/v3/users/disable**
662 -)))
663 -
664 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
665 -
666 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
667 -
668 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
669 -
670 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
671 -
672 - [ 
673 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
674 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
675 - ]
676 -
677 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
678 -
679 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
680 -
681 -(% class="box warningmessage" %)
682 -(((
683 -**POST /api/v3/users/enable**
684 -)))
685 -
686 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
687 -
688 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
689 -
690 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
691 -
692 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
693 -
694 - [ 
695 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
696 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
697 - ]
698 -
699 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
700 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
701 -
702 -(((
703 -В теле ответа:
704 -{
705 - "errorMessages": [
706 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
707 - ],
708 - "users": [
709 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
710 - ]
711 -}
712 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
713 -"users" - массив id пользователей, которых не удалось включить или отключить.
714 -)))
715 -
716 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
717 -
718 -(% class="box errormessage" %)
719 -(((
720 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
721 -)))
722 -
723 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
724 -
725 -(% style="color:#000000" %)Метод запроса: **DELETE**
726 -
727 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
728 -
729 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
730 -
731 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
732 -
733 -(% style="text-align:left" %)
734 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
735 -
736 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
737 -
738 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
739 -
740 -(% class="box infomessage" %)
741 -(((
742 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
743 -)))
744 -
745 -Метод возвращает полную информацию о модели объекта.
746 -
747 -(% style="color:#000000" %)Метод запроса: **GET**
748 -
749 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
750 -
751 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
752 -
753 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
754 -
755 -(% style="color:#000000" %)Ответ:
756 -
757 -(% style="color:#000000" %){
758 - "parentName": "string",
759 - "name": "string",
760 - "picture": "string",
761 - "minspeed": 0,
762 - "maxspeed": 0,
763 - "width": 0,
764 - "imbeddedtrailer": true,
765 - "hoppercapacity": 0,
766 - "hopperdischargespeed": 0,
767 - "modelType": 0,
768 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
769 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
770 - "deleted": true
771 -}
772 -
773 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
774 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
775 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
776 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
777 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
778 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
779 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
780 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
781 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
782 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
783 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
784 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
785 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
786 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
787 -
788 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
789 -
790 -(% class="box successmessage" %)
791 -(((
792 -(% lang="en-US" %)**POST /api/v3/models/find**
793 -)))
794 -
795 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
796 -
797 -(% style="color:#000000" %)Метод запроса: **POST**
798 -
799 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
800 -
801 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
802 -
803 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
804 -
805 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
806 -}
807 -
808 -(% style="color:#000000" %)Ответ:
809 -
810 -(% style="color:#000000" %)[
811 - {
812 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
813 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
814 - "parentName": "string",
815 - "name": "string",
816 - "modelType": 0
817 - }
818 -]
819 -
820 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
821 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
822 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
823 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
824 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
825 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
826 -
827 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
828 -
829 -(% class="box successmessage" %)
830 -(((
831 -(% lang="en-US" %)**POST /api/v3/models**
832 -)))
833 -
834 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
835 -
836 -(% style="color:#000000" %)Метод запроса: **POST**
837 -
838 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
839 -
840 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
841 -
842 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
843 -
844 -{
845 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 - "deleted": true,
848 - "extId": "string",
849 - "name": "string",
850 - "picture": "string",
851 - "minspeed": 0,
852 - "maxspeed": 0,
853 - "width": 0,
854 - "imbeddedtrailer": true,
855 - "fueloutlay": 0,
856 - "hoppercapacity": 0,
857 - "hopperdischargespeed": 0,
858 - "modelType": 0
859 -}
860 -
861 861  Ответ:
862 862  
863 863  {
864 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
866 - "deleted": true,
867 - "extId": "string",
868 - "name": "string",
869 - "picture": "string",
870 - "minspeed": 0,
871 - "maxspeed": 0,
872 - "width": 0,
873 - "imbeddedtrailer": true,
874 - "hoppercapacity": 0,
875 - "hopperdischargespeed": 0,
876 - "modelType": 0
877 -}
878 878  
879 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
880 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
881 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
882 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
883 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
884 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
885 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
886 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
887 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
888 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
889 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
890 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
891 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
892 -
893 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
894 -
895 -(% class="box warningmessage" %)
896 -(((
897 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
898 -)))
899 -
900 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
901 -
902 -(% style="color:#000000" %)Метод запроса: **PUT**
903 -
904 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
905 -
906 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
907 -
908 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
909 -
910 -{
911 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
912 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
913 - "deleted": true,
914 - "extId": "string",
915 - "name": "string",
916 - "picture": "string",
917 - "minspeed": 0,
918 - "maxspeed": 0,
919 - "width": 0,
920 - "imbeddedtrailer": true,
921 - "fueloutlay": 0,
922 - "hoppercapacity": 0,
923 - "hopperdischargespeed": 0,
924 - "modelType": 0
925 -}
926 -
927 -Ответ:
928 -
929 -{
930 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
932 - "deleted": true,
933 - "extId": "string",
934 - "name": "string",
935 - "picture": "string",
936 - "minspeed": 0,
937 - "maxspeed": 0,
938 - "width": 0,
939 - "imbeddedtrailer": true,
940 - "fueloutlay": 0,
941 - "hoppercapacity": 0,
942 - "hopperdischargespeed": 0,
943 - "modelType": 0
944 -}
945 -
946 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
947 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
948 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
949 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
950 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
951 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
952 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
953 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
954 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
955 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
956 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
957 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
958 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
959 -
960 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
961 -
962 -(% class="box errormessage" %)
963 -(((
964 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
965 -)))
966 -
967 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
968 -
969 -(% style="color:#000000" %)Метод запроса: **DELETE**
970 -
971 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
972 -
973 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
974 -
975 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
976 -
977 -Ответ: В случае успеха **Success 200**
978 -
979 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
980 -
981 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
982 -
983 -(% class="box infomessage" %)
984 -(((
985 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
986 -)))
987 -
988 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
989 -
990 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
991 -
992 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
993 -
994 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
995 -
996 -(% style="color:#000000" %)Метод запроса: **GET**
997 -
998 -(% 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}
999 -
1000 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1001 -
1002 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1003 -
1004 -(% style="color:#000000" %)Ответ:
1005 -
1006 -(((
1007 -{
1008 - "vehicleId": "", ~/~/ ID объекта
1009 - "name": "", ~/~/ Имя объекта
1010 - "imei": "", ~/~/ IMEI объекта
1011 - "deviceTypeId": , ~/~/ ID типа устройства
1012 - "deviceTypeName": "", ~/~/ Название типа устройства
1013 - "sim1": "", ~/~/ Номер SIM1
1014 - "sim2": "", ~/~/ Номер SIM2
1015 - "parentId": "", ~/~/ ID клиента-родителя
1016 - "parentName": "", ~/~/ Наименование клиента-родителя
1017 - "modelId": "", ~/~/ ID модели объекта
1018 - "modelName": "", ~/~/ Имя модели объекта
1019 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1020 - "unitName": "string", ~/~/ Наименование подразделения
1021 - "status": 0, ~/~/ Статус объекта
1022 - "createdAt": "", ~/~/ Дата создания объекта
1023 - },
1024 -"customFields": [ ~/~/ Произвольные поля
1025 - {
1026 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1027 - "name": "string", ~/~/ Имя поля
1028 - "value": "string", ~/~/ Значение поля
1029 - "forClient": true, ~/~/ Не используемая функция
1030 - "forTooltip": true, ~/~/ Отображать в подсказке
1031 - "forReport": true ~/~/ Отображать в отчете
1032 - }
1033 -
1034 -], ~/~/ Данные с вкладки нормы
1035 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1036 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1037 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1038 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1039 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1040 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1041 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1042 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1043 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1044 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1045 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1046 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1047 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1048 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1049 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1050 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1051 - "counters": { ~/~/ Счетчики
1052 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1053 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1054 - "mileage": 0, ~/~/ Текущий пробег
1055 - "motohours": 0, ~/~/ Текущие моточасы
1056 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1057 - "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 + ...
1058 1058   },
216 + ...}}}
1059 1059  
1060 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1061 - "id": "string", ~/~/ ID объекта
1062 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1063 - "host": "string", ~/~/ CMSV6 Web Host
1064 - "login": "string", ~/~/ CMSV6 Account
1065 - "password": "string" ~/~/ CMSV6 Password
1066 - },
1067 -
1068 -"commandTemplates": [ ~/~/ Шаблоны команд
1069 - {
1070 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1071 - "name": "string", ~/~/ Наименование команды
1072 - "command": "string", ~/~/ Текст команды
1073 - "retries": 0 ~/~/ Количество попыток
1074 - }
1075 - ],
1076 - "sensors": [ ~/~/ Датчики
1077 - {
1078 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1079 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1080 - "type": 0, ~/~/ Тип датчика
1081 - "name": "string", ~/~/ Имя датчика
1082 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1083 - "inputNumber": 0, ~/~/ Номер входа
1084 - "pseudonym": "string", ~/~/ Псевдоним
1085 - "medianDegree": 0, ~/~/ Медианная фильтрация
1086 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1087 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1088 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1089 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1090 - {
1091 - "grades": [ ~/~/ Таблица тарировки 1
1092 - {
1093 - "input": 0, ~/~/ Входящее значение
1094 - "output": 0 ~/~/ Выходящее значение
1095 - }
1096 - ],
1097 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1098 - }
1099 - ],
1100 - "showInTooltip": true, ~/~/ Отображать в подсказке
1101 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1102 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1103 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1104 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1105 - "expr": "string", ~/~/ Формула
1106 - "children": [ ~/~/ массив дочерних датчиков
1107 - "string"
1108 - ],
1109 - "customParams": { ~/~/ прочие произвольные параметры
1110 - "additionalProp1": "string",
1111 - "additionalProp2": "string",
1112 - "additionalProp3": "string"
1113 - },
1114 -
1115 -~/~/ Характерные для произвольного:
1116 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1117 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1118 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1119 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1120 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1121 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1122 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1123 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1124 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1125 -~/~/ "ValueOn": "Вкл.",
1126 -~/~/ "ValueOff": "Выкл."
1127 - "summaryMaxValue": 0 ~/~/ Макс. значение
1128 - }
1129 - "drivers": [ ~/~/ Водители
1130 - {
1131 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1132 - "name": "string", ~/~/ Наименование
1133 - "description": "string",
1134 - "isDefault": true ~/~/ По умолчанию
1135 - }
1136 - ],
1137 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1138 - {
1139 - "id": "", ~/~/ ID  задания
1140 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1141 - "name": "", ~/~/ Наименование задания
1142 - "description": "", ~/~/ Описание задания
1143 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1144 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1145 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1146 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1147 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1148 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1149 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1150 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1151 - }
1152 - ],
1153 -"statusHistory": [ ~/~/ История статусов
1154 - {
1155 - "status": 0,
1156 - "date": "2023-05-22T09:57:39.562Z",
1157 - "description": "string",
1158 - "additionalInfo": "string"
1159 - }
1160 - ]
1161 1161  }
1162 -)))
1163 1163  
1164 -(% style="text-align:left" %)
1165 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
1166 1166  
1167 -(% style="text-align:left" %)
1168 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
223 + **Добавление пользователя**
1169 1169  
225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1170 1170  
1171 -== **Отправить команду на терминал** ==
227 +Метод запроса: POST
1172 1172  
1173 -(% class="box successmessage" %)
1174 -(((
1175 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1176 -)))
229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1177 1177  
1178 -Команда для отправки на тс.
231 +В заголовках запроса: X-Auth: Токен авторизации
1179 1179  
1180 -{  
1181 -"id": "", ~/~/идентификатор произвольного поля
1182 -"command": "", ~/~/ Текст команды
1183 -"retries": "", ~/~/ Количество попыток
1184 -"idTemplate": "" ~/~/ ID шаблона команды
1185 -}
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»: [ // группы пользователя «», //названия групп «», «» ] }
1186 1186  
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 +
1187 1187  
1188 -== **Получить ответ на отправленную на ТС команду** ==
238 + **Редактирование пользователя**
1189 1189  
1190 -(% class="box infomessage" %)
1191 -(((
1192 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1193 -)))
240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1194 1194  
1195 -Идентификатор команды: cmdid
242 +Метод запроса: PUT
1196 1196  
1197 -Запрос от терминала на ответ команды
244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1198 1198  
1199 -Пример ответ от терминала:
246 +В заголовках запроса: X-Auth: Токен авторизации
1200 1200  
1201 -ID= "" ~/~/ идентификатор произвольного поля
1202 -Soft="" ~/~/ версия софта
1203 -GPS=4 ~/~/ тип трекера
1204 -Time=11:05:43 28.06.24 ~/~/ время запроса
1205 -Lat=45.056221 ~/~/ широта
1206 -Lon=39.035938 ~/~/ долгота
1207 -Speed=0.0 ~/~/ скорость
1208 -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 - блокирован)
1209 1209  
1210 -(((
1211 -== **Список отправленных объекту команд с ответами** ==
250 +{{{ "description": "", // описание
251 + "data": "" // данные, связанные со сменой статуса}}}
1212 1212  
1213 -(% class="box infomessage" %)
1214 -(((
1215 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1216 -)))
1217 -
1218 -Идентификатор ТС: vehicleId
1219 -
1220 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1221 -
1222 -Пример ответа терминала
1223 -
1224 -[ 
1225 -{    
1226 -"id": "", ~/~/ идентификатор пользователя
1227 -"commandText": "", ~/~/Текст команды.
1228 -"templateId": "", ~/~/Идентификатор шаблона
1229 -"updated": "", ~/~/ Время отправки  
1230 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1231 -"answer": "", ~/~/ Ответ терминала.
1232 -"status": "" ~/~/ Статус отправки
1233 1233  }
1234 -]
1235 -)))
1236 1236  
1237 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
1238 1238  
1239 -(% class="box successmessage" %)
1240 -(((
1241 -(% lang="en-US" %)**POST /api/v3/vehicles**
1242 -)))
258 + **Удаление пользователя**
1243 1243  
1244 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1245 1245  
1246 -(% style="color:#000000" %)Метод запроса: **POST**
262 +Метод запроса: DELETE
1247 1247  
1248 -(% 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}
1249 1249  
1250 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1251 1251  
1252 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
1253 1253  
1254 -(% style="color:#000000" %){(%%)
1255 - "parentId": "" , ~/~/ ID клиента
1256 - "name": "" , ~/~/ имя ТС
1257 - "imei": "" , ~/~/ IMEI
1258 - "deviceTypeId": "" , ~/~/ ID типа устройства
1259 - "modelId": "" , ~/~/ ID модели
1260 - "unitId": "" , ~/~/ ID подразделения
1261 - "sim1": "" , ~/~/ Номер SIM 1
1262 - "sim2": "" , ~/~/ Номер SIM2
1263 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1264 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1265 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1266 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1267 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1268 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1269 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1270 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1271 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1272 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1273 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1274 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1275 - "mileageCalcMethod": 0,
1276 - "mileageCoeff": 0,
1277 - "locationByCellId": true,
1278 - "dottedLineTrackWhenNoCoords": true,
1279 - "counters": ~/~/ счетчики
1280 - {
1281 - "mileage": "" , ~/~/ пробег
1282 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1283 - "motohours": "" , ~/~/ моточасы
1284 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1285 - },
1286 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1287 - "enabled": true, ~/~/ флаг включения
1288 - "id": "" , ~/~/ идентификатор
1289 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1290 - "login": "" , ~/~/ имя учетной записи
1291 - "password": "" ~/~/ пароль учетной записи
1292 - },
1293 - "inspectionTasks": ~/~/ задания на ТО
1294 - {
1295 - "enabled": "" , ~/~/ Признак включения
1296 - "name": "" , ~/~/ Имя задания
1297 - "description": "" , ~/~/ Описание задания
1298 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1299 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1300 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1301 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1302 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1303 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1304 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1305 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1306 - }
1307 -"drivers": [ ~/~/ Водители
1308 - {
1309 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1310 - "isDefault": true
1311 - }
1312 - ],
1313 - "commandTemplates": [ ~/~/ Шаблон команды
1314 - {
1315 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1316 - "name": "string",
1317 - "command": "string",
1318 - "retries": 0
1319 - }
1320 - ],
1321 -"sensors": [ ~/~/ Датчики
1322 - {
1323 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1324 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1325 - "type": 0, ~/~/ Тип датчика
1326 - "name": "string", ~/~/ Имя датчика
1327 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1328 - "inputNumber": 0, ~/~/ Номер входа
1329 - "pseudonym": "string", ~/~/ Псевдоним
1330 - "medianDegree": 0, ~/~/ Медианная фильтрация
1331 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1332 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1333 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1334 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1335 - {
1336 - "grades": [ ~/~/ Таблица тарировки 1
1337 - {
1338 - "input": 0, ~/~/ Входящее значение
1339 - "output": 0 ~/~/ Выходящее значение
1340 - }
1341 - ],
1342 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1343 - }
1344 - ],
1345 - "showInTooltip": true, ~/~/ Отображать в подсказке
1346 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1347 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1348 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1349 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1350 - "expr": "string", ~/~/ Формула
1351 - "children": [ ~/~/ массив дочерних датчиков
1352 - "string"
1353 - ],
1354 - "customParams": { ~/~/ прочие произвольные параметры
1355 - "additionalProp1": "string",
1356 - "additionalProp2": "string",
1357 - "additionalProp3": "string"
1358 - },
1359 -~/~/ Характерные для произвольного:
1360 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1361 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1362 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1363 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1364 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1365 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1366 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1367 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1368 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1369 -~/~/ "ValueOn": "Вкл.",
1370 -~/~/ "ValueOff": "Выкл."
1371 - "summaryMaxValue": 0 ~/~/ Макс. значение
1372 - }
1373 - ],
1374 - "customFields": [ ~/~/ Произвольные поля
1375 - {
1376 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1377 - "name": "string",
1378 - "value": "string",
1379 - "forClient": true,
1380 - "forTooltip": true,
1381 - "forReport": true
1382 - }
1383 - ]
1384 -}
271 + **Добавление объекта**
1385 1385  
1386 -(% style="color:#000000" %)Ответ:
273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1387 1387  
1388 -(% style="color:#000000" %){(%%)
1389 - "vehicleId": "", ~/~/ID ТС 
1390 - "parentId": "", ~/~/Guid владельца ТС
1391 - "name": "", ~/~/Имя объекта
1392 - "imei": "", ~/~/IMEI
1393 - "deviceTypeId": "", ~/~/ID типа устройства
1394 - "modelId": "", ~/~/ID модели
1395 - "unitId": "", ~/~/ID подразделения
1396 - "sim1": "", ~/~/SIM1
1397 - "sim2": "", ~/~/SIM2
1398 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1399 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1400 - "counters": { ~/~/Счётчики
1401 - "mileageEnabled": true,
1402 - "motohoursEnabled": true,
1403 - "mileage": "",
1404 - "motohours": 345.0
1405 - },
1406 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1407 - "id": null,
1408 - "enabled": true, ~/~/флаг включения
1409 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1410 - "login": "", ~/~/ имя учетной записи
1411 - "password": "" ~/~/ пароль учетной записи
1412 - },
1413 - "inspectionTasks": { ~/~/ задания на ТО
1414 - "id": "", ~/~/ ID задачи
1415 - "enabled": false, ~/~/ Признак включения
1416 - "name": "", ~/~/ Имя задания
1417 - "description": "", ~/~/ Описание задания
1418 - "mileageCondition": "", ~/~/ Условие по пробегу
1419 - "lastMileage": "", ~/~/ Пробег (в метрах)
1420 - "motohoursCondition": "", ~/~/ Условие по моточасам
1421 - "lastMotohours": "", ~/~/ Моточасы
1422 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1423 - "kind": "", ~/~/ Вид периодичности по времени 
1424 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1425 - }
1426 -(% style="color:#000000" %)}
275 +Метод запроса: POST
1427 1427  
1428 -**Валидация:**
1429 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1430 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1431 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1432 1432  
1433 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
279 +В заголовках запроса: X-Auth: Токен авторизации
1434 1434  
1435 -(% class="box infomessage" %)
1436 -(((
1437 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
1438 -)))
281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1439 1439  
1440 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1441 -
1442 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1443 -
1444 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1445 -
1446 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1447 -
1448 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1449 -
1450 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1451 -
1452 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1453 -
1454 -(% style="color:#000000" %)Метод запроса: **POST**
1455 -
1456 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1457 -
1458 -(% style="color:#000000" %)В заголовках запроса:
1459 -
1460 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1461 -
1462 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1463 -
1464 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1465 -
1466 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1467 -
1468 -{
1469 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1470 - "name": null, ~/~/ Имя ТС (string, опционально)
1471 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1472 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1473 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1474 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1475 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1476 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1477 -}
1478 -
1479 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1480 -
1481 -(% style="color:#000000" %)Ответ:
1482 -
1483 -(% style="color:#000000" %){
1484 - "vehicleId": "" ~/~/ идентификатор объекта
1485 - "name": "" ~/~/ наименование объекта
1486 - "imei": "" ~/~/ IMEI объекта
1487 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1488 - "deviceTypeName": "" ~/~/ наименование типа устройства
1489 - "sim1": "" ~/~/ первый номер телефона
1490 - "sim2": "" ~/~/ второй номер телефона
1491 - "parentId": "" ~/~/ идентификатор клиента-родителя
1492 - "parentName": "" ~/~/ наименование клиента-родителя
1493 - "modelId": "" ~/~/ идентификатор модели объекта
1494 - "modelName": "" ~/~/ наименование модели объекта
1495 - "unitId": "" ~/~/ идентификатор подразделения
1496 - "unitName": "" ~/~/ наименование подразделения
1497 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1498 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1499 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1500 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1501 - "customFields": [ 
1502 - {
1503 - "id": "", ~/~/ идентификатор произвольного поля
1504 - "name": "", ~/~/ имя произвольного поля
1505 - "value": "", ~/~/ значение произвольного поля
1506 - "forClient": true, ~/~/ право на отображение у клиента
1507 - "forTooltip": false, ~/~/ право на отображение в подсказке
1508 - "forReport": false ~/~/ право на отображение в отчетах
1509 - }(%%)
1510 -(% style="color:#000000" %)}
1511 -
1512 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1513 -
1514 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1515 -
1516 -(% class="box successmessage" %)
1517 -(((
1518 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1519 -)))
1520 -
1521 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1522 -
1523 -(% style="color:#000000" %)Метод запроса: **POST**
1524 -
1525 -(% 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}
1526 -
1527 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1528 -
1529 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1530 -
1531 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1532 -
1533 -(% style="color:#000000" %){
1534 -
1535 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1536 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1537 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1538 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1539 - "description": "", ~/~/ Описание
1540 - "data": "", ~/~/ Данные
1541 - "overwrite": false, ~/~/ Флаг перезаписи
1542 - "stage": "", ~/~/ Состояние, может быть null
1543 -(% style="color:#000000" %)}
1544 -
1545 -(% style="color:#000000" %)Ответ:
1546 -
1547 -(% style="color:#000000" %){(%%)
1548 - "status": "", ~/~/ значение статуса
1549 - "date": "", ~/~/ Дата смены статуса 
1550 - "description": "", ~/~/ Описание
1551 - "data": "", ~/~/ Данные
1552 - "overwrite": false, ~/~/ Флаг перезаписи
1553 - "stage": "", ~/~/ Состояние
1554 -(% style="color:#000000" %) }
1555 -
1556 -== ==
1557 -
1558 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1559 -
1560 -(% class="box warningmessage" %)
1561 -(((
1562 -(% lang="en-US" %)**PUT /api/v3/vehicles**
1563 -)))
1564 -
1565 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1566 -
1567 -(% style="color:#000000" %)Метод запроса: **PUT**
1568 -
1569 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1570 -
1571 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1572 -
1573 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1574 -
1575 -(% style="color:#000000" %){
1576 - "vehicleId": , ~/~/ ID объекта
1577 - "parentId": "" , ~/~/ ID клиента
1578 - "name": "" , ~/~/ имя ТС
1579 - "imei": "" , ~/~/ IMEI
1580 - "deviceTypeId": "" , ~/~/ ID типа устройства
1581 - "modelId": "" , ~/~/ ID модели
1582 - "unitId": "" , ~/~/ ID подразделения
1583 - "sim1": "" , ~/~/ Номер SIM 1
1584 - "sim2": "" , ~/~/ Номер SIM2
1585 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1586 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1587 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1588 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1589 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1590 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1591 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1592 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1593 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1594 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1595 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1596 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1597 -
1598 - "mileageCalcMethod": 0,
1599 - "mileageCoeff": 0,
1600 - "locationByCellId": true,
1601 - "dottedLineTrackWhenNoCoords": true,
1602 - "counters": ~/~/ счетчики
1603 - {
1604 - "mileage": "" , ~/~/ пробег
1605 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1606 - "motohours": "" , ~/~/ моточасы
1607 - "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": "" // пароль учетной записи
1608 1608   },
1609 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1610 - "enabled": true, ~/~/ флаг включения
1611 - "id": "" , ~/~/ идентификатор
1612 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1613 - "login": "" , ~/~/ имя учетной записи
1614 - "password": "" ~/~/ пароль учетной записи
1615 - },
1616 - "inspectionTasks": ~/~/ задания на ТО
307 + "inspectionTasks": [ // задания на ТО
1617 1617   {
1618 - "enabled": "" , ~/~/ Признак включения
1619 - "name": "" , ~/~/ Имя задания
1620 - "description": "" , ~/~/ Описание задания
1621 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1622 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1623 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1624 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1625 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1626 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1627 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1628 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1629 - }
1630 -
1631 -"drivers": [ ~/~/ Водители
1632 - {
1633 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1634 - "isDefault": true
1635 - }
1636 - ],
1637 - "commandTemplates": [ ~/~/ Шаблон команды
1638 - {
1639 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1640 - "name": "string",
1641 - "command": "string",
1642 - "retries": 0
1643 - }
1644 - ],
1645 -"sensors": [ ~/~/ Датчики
1646 - {
1647 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1648 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1649 - "type": 0, ~/~/ Тип датчика
1650 - "name": "string", ~/~/ Имя датчика
1651 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1652 - "inputNumber": 0, ~/~/ Номер входа
1653 - "pseudonym": "string", ~/~/ Псевдоним
1654 - "medianDegree": 0, ~/~/ Медианная фильтрация
1655 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1656 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1657 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1658 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1659 - {
1660 - "grades": [ ~/~/ Таблица тарировки 1
1661 - {
1662 - "input": 0, ~/~/ Входящее значение
1663 - "output": 0 ~/~/ Выходящее значение
1664 - }
1665 - ],
1666 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1667 - }
1668 - ],
1669 - "showInTooltip": true, ~/~/ Отображать в подсказке
1670 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1671 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1672 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1673 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1674 - "expr": "string", ~/~/ Формула
1675 - "children": [ ~/~/ массив дочерних датчиков
1676 - "string"
1677 - ],
1678 - "customParams": { ~/~/ прочие произвольные параметры
1679 - "additionalProp1": "string",
1680 - "additionalProp2": "string",
1681 - "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 - однократно)
1682 1682   },
1683 -~/~/ Характерные для произвольного:
1684 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1685 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1686 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1687 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1688 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1689 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1690 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1691 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1692 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1693 -~/~/ "ValueOn": "Вкл.",
1694 -~/~/ "ValueOff": "Выкл."
1695 - "summaryMaxValue": 0 ~/~/ Макс. значение
1696 - }
1697 - ],
1698 - "customFields": [ ~/~/ Произвольные поля
1699 - {
1700 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1701 - "name": "string",
1702 - "value": "string",
1703 - "forClient": true,
1704 - "forTooltip": true,
1705 - "forReport": true
1706 - }
1707 - ]
1708 -}
321 + ]}}}
1709 1709  
1710 -(% style="color:#000000" %)Ответ:
323 +… }
1711 1711  
1712 -(% lang="en-US" style="text-align:left" %)
1713 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1714 - "vehicleId": "", ~/~/ ID ТС
1715 - "parentId": "", ~/~/ ID клиента
1716 - "name": "", ~/~/ имя ТС
1717 - "imei": "", ~/~/ IMEI
1718 - "deviceTypeId": "", ~/~/ типа устройства
1719 - "modelId": "", ~/~/ ID модели
1720 - "unitId": "", ~/~/ ID подразделения
1721 - "sim1": "", ~/~/ SIM 1
1722 - "sim2": "", ~/~/ SIM2
1723 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1724 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1725 - "counters": 
1726 - {
1727 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1728 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1729 - "mileage": "", ~/~/ пробег
1730 - "motohours": "", ~/~/ моточасы
1731 - }
1732 - "cmsv6Parameters": ~/~/ параметры CMSv6
1733 - {
1734 - "id": ~/~/ идентификатор
1735 - "enabled": true, ~/~/ флаг включения
1736 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1737 - "login": "", ~/~/ имя учетной записи
1738 - "password": "", ~/~/ пароль учетной записи
1739 - }
1740 - "inspectionTasks": ~/~/ задания на ТО
1741 - {
1742 - "id": "", ~/~/ ID задания
1743 - "enabled": false, ~/~/ Признак включения
1744 - "name": "", ~/~/ Имя задания
1745 - "description": "", ~/~/ Описание задания
1746 - "mileageCondition": "", ~/~/ Условие по пробегу
1747 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1748 - "motohoursCondition": "", ~/~/ Условие по моточасам
1749 - "lastMotohours": "", ~/~/ Моточасы
1750 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1751 - "kind": "", ~/~/ Вид периодичности по времени
1752 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1753 - }
1754 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1755 -
1756 -**Валидация:**
1757 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1758 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1759 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1760 -
1761 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1762 -
1763 -(% class="box errormessage" %)
1764 -(((
1765 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1766 -)))
1767 -
1768 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1769 -
1770 -(% style="color:#000000" %)Метод запроса: **DELETE**
1771 -
1772 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1773 -
1774 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1775 -
1776 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1777 -
1778 -(% style="text-align:left" %)
1779 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1780 -
1781 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1782 -
1783 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1784 -
1785 -(% class="box infomessage" %)
1786 -(((
1787 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1788 -)))
1789 -
1790 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1791 -
1792 -(% style="color:#000000" %)Метод запроса: **GET**
1793 -
1794 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1795 -
1796 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1797 -
1798 -(% style="color:#000000" %)Ответ:
1799 -
1800 -(% style="color:#000000" %){(%%)
1801 - "deviceTypeId" : "", ~/~/ ID типа устройства
1802 - "deviceTypeName" : "" ~/~/ Название типа устройства
1803 -(% style="color:#000000" %)}
1804 -
1805 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1806 -
1807 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1808 -
1809 -(% class="box infomessage" %)
1810 -(((
1811 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1812 -)))
1813 -
1814 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1815 -
1816 -(% style="color:#000000" %)Метод запроса: **GET**
1817 -
1818 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1819 -
1820 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1821 -
1822 -(% style="color:#000000" %)Ответ:
1823 -
1824 -(% style="color:#000000" %){(%%)
1825 - "id": "", ~/~/ ID типа датчика 
1826 - "name": "", ~/~/ Название
1827 - "description": "", ~/~/ Описание
1828 -(% style="color:#000000" %)}
1829 -
1830 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1831 -
1832 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1833 -
1834 -(% class="box infomessage" style="text-align: left;" %)
1835 -(((
1836 -**POST /api/v3/terminalMessages/count**
1837 -)))
1838 -
1839 -(% style="text-align: left;" %)
1840 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1841 -
1842 -(% style="text-align: left;" %)
1843 -Метод запроса **POST**
1844 -
1845 -(% style="text-align: left;" %)
1846 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1847 -
1848 -(% style="text-align: left;" %)
1849 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1850 -
1851 -(% style="text-align: left;" %)
1852 -{
1853 - "vehicleIds": [
1854 - id ~/~/ здесь передается список идентификаторов объектов
1855 - ],
1856 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1857 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1858 -}
1859 -
1860 -(% style="text-align: left;" %)
1861 1861  Ответ:
1862 1862  
1863 -(% style="text-align: left;" %)
1864 -[
1865 - {
1866 - "vehicleId": 0, ~/~/ идентификатор объекта
1867 - "count": 0 ~/~/ количество сообщений за период
1868 - }
1869 -]
1870 -
1871 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1872 -
1873 -(% class="box infomessage" style="text-align: left;" %)
1874 -(((
1875 -**POST /api/v3/terminalMessages/mapping**
1876 -)))
1877 -
1878 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1879 -
1880 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1881 -
1882 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1883 -
1884 1884  {
1885 - "protocolType": 0,
1886 - "params": ["string"]
1887 -}
1888 1888  
1889 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1890 -|protocolType|ID типа протокола
1891 -|params|(((
1892 -Массив наименований параметров в сообщении
1893 -)))
1894 -
1895 -Ответ:
1896 -
1897 -{
1898 - "protocolType": 0,
1899 - "mapping": {
1900 - "additionalProp1": {
1901 - "inputType": 0,
1902 - "inputNumber": 0
1903 - },
1904 - "additionalProp2": {
1905 - "inputType": 0,
1906 - "inputNumber": 0
1907 - }
1908 - }
1909 -}
1910 -
1911 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1912 -|protocolType|Тип протокола
1913 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1914 -|inputNumber|(((
1915 -Номер входа
1916 -)))
1917 -
1918 -(% class="wikigeneratedid" %)
1919 -Перечень 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/]]
1920 -
1921 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1922 -
1923 -(% class="box infomessage" %)
1924 -(((
1925 -**POST /api/v3/terminalMessages**
1926 -)))
1927 -
1928 -Метод возвращает список сообщений терминала объекта за выбранный период.
1929 -
1930 -(% style="text-align: left;" %)
1931 -Метод запроса **POST**
1932 -
1933 -(% style="text-align: left;" %)
1934 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1935 -
1936 -(% style="text-align: left;" %)
1937 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1938 -
1939 -{
1940 - "vehicleId": 0, ~/~/ id объекта
1941 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1942 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1943 -}
1944 -
1945 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1946 -|vehicleId|ID объекта
1947 -|from|Дата и время начала периода запроса
1948 -|to|Дата и время окончания периода запроса
1949 -
1950 -Ответ:
1951 -
1952 -[
1953 - {
1954 - "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": [ // задания на ТО
1955 1955   {
1956 - "deviceTime": "2023-11-29T07:40:44.052Z",
1957 - "serverTime": "2023-11-29T07:40:44.052Z",
1958 - "speed": 0,
1959 - "altitude": 0,
1960 - "latitude": 0,
1961 - "longitude": 0,
1962 - "satellites": 0,
1963 - "course": 0,
1964 - "voltage": 0,
1965 - "parameters": {
1966 - "additionalProp1": "string",
1967 - "additionalProp2": "string",
1968 - "additionalProp3": "string"
1969 - },
1970 - "photoCount": 0,
1971 - "lbsCorrectedCoords": true,
1972 - "protocolType": 0
1973 - }
1974 - ]
1975 - }
1976 -]
355 + "id": "", // ID задачи
356 + "enabled": false, // Признак включения
357 + "name": "", // Имя задания
358 + "description": "", // Описание задания
359 + "mileageCondition": "", // Условие по пробегу
360 + "lastMileage": "", // Пробег (в метрах)
361 + "motohoursCondition": "", // Условие по моточасам
362 + "lastMotohours": "", // Моточасы
363 + "periodicCondition": "", // Условие периодичности по времени}}}
1977 1977  
1978 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1979 -|deviceTime|Время сообщения терминала
1980 -|serverTime|Время когда сообщение поступило на сервер
1981 -|speed|Скорость
1982 -|altitude|Высота над уровнем моря
1983 -|latitude|Широта
1984 -|longitude|Долгота
1985 -|satellites|Кол-во спутников
1986 -|course|Курс
1987 -|voltage|Бортовое напряжение
1988 -|parameters|Список параметров и их значений
1989 -|photoCount|Количество фото
1990 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1991 -|protocolType|ID типа протокола
1992 -
1993 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1994 -
1995 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1996 -
1997 -(% class="box infomessage" %)
1998 -(((
1999 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2000 -)))
2001 -
2002 -(% style="color:#000000" %)Метод запроса: **POST**
2003 -
2004 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2005 -
2006 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2007 -
2008 -(% style="text-align:left" %)
2009 -Тело запроса:
2010 -
2011 -{
2012 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2013 - "vehicleIds": [0], ~/~/ Список ID объектов
2014 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2015 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2016 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2017 -}
2018 -
2019 -Ответ:
2020 -
2021 -[
2022 - {
2023 - "vehicleId": 0, ~/~/ ID объекта
2024 - "name": "string", ~/~/ Имя ТС
2025 - "periods": [ ~/~/ Периоды
2026 - {
2027 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2028 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2029 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2030 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2031 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2032 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
365 +{{{ "kind": "", // Вид периодичности по времени
366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
2033 2033   }
2034 - ]
2035 - }
2036 -]
368 + ]}}}
2037 2037  
2038 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2039 -
2040 -(% class="box infomessage" %)
2041 -(((
2042 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2043 -)))
2044 -
2045 -(% style="color:#000000" %)Метод запроса: **POST**
2046 -
2047 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2048 -
2049 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2050 -
2051 -(% style="text-align:left" %)
2052 -Тело запроса:
2053 -
2054 -{
2055 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2056 - "vehicleIds": [0], ~/~/ Список ID объектов
2057 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2058 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2059 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2060 2060  }
371 +
2061 2061  
2062 -Ответ:
373 + **Удаление объекта**
2063 2063  
2064 -[
2065 - {
2066 - "vehicleId": 0, ~/~/ ID объекта
2067 - "name": "string", ~/~/ Имя ТС
2068 - "periods": [ ~/~/ Периоды
2069 - {
2070 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2071 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2072 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2073 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2074 - "fuelConsumption": 0, ~/~/ Расход топлива
2075 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2076 - }
2077 - ]
2078 - }
2079 -]
375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2080 2080  
2081 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
377 +Метод запроса: DELETE
2082 2082  
2083 -(% class="box infomessage" %)
2084 -(((
2085 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2086 -)))
379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
2087 2087  
2088 -(% style="color:#000000" %)Метод запроса: **POST**
381 +Параметр запроса: {id} - Guid объекта
2089 2089  
2090 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2091 -
2092 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2093 -
2094 -(% style="text-align:left" %)
2095 -Тело запроса:
2096 -
2097 -{
2098 - "vehicleIds": [0], ~/~/ Список ID объектов
2099 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2100 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2101 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2102 -}
2103 -
2104 -Ответ:
2105 -
2106 -[
2107 - {
2108 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2109 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2110 - "vehicleId": 0, ~/~/ ID объекта
2111 - "name": "string", ~/~/ Имя объекта
2112 - "model": "string", ~/~/ Модель объекта
2113 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2114 - {
2115 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2116 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2117 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2118 - "valueFuel": 0, ~/~/ Количество
2119 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2120 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2121 - }
2122 - ]
2123 - }
2124 -]
2125 -
2126 -
2127 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2128 -
2129 -(% class="box infomessage" %)
2130 -(((
2131 -**POST /api/v3/vehicles/moveStop**
2132 -)))
2133 -
2134 -Метод запроса: **POST**
2135 -
2136 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2137 -
2138 2138  В заголовках запроса: X-Auth: Токен авторизации
2139 2139  
385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
2140 2140  
2141 -Тело запроса:
388 + **Редактирование объекта**
2142 2142  
2143 -{
2144 - "vehicleIds": [ ], ~/~/ Список ID объектов
2145 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2146 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2147 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2148 -}
390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2149 2149  
2150 -Ответ:
392 +Метод запроса: PUT
2151 2151  
2152 -[ 
2153 - {
2154 - "vehicleId": 0, ~/~/ ID объекта
2155 - "vehicleName": "string", ~/~/ Имя объекта
2156 - "moves": [ ~/~/ Событие движения
2157 - {
2158 - "mileage": 0, ~/~/ Пробег, км
2159 - "eventId": 0, ~/~/ Идентификатор события
2160 - "eventName": "string", ~/~/ Название события
2161 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2162 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2163 - "duration": 0 ~/~/ Продолжительность события, секунд
2164 - }
2165 - ],
2166 - "stops": [ ~/~/ События стоянок
2167 - {
2168 - "address": "string", ~/~/ Адрес события
2169 - "eventId": 0, ~/~/ Идентификатор события
2170 - "eventName": "string", ~/~/ Название события
2171 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2172 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2173 - "duration": 0 ~/~/ Продолжительность события, секунд
2174 - }
2175 - ]
2176 - }
2177 -]
394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
2178 2178  
2179 -
2180 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2181 -
2182 -(% class="box infomessage" %)
2183 -(((
2184 -**POST /api/v3/vehicles/getlastdata**
2185 -)))
2186 -
2187 -Метод запроса: **POST**
2188 -
2189 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2190 -
2191 2191  В заголовках запроса: X-Auth: Токен авторизации
2192 2192  
398 +Параметры в теле запроса (JSON):
2193 2193  
2194 -В теле запроса перечисляете массив 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»: «» //Сколько раз выполнить задание } ] }
2195 2195  
2196 2196  Ответ:
2197 - {
2198 - "vehicleId": 0, ~/~/Идентификатор объекта.
2199 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2200 - "vehicleNumber": "string",~/~/Номер объекта.
2201 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2202 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2203 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2204 - "speed": 0,~/~/Скорость объекта.
2205 - "course": 0,~/~/Курс движения [0;360]
2206 - "latitude": 0,~/~/Широта [-90°;90°].
2207 - "longitude": 0,~/~/Долгота [-180°;180°].
2208 - "address": "string",~/~/Адрес.
2209 - "geozones": [ ~/~/Сведения по геозонам.
2210 - {
2211 - "id": 0,
2212 - "name": "string"
2213 - }
2214 -
2215 2215  
2216 -= (% 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 +
2217 2217  
2218 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
407 + **Изменение статуса объекта**
2219 2219  
2220 -(% class="box infomessage" %)
2221 -(((
2222 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2223 -)))
409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2224 2224  
2225 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
411 +Метод запроса: POST
2226 2226  
2227 -(% style="color:#000000" %)Метод запроса: **POST**
413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
2228 2228  
2229 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
415 +Параметр запроса: {vehicleId} - ID ТС
2230 2230  
2231 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2232 -
2233 -(% style="text-align:left" %)
2234 -Тело запроса:
2235 -
2236 -(% style="text-align:left" %)
2237 -{
2238 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2239 -}
2240 -
2241 -(% style="text-align:left" %)
2242 -Ответ:
2243 -
2244 -[
2245 - {
2246 - "id": 0, ~/~/ Идентификатор объекта геозоны
2247 - "name": "string", ~/~/ Название объекта геозоны
2248 - "type": 0, ~/~/ Тип объекта геозоны
2249 - "fname": "string", ~/~/ Имя файла
2250 - "parentId": "string", ~/~/ Идентификатор клиента
2251 - "radius": 0, ~/~/ Радиус геообъекта
2252 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2253 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2254 - "description": "string", ~/~/ Описание
2255 - "area": 0, ~/~/ Площадь, м^^2^^
2256 - "perimetr": 0, ~/~/ Периметр, м
2257 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2258 - }
2259 -]
2260 -
2261 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2262 -
2263 -(% class="box infomessage" %)
2264 -(((
2265 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2266 -)))
2267 -
2268 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2269 -
2270 -(% style="color:#000000" %)Метод запроса: **POST**
2271 -
2272 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2273 -
2274 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2275 -
2276 -(% style="text-align:left" %)
2277 -Тело запроса:
2278 -
2279 -{
2280 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2281 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2282 - "ids": [ ], ~/~/ Массив id объектов
2283 - "byTime": 0, ~/~/ Объединение событий по времени 
2284 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2285 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2286 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2287 -}
2288 -
2289 -Ответ:
2290 -[
2291 - {
2292 - "geozoneId": 0, ~/~/ ID геообъекта
2293 - "geozoneName": "string", ~/~/ Название геообъекта
2294 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2295 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2296 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2297 - "vehicleId": 0, ~/~/ ID объекта
2298 - "vehicleName": "string" ~/~/ Имя объекта
2299 - }
2300 -]
2301 -
2302 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2303 -
2304 -(% class="box infomessage" %)
2305 -(((
2306 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2307 -)))
2308 -
2309 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2310 -
2311 -(% style="color:#000000" %)Метод запроса: **POST**
2312 -
2313 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2314 -
2315 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2316 -
2317 -(% style="text-align:left" %)
2318 -Тело запроса:
2319 -
2320 -{
2321 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2322 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2323 - "ids": [ ], ~/~/ Массив id геообъектов
2324 - "byTime": 0, ~/~/ Объединение событий по времени 
2325 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2326 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2327 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2328 -}
2329 -
2330 -Ответ:
2331 -
2332 -[
2333 - {
2334 - "geozoneId": 0, ~/~/ ID геообъекта
2335 - "geozoneName": "string", ~/~/ Название геообъекта
2336 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2337 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2338 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2339 - "vehicleId": 0, ~/~/ ID объекта
2340 - "vehicleName": "string" ~/~/ Имя объекта
2341 - }
2342 -]
2343 -
2344 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2345 -
2346 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2347 -
2348 -(% class="box infomessage" %)
2349 -(((
2350 -**POST /api/v3/notifications/find**
2351 -)))
2352 -
2353 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2354 -
2355 -(% style="text-align: left;" %)
2356 -Метод запроса **POST**
2357 -
2358 -(% style="text-align: left;" %)
2359 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2360 -
2361 -(% style="text-align: left;" %)
2362 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2363 -
2364 -{
2365 - "parentId": "" ~/~/ id клиента
2366 -}
2367 -
2368 -Ответ:
2369 -
2370 -[
2371 - {
2372 - "id": 0, ~/~/ ID уведомления
2373 - "name": "string", ~/~/ Название уведомления
2374 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2375 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2376 - "userId": "", ~/~/ Пользователь, создавший уведомление
2377 - "parentId": "", ~/~/ Идентификатор клиента
2378 - "parentName": "string" ~/~/ Имя клиента
2379 - }
2380 -]
2381 -
2382 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2383 -
2384 -(% class="box infomessage" %)
2385 -(((
2386 -**GET /api/v3/notifications/{id}**
2387 -)))
2388 -
2389 -Метод возвращает данные правил формирования выбранного уведомления.
2390 -
2391 -(% style="text-align: left;" %)
2392 -Метод запроса **GET**
2393 -
2394 -(% style="text-align: left;" %)
2395 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2396 -
2397 -(% style="text-align: left;" %)
2398 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2399 -
2400 -(% style="text-align: left;" %)
2401 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2402 -
2403 -(% style="text-align: left;" %)
2404 -(% style="color:#000000" %)Ответ:
2405 -
2406 -(% style="text-align: left;" %)
2407 -(% style="color:#000000" %){
2408 - "id": 0, ~/~/ (%%)id уведомления
2409 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2410 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2411 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2412 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2413 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2414 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2415 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2416 -(% style="color:#000000" %) 0
2417 - ],
2418 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2419 -(% style="color:#000000" %) 0
2420 - ],
2421 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2422 -(% style="color:#000000" %) 0
2423 - ],
2424 - "settings": { ~/~/ Список параметров уведомления
2425 - "additionalProp1": "string",
2426 - "additionalProp2": "string",
2427 - "additionalProp3": "string"
2428 - },
2429 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2430 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2431 -(% style="color:#000000" %) ""
2432 - ],
2433 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2434 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2435 -(% style="color:#000000" %) "string"
2436 - ],
2437 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2438 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2439 -(% style="color:#000000" %) {
2440 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2441 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2442 -(% style="color:#000000" %) }
2443 - ],
2444 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2445 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2446 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2447 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2448 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2449 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2450 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2451 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2452 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2453 -(% style="color:#000000" %)}
2454 -
2455 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2456 -
2457 -(% class="box warningmessage" %)
2458 -(((
2459 -**PUT /api/v3/notifications/**
2460 -)))
2461 -
2462 -Метод позволяет отредактировать уведомление.
2463 -
2464 -Метод запроса **PUT**
2465 -
2466 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2467 -
2468 2468  В заголовках запроса: X-Auth: Токен авторизации
2469 2469  
2470 -Тело запроса:
2471 -{
2472 - "id": 0, ~/~/ id уведомления
2473 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2474 - "userId": "", ~/~/ Пользователь, создавший уведомление
2475 - "parentId": "", ~/~/ Идентификатор клиента
2476 - "parentName": "string", ~/~/ Имя клиента
2477 - "name": "string", ~/~/ Название уведомления
2478 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2479 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2480 - 0
2481 - ],
2482 - "geoids": [ ~/~/ Список id геообъектов для анализа
2483 - 0
2484 - ],
2485 - "fieldids": [ ~/~/ Список id полей для анализа
2486 - 0
2487 - ],
2488 - "settings": { ~/~/ Список параметров уведомления
2489 - "additionalProp1": "string",
2490 - "additionalProp2": "string",
2491 - "additionalProp3": "string"
2492 - },
2493 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2494 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2495 - ""
2496 - ],
2497 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2498 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2499 - "string"
2500 - ],
2501 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2502 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2503 - {
2504 - "id": 0, ~/~/ Идентификатор участника чата
2505 - "info": "string" ~/~/ Дополнительные сведения
2506 - }
2507 - ],
2508 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2509 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2510 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2511 - "kind": 0, ~/~/ Определяет вид уведомления
2512 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2513 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2514 - "timezone": 0, ~/~/ Сдвиг часового пояса
2515 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2516 - "autoProlongation": true ~/~/ Автопродление срока действия
2517 -}
419 +Параметры в теле запроса (JSON): {
2518 2518  
2519 -Ответ:
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}}}
2520 2520  
2521 -Success
2522 -
2523 -
2524 -== (% style="color:#000000; font-size:16px" %)**Продлить права с определённым идентификатором ids**(%%) ==
2525 -
2526 -(% class="box warningmessage" %)
2527 -(((
2528 -**PUT** /api/v3/notifications/prolongation
2529 -)))
2530 -
2531 -Метод позволяет продлить уведомления.
2532 -
2533 -Метод запроса **PUT**
2534 -
2535 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2536 -
2537 -В заголовках запроса: X-Auth: Токен авторизации
2538 -
2539 -
2540 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2541 -
2542 -(% class="box errormessage" %)
2543 -(((
2544 -**DELETE /api/v3/notifications/{id}**
2545 -)))
2546 -
2547 -Метод позволяет удалить выбранное уведомление.
2548 -
2549 -Метод запроса **DELETE**
2550 -
2551 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2552 -
2553 -Передаваемый параметр: {id} - id уведомления
2554 -
2555 -В заголовках запроса: X-Auth: Токен авторизации
2556 -
2557 -Ответ:
2558 -
2559 -Success
2560 -
2561 -
2562 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2563 -
2564 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2565 -
2566 -(% class="box infomessage" %)
2567 -(((
2568 -**POST /api/v3/Drivers/find**
2569 -)))
2570 -
2571 -Передается параметр: parentId - ID клиента-родителя
2572 -
2573 -Ответ:
2574 -
2575 -[
2576 - {
2577 - "name": "string", ~/~/ Определяет наименование
2578 - "description": "string", ~/~/ Определяет описание
2579 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2580 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2581 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2582 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2583 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2584 - "deleted": true ~/~/ Признак удаления
2585 - }
2586 -]
2587 -
2588 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2589 -
2590 -(% class="box infomessage" %)
2591 -(((
2592 -**GET /api/v3/Drivers/{driverGuid}**
2593 -)))
2594 -
2595 -Передается параметр: ID водителя
2596 -
2597 -Ответ:
2598 -
2599 -{
2600 - "name": "string", ~/~/ Определяет наименование
2601 - "description": "string", ~/~/ Определяет описание
2602 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2603 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2604 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2605 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2606 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2607 - "deleted": true ~/~/ Признак удаления
2608 2608  }
2609 2609  
2610 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
430 +Ответ: {
2611 2611  
2612 -(% class="box successmessage" %)
2613 -(((
2614 -**POST /api/v3/Drivers**
2615 -)))
432 +{{{ "status": "", // значение статуса
433 + "date": "", // Дата смены статуса
434 + "description": "", // Описание
435 + "data": "", // Данные
436 + "overwrite": false, // Флаг перезаписи
437 + "stage": "", // Состояние}}}
2616 2616  
2617 -Запрос:
2618 -
2619 -{
2620 - "name": "string",
2621 - "description": "string",
2622 - "hiredate": "2023-06-30T12:50:54.020Z",
2623 - "chopdate": "2023-06-30T12:50:54.020Z",
2624 - "exclusive": true,
2625 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2626 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2627 - "deleted": true
2628 2628  }
2629 -
2630 -Ответ:
2631 -
2632 -{
2633 - "name": "string",
2634 - "description": "string",
2635 - "hiredate": "2023-06-30T12:50:54.051Z",
2636 - "chopdate": "2023-06-30T12:50:54.051Z",
2637 - "exclusive": true,
2638 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2639 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2640 - "deleted": true
2641 -}
2642 -
2643 -
2644 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2645 -
2646 -(% class="box warningmessage" %)
2647 -(((
2648 -**PUT /api/v3/Drivers**
2649 -)))
2650 -
2651 -Запрос:
2652 -
2653 -{
2654 - "name": "string",
2655 - "description": "string",
2656 - "hiredate": "2023-06-30T12:50:27.910Z",
2657 - "chopdate": "2023-06-30T12:50:27.910Z",
2658 - "exclusive": true,
2659 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2660 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2661 - "deleted": true
2662 -}
2663 -
2664 -Ответ:
2665 -
2666 -{
2667 - "name": "string",
2668 - "description": "string",
2669 - "hiredate": "2023-06-30T12:50:27.929Z",
2670 - "chopdate": "2023-06-30T12:50:27.929Z",
2671 - "exclusive": true,
2672 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2673 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2674 - "deleted": true
2675 -}
2676 -
2677 -
2678 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2679 -
2680 -(% class="box errormessage" %)
2681 -(((
2682 -**DELETE /api/v3/Drivers/{driverGuid}**
2683 -)))
2684 -
2685 -Передается параметр: ID водителя
2686 -
2687 -Ответ:
2688 -
2689 -Success
2690 -
2691 -
2692 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2693 -
2694 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2695 -
2696 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2697 -
2698 -(% class="box infomessage" %)
2699 -(((
2700 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2701 -)))
2702 -
2703 -Запрос:
2704 -
2705 -{
2706 - "Ids": [
2707 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2708 - ],
2709 - "BeginTime": "2023-06-30T12:49:04.365Z",
2710 - "EndTime": "2023-06-30T12:49:04.365Z"
2711 -}
2712 -
2713 -Ответ:
2714 -
2715 -[
2716 - {
2717 - "VehicleId": 0,
2718 - "CreateTime": "2023-06-30T09:52:31.240Z",
2719 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2720 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2721 - "BeginTime": "2023-06-30T09:52:31.240Z",
2722 - "EndTime": "2023-06-30T09:52:31.240Z"
2723 - }
2724 -]
2725 -
2726 -
2727 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2728 -
2729 -(% class="box infomessage" %)
2730 -(((
2731 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2732 -)))
2733 -
2734 -Запрос:
2735 -
2736 -{
2737 - "Ids": [
2738 - 0
2739 - ],
2740 - "BeginTime": "2023-06-30T12:48:39.419Z",
2741 - "EndTime": "2023-06-30T12:48:39.419Z"
2742 -}
2743 -
2744 -Ответ:
2745 -
2746 -[
2747 - {
2748 - "VehicleId": 0,
2749 - "CreateTime": "2023-06-30T09:54:01.631Z",
2750 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "BeginTime": "2023-06-30T09:54:01.631Z",
2753 - "EndTime": "2023-06-30T09:54:01.631Z"
2754 - }
2755 -]
2756 -
2757 -
2758 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2759 -
2760 -(% class="box successmessage" %)
2761 -(((
2762 -**POST /api/v3/DriversVehiclesAssignments**
2763 -)))
2764 -
2765 -Передается массив назначений
2766 -
2767 -Запрос:
2768 -
2769 -[
2770 - {
2771 - "VehicleId": 0, ~/~/ Идентификатор объекта
2772 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2773 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2774 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2775 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2776 - }
2777 -]
2778 -
2779 -Ответ:
2780 -
2781 -[
2782 - {
2783 - "VehicleId": 0,
2784 - "CreateTime": "2023-06-30T11:04:46.903Z",
2785 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2786 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 - "BeginTime": "2023-06-30T11:04:46.903Z",
2788 - "EndTime": "2023-06-30T11:04:46.903Z"
2789 - }
2790 -]
2791 -
2792 -
2793 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2794 -
2795 -(% class="box warningmessage" %)
2796 -(((
2797 -**PUT /api/v3/DriversVehiclesAssignments**
2798 -)))
2799 -
2800 -Запрос:
2801 -
2802 -[
2803 - {
2804 - "VehicleId": 0,
2805 - "CreateTime": "2023-06-30T11:14:08.117Z",
2806 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2807 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2808 - "BeginTime": "2023-06-30T11:14:08.117Z",
2809 - "EndTime": "2023-06-30T11:14:08.117Z"
2810 - }
2811 -]
2812 -
2813 -Ответ:
2814 -
2815 -[
2816 - {
2817 - "VehicleId": 0,
2818 - "CreateTime": "2023-06-30T11:14:53.349Z",
2819 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2820 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2821 - "BeginTime": "2023-06-30T11:14:53.349Z",
2822 - "EndTime": "2023-06-30T11:14:53.349Z"
2823 - }
2824 -]
2825 -
2826 -
2827 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2828 -
2829 -(% class="box errormessage" %)
2830 -(((
2831 -**DELETE /api/v3/DriversVehiclesAssignments**
2832 -)))
2833 -
2834 -Запрос:
2835 -
2836 -[
2837 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2838 -]
2839 -
2840 -Ответ:
2841 -
2842 -Success
2843 -
2844 -
2845 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2846 -
2847 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2848 -
2849 -(% class="box infomessage" %)
2850 -(((
2851 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2852 -)))
2853 -
2854 -Запрос:
2855 -
2856 -{
2857 - "Ids": [
2858 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2859 - ],
2860 - "BeginTime": "2023-06-30T12:47:12.162Z",
2861 - "EndTime": "2023-06-30T12:47:12.162Z"
2862 -}
2863 -
2864 -Ответ:
2865 -
2866 -[
2867 - {
2868 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2869 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2870 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2871 - "BeginTime": "2023-06-30T11:19:40.703Z",
2872 - "EndTime": "2023-06-30T11:19:40.703Z"
2873 - }
2874 -]
2875 -
2876 -
2877 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2878 -
2879 -(% class="box infomessage" %)
2880 -(((
2881 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2882 -)))
2883 -
2884 -Запрос:
2885 -
2886 -{
2887 - "Ids": [
2888 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2889 - ],
2890 - "BeginTime": "2023-06-30T12:47:12.162Z",
2891 - "EndTime": "2023-06-30T12:47:12.162Z"
2892 -}
2893 -
2894 -Ответ:
2895 -
2896 -[
2897 - {
2898 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2899 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2900 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2901 - "BeginTime": "2023-06-30T11:19:40.703Z",
2902 - "EndTime": "2023-06-30T11:19:40.703Z"
2903 - }
2904 -]
2905 -
2906 -
2907 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2908 -
2909 -(% class="box successmessage" %)
2910 -(((
2911 -**POST /api/v3/DriversRfidsAssignments**
2912 -)))
2913 -
2914 -Запрос:
2915 -
2916 -[
2917 - {
2918 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2919 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2920 - "BeginTime": "2023-06-30T11:27:08.635Z",
2921 - "EndTime": "2023-06-30T11:27:08.635Z"
2922 - }
2923 -]
2924 -
2925 -Ответ:
2926 -
2927 -[
2928 - {
2929 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2930 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2931 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2932 - "BeginTime": "2023-06-30T11:27:08.677Z",
2933 - "EndTime": "2023-06-30T11:27:08.677Z"
2934 - }
2935 -]
2936 -
2937 -
2938 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2939 -
2940 -(% class="box warningmessage" %)
2941 -(((
2942 -**PUT /api/v3/DriversRfidsAssignments**
2943 -)))
2944 -
2945 -Запрос:
2946 -
2947 -[
2948 - {
2949 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2950 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2951 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2952 - "BeginTime": "2023-06-30T11:28:43.330Z",
2953 - "EndTime": "2023-06-30T11:28:43.330Z"
2954 - }
2955 -]
2956 -
2957 -Ответ:
2958 -
2959 -[
2960 - {
2961 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2962 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2963 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2964 - "BeginTime": "2023-06-30T11:28:43.331Z",
2965 - "EndTime": "2023-06-30T11:28:43.331Z"
2966 - }
2967 -]
2968 -
2969 -
2970 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2971 -
2972 -(% class="box errormessage" %)
2973 -(((
2974 -**DELETE /api/v3/DriversRfidsAssignments**
2975 -)))
2976 -
2977 -Запрос:
2978 -
2979 -[
2980 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2981 -]
2982 -
2983 -Ответ:
2984 -
2985 -Success
2986 -
2987 -
2988 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2989 -
2990 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2991 -
2992 -(% class="box infomessage" %)
2993 -(((
2994 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2995 -)))
2996 -
2997 -Запрос:
2998 -
2999 -{
3000 - "Ids": [
3001 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3002 - ],
3003 - "BeginTime": "2023-06-30T12:45:10.852Z",
3004 - "EndTime": "2023-06-30T12:45:10.852Z"
3005 -}
3006 -
3007 -Ответ:
3008 -
3009 -[
3010 - {
3011 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3012 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3013 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3014 - "BeginTime": "2023-06-30T11:58:04.695Z",
3015 - "EndTime": "2023-06-30T11:58:04.695Z"
3016 - }
3017 -]
3018 -
3019 -
3020 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3021 -
3022 -(% class="box infomessage" %)
3023 -(((
3024 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3025 -)))
3026 -
3027 -Запрос:
3028 -
3029 -{
3030 - "Ids": [
3031 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3032 - ],
3033 - "BeginTime": "2023-06-30T12:45:10.852Z",
3034 - "EndTime": "2023-06-30T12:45:10.852Z"
3035 -}
3036 -
3037 -Ответ:
3038 -
3039 -[
3040 - {
3041 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3042 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3043 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3044 - "BeginTime": "2023-06-30T11:58:04.695Z",
3045 - "EndTime": "2023-06-30T11:58:04.695Z"
3046 - }
3047 -]
3048 -
3049 -
3050 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3051 -
3052 -(% class="box successmessage" %)
3053 -(((
3054 -**POST /api/v3/DriversFuelCardsAssignments**
3055 -)))
3056 -
3057 -Запрос:
3058 -
3059 -[
3060 - {
3061 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3062 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3063 - "BeginTime": "2023-06-30T12:09:53.175Z",
3064 - "EndTime": "2023-06-30T12:09:53.175Z"
3065 - }
3066 -]
3067 -
3068 -Ответ:
3069 -
3070 -[
3071 - {
3072 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3073 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3074 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3075 - "BeginTime": "2023-06-30T12:09:53.201Z",
3076 - "EndTime": "2023-06-30T12:09:53.201Z"
3077 - }
3078 -]
3079 -
3080 -
3081 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3082 -
3083 -(% class="box warningmessage" %)
3084 -(((
3085 -**PUT /api/v3/DriversFuelCardsAssignments**
3086 -)))
3087 -
3088 -Запрос:
3089 -
3090 -[
3091 - {
3092 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3093 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3094 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3095 - "BeginTime": "2023-06-30T12:09:53.201Z",
3096 - "EndTime": "2023-06-30T12:09:53.201Z"
3097 - }
3098 -]
3099 -
3100 -Ответ:
3101 -
3102 -[
3103 - {
3104 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3105 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3106 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3107 - "BeginTime": "2023-06-30T12:09:53.201Z",
3108 - "EndTime": "2023-06-30T12:09:53.201Z"
3109 - }
3110 -]
3111 -
3112 -
3113 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3114 -
3115 -(% class="box errormessage" %)
3116 -(((
3117 -**DELETE /api/v3/DriversFuelCardsAssignments**
3118 -)))
3119 -
3120 -Запрос:
3121 -
3122 -[
3123 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3124 -]
3125 -
3126 -Ответ:
3127 -
3128 -Success
3129 -
3130 -
3131 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3132 -
3133 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3134 -
3135 -(% class="box infomessage" %)
3136 -(((
3137 -**POST /api/v3/Trailers**
3138 -)))
3139 -
3140 -Пример запроса:
3141 -
3142 -{
3143 - "startDate": "2023-11-14T10:48:03.671Z",
3144 - "endDate": "2023-11-14T10:48:03.671Z",
3145 - "ids": [ 0 ],
3146 - "timezone": 0
3147 -}
3148 -
3149 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3150 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3151 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3152 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3153 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3154 -
3155 -Пример ответа:
3156 -
3157 -[
3158 - {
3159 - "SD": "2023-11-14T10:48:03.717Z",
3160 - "ED": "2023-11-14T10:48:03.717Z", 
3161 - "id": 0,
3162 - "SLat": 0,
3163 - "SLon": 0,
3164 - "ELat": 0,
3165 - "ELon": 0,
3166 - "mileage": 0
3167 - "Duration": 0
3168 - "Address": "string",
3169 - "Address2": "string",
3170 - "name": "string",
3171 - "rid": "string",
3172 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3173 - "trailer": {
3174 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3175 - "Number": "string",
3176 - "Description": "string",
3177 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3178 - "ExternalID": "string",
3179 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3180 - "CreateTime": "2023-11-14T10:48:03.717Z",
3181 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3182 - "IsDeleted": true
3183 - },
3184 - "filesCount": 0,
3185 - }
3186 -]
3187 -
3188 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3189 -|SD|Дата и время начала события
3190 -|ED|Дата и время окончания события
3191 -|id|ID объекта
3192 -|SLat|Широта начальной координаты
3193 -|SLon|Долгота начальной координаты
3194 -|ELat|Широта конечной координаты
3195 -|ELon|Долгота конечной координаты
3196 -|mileage|Пробег
3197 -|Duration|Продолжительность
3198 -|Address|Адрес начального местоположения
3199 -|Address2|Адрес конечного местоположения
3200 -|name|Имя радиометки
3201 -|rid|Номер радиометки
3202 -|rguid|ID радиометки
3203 -|trailer|Информация об агрегате
3204 -|ModelGuid|ID агрегата
3205 -|Number|Название/номер агрегата
3206 -|Description|Текст примечания агрегата
3207 -
3208 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3209 -
3210 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3211 -
3212 -(% class="box infomessage" %)
3213 -(((
3214 -**POST /api/v3/Rfids/find**
3215 -)))
3216 -
3217 -Запрос:
3218 -
3219 -{
3220 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3221 -}
3222 -
3223 -Ответ:
3224 -
3225 -[
3226 - {
3227 - "name": "string",
3228 - "number": 0,
3229 - "period": 0,
3230 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3231 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3232 - }
3233 -]
3234 -
3235 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3236 -|parentId|ID клиента
3237 -|name|Название карты-метки
3238 -|number|Номер
3239 -|period|Период запросов в секундах (работает только для агрегатов)
3240 -|id|ID карты-метки
3241 -
3242 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3243 -
3244 -(% class="box infomessage" %)
3245 -(((
3246 -**GET /api/v3/Rfids/{rfidGuid}**
3247 -)))
3248 -
3249 -Передаем параметр rfidGuid - идентификатор карты-метки
3250 -
3251 -Ответ:
3252 -
3253 -[
3254 - {
3255 - "name": "string",
3256 - "number": 0,
3257 - "period": 0,
3258 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3259 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3260 - }
3261 -]
3262 -
3263 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3264 -|name|Название карты-метки
3265 -|number|Номер
3266 -|period|Период запросов в секундах (работает только для агрегатов)
3267 -|id|ID карты-метки
3268 -|parentId|ID клиента
3269 -
3270 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3271 -
3272 -(% class="box successmessage" %)
3273 -(((
3274 -**POST /api/v3/Rfids**
3275 -)))
3276 -
3277 -Запрос:
3278 -
3279 -{
3280 - "name": "string",
3281 - "number": 0,
3282 - "period": 0,
3283 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3284 -}
3285 -
3286 -Ответ:
3287 -
3288 -{
3289 - "name": "string",
3290 - "number": 0,
3291 - "period": 0,
3292 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3293 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3294 -}
3295 -
3296 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3297 -|name|Название карты-метки
3298 -|number|Номер
3299 -|period|Период запросов в секундах (работает только для агрегатов)
3300 -|id|ID карты-метки
3301 -|parentId|ID клиента
3302 -
3303 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3304 -
3305 -(% class="box warningmessage" %)
3306 -(((
3307 -**PUT /api/v3/Rfids**
3308 -)))
3309 -
3310 -Запрос:
3311 -
3312 -{
3313 - "name": "string",
3314 - "number": 0,
3315 - "period": 0,
3316 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3317 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3318 -}
3319 -
3320 -Ответ:
3321 -
3322 -{
3323 - "name": "string",
3324 - "number": 0,
3325 - "period": 0,
3326 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3328 -}
3329 -
3330 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3331 -|name|Название карты-метки
3332 -|number|Номер
3333 -|period|Период запросов в секундах (работает только для агрегатов)
3334 -|id|ID карты-метки
3335 -|parentId|ID клиента
3336 -
3337 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3338 -
3339 -(% class="box errormessage" %)
3340 -(((
3341 -**DELETE /api/v3/Rfids/{rfidGuid}**
3342 -)))
3343 -
3344 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3345 -
3346 -Ответ:
3347 -
3348 -Success
3349 -
3350 -
3351 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3352 -
3353 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3354 -
3355 -(% class="box infomessage" %)
3356 -(((
3357 -**GET /api/v3/Billing/client/balance/{clientId}**
3358 -)))
3359 -
3360 -Параметр запроса: **clientId **- идентификатор клиента.
3361 -
3362 -Ответ:
3363 -
3364 -{
3365 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3366 - "Balance": 0
3367 -}
3368 -
3369 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3370 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3371 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3372 -
3373 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3374 -
3375 -(% class="box infomessage" %)
3376 -(((
3377 -**GET /api/v3/Billing/client/constraint/{clientId}**
3378 -)))
3379 -
3380 -Параметр запроса: **clientId **- идентификатор клиента.
3381 -
3382 -Ответ:
3383 -
3384 -{
3385 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3386 - "CalculationType": 0,
3387 - "PermissibleBalance": 0,
3388 - "DefermentDays": 0,
3389 - "SendUiNotifications": true,
3390 - "SendEmailNotifications": true,
3391 - "IsPrivate": true,
3392 -}
3393 -
3394 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3395 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3396 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3397 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3398 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3399 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3400 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3401 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3402 -
3403 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3404 -
3405 -(% class="box infomessage" %)
3406 -(((
3407 -**GET /api/v3/Billing/client/plan/{clientId}**
3408 -)))
3409 -
3410 -Параметры запроса:
3411 -
3412 -**clientId **- идентификатор клиента.
3413 -
3414 -**planId **- идентификатор тарифного плана.
3415 -
3416 -Ответ:
3417 -
3418 -{
3419 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3420 - "Plan": { **~/~/ Описание тарифного плана**
3421 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3422 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3423 - "Name": "string",
3424 - "IsArchived": true,
3425 - "Constraint": {
3426 - "CalculationType": 0,
3427 - "PermissibleBalance": 0,
3428 - "DefermentDays": 0
3429 - },
3430 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3431 - {
3432 - "Feature": "string",
3433 - "IsFactual": true,
3434 - "Limit": 0,
3435 - "Price": 0,
3436 - "PeriodValue": 0,
3437 - "PeriodType": 0
3438 - }
3439 - ]
3440 - },
3441 - "DebitDate": "2023-10-18T12:46:24.213Z",
3442 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3443 - {
3444 - "Feature": "string",
3445 - "IsEnabled": true,
3446 - "IsPrivate": true,
3447 - "IsFactual": true,
3448 - "Limit": 0,
3449 - "Price": 0,
3450 - "DebitDate": "2023-10-18T12:46:24.213Z",
3451 - "PeriodValue": 0,
3452 - "PeriodType": 0
3453 - }
3454 - ]
3455 -}
3456 -
3457 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3458 -|ClientId|Идентификатор клиента
3459 -|Id|Идентификатор тарифного плана
3460 -|OwnerId|Идентификатор клиента-владельца
3461 -|Name|Наименование тарифного плана
3462 -|IsArchived|Признак, определяющий архивный тарифный план
3463 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3464 -|PermissibleBalance|Допустимый баланс
3465 -|DefermentDays|Отсрочка, количество дней
3466 -|Feature|Код услуги
3467 -|IsEnabled|Признак, определяющий активирована ли услуга
3468 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3469 -|IsFactual|Признак, определяющий расчёт по факту
3470 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3471 -|Price|Цена за единицу.
3472 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3473 -|PeriodValue|Значение периода.
3474 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3475 -
3476 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3477 -
3478 -(% class="box infomessage" %)
3479 -(((
3480 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3481 -)))
3482 -
3483 -Параметр запроса: **clientId **- идентификатор клиента.
3484 -
3485 -Ответ:
3486 -
3487 -[
3488 - {
3489 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3490 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3491 - "Name": "string",
3492 - "IsArchived": true,
3493 - "Constraint": {
3494 - "CalculationType": 0,
3495 - "PermissibleBalance": 0,
3496 - "DefermentDays": 0
3497 - },
3498 - "Features": [
3499 - {
3500 - "Feature": "string",
3501 - "IsFactual": true,
3502 - "Limit": 0,
3503 - "Price": 0,
3504 - "PeriodValue": 0,
3505 - "PeriodType": 0
3506 - }
3507 - ]
3508 - }
3509 -]
3510 -
3511 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3512 -|ClientId|Идентификатор клиента
3513 -|Id|Идентификатор тарифного плана
3514 -|OwnerId|Идентификатор клиента-владельца
3515 -|Name|Наименование тарифного плана
3516 -|IsArchived|Признак, определяющий архивный тарифный план
3517 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3518 -|PermissibleBalance|Допустимый баланс
3519 -|DefermentDays|Отсрочка, количество дней
3520 -|Feature|Код услуги
3521 -|IsFactual|Признак, определяющий расчёт по факту
3522 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3523 -|Price|Цена за единицу.
3524 -|PeriodValue|Значение периода.
3525 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3526 -
3527 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3528 -
3529 -(% class="box infomessage" %)
3530 -(((
3531 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3532 -)))
3533 -
3534 -Параметр запроса: **clientId **- идентификатор клиента.
3535 -
3536 -Ответ:
3537 -
3538 -[
3539 - {
3540 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3541 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3542 - "Name": "string",
3543 - "IsArchived": true,
3544 - "Constraint": {
3545 - "CalculationType": 0,
3546 - "PermissibleBalance": 0,
3547 - "DefermentDays": 0
3548 - },
3549 - "Features": [
3550 - {
3551 - "Feature": "string",
3552 - "IsFactual": true,
3553 - "Limit": 0,
3554 - "Price": 0,
3555 - "PeriodValue": 0,
3556 - "PeriodType": 0
3557 - }
3558 - ]
3559 - }
3560 -]
3561 -
3562 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3563 -|ClientId|Идентификатор клиента
3564 -|Id|Идентификатор тарифного плана
3565 -|OwnerId|Идентификатор клиента-владельца
3566 -|Name|Наименование тарифного плана
3567 -|IsArchived|Признак, определяющий архивный тарифный план
3568 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3569 -|PermissibleBalance|Допустимый баланс
3570 -|DefermentDays|Отсрочка, количество дней
3571 -|Feature|Код услуги
3572 -|IsFactual|Признак, определяющий расчёт по факту
3573 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3574 -|Price|Цена за единицу.
3575 -|PeriodValue|Значение периода.
3576 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3577 -
3578 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3579 -
3580 -(% class="box warningmessage" %)
3581 -(((
3582 -**PUT /api/v3/Billing/client/balance**
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 -(% class="box warningmessage" %)
3603 -(((
3604 -**PUT /api/v3/billing/client/balance/deposit**
3605 -)))
3606 -
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 -Создает операцию **Списание **с указанной суммой
3625 -
3626 -(% class="box warningmessage" %)
3627 -(((
3628 -**PUT /api/v3/billing/client/balance/withdraw**
3629 -)))
3630 -
3631 -Тело запроса:
3632 -
3633 -{
3634 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3635 - "Balance": 0
3636 -}
3637 -
3638 -Ответ: Success
3639 -
3640 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3641 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3642 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3643 -
3644 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3645 -
3646 -(% class="box warningmessage" %)
3647 -(((
3648 -**PUT /api/v3/Billing/client/constraint**
3649 -)))
3650 -
3651 -Тело запроса:
3652 -
3653 -{
3654 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3655 - "CalculationType": 0,
3656 - "PermissibleBalance": 0,
3657 - "DefermentDays": 0,
3658 - "SendUiNotifications": true,
3659 - "SendEmailNotifications": true,
3660 - "IsPrivate": true,
3661 -}
3662 -
3663 -Ответ: Success
3664 -
3665 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3666 -|ClientId|Идентификатор клиента
3667 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3668 -|PermissibleBalance|Допустимый баланс
3669 -|DefermentDays|(((
3670 -Отсрочка, количество дней
3671 -)))
3672 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3673 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3674 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3675 -
3676 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3677 -
3678 -(% class="box warningmessage" %)
3679 -(((
3680 -**PUT /api/v3/Billing/client/plan**
3681 -)))
3682 -
3683 -Тело запроса:
3684 -
3685 -{
3686 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3687 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3688 - "Features": [
3689 - {
3690 - "Feature": "string",
3691 - "IsEnabled": true,
3692 - "IsFactual": true,
3693 - "Limit": 0,
3694 - "Price": 0,
3695 - "DebitDate": "2023-10-18T13:26:58.987Z",
3696 - "PeriodValue": 0,
3697 - "PeriodType": 0
3698 - }
3699 - ]
3700 -}
3701 -
3702 -Ответ: Success
3703 -
3704 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3705 -|ClientId|Идентификатор клиента
3706 -|PlanId|Идентификатор тарифного плана
3707 -|Feature|Код услуги
3708 -|IsEnabled|Признак, определяющий активирована ли услуга
3709 -|IsFactual|Признак, определяющий расчёт по факту
3710 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3711 -|Price|Цена за единицу.
3712 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3713 -|PeriodValue|Значение периода.
3714 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3715 -
3716 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3717 -
3718 -(% class="box warningmessage" %)
3719 -(((
3720 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3721 -)))
3722 -
3723 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3724 -
3725 -(% class="box infomessage" %)
3726 -(((
3727 -**POST /api/v3/vehicles/import/{agentId}**
3728 -)))
3729 -
3730 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3731 -
3732 -В пути указывается **agentId** - id клиента.
3733 -
3734 -**Заголовок**
3735 -
3736 -**X-Auth: [токен авторизации]**
3737 -
3738 -**Параметры**
3739 -
3740 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3741 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3742 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3743 -
3744 -В теле использовать тип **form-data,** тип значения** file**
3745 -
3746 -**Ключи**
3747 -
3748 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3749 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3750 -|csv|В значении передаем файл датчиков, формат **csv**
3751 -
3752 -Ответ:
3753 -
3754 -{
3755 - "vehicleId": 0,
3756 - "name": "string",
3757 - "errors": ["string"]
3758 -}
3759 -
3760 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3761 -|vehicleId|ID созданного объекта
3762 -|name|Имя созданного объекта
3763 -|errors|Ошибки и их описание
3764 -
3765 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3766 -
3767 -(% class="box infomessage" %)
3768 -(((
3769 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3770 -)))
3771 -
3772 -(% class="wikigeneratedid" %)
3773 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3774 -
3775 -(% class="wikigeneratedid" %)
3776 -В пути указывается **vehicleId **- id объекта.
3777 -
3778 -**Заголовок**
3779 -
3780 -**X-Auth: [токен авторизации]**
3781 -
3782 -В теле использовать тип **form-data.**
3783 -
3784 -Ключи:
3785 -
3786 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3787 -|**history**|В значении передавать файл с историей
3788 -
3789 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3790 -
3791 -Ответ:
3792 -
3793 -{
3794 - "results": [
3795 - {
3796 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3797 - "vehicleId": 0,
3798 - "errors": [
3799 - "string"
3800 - ],
3801 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3802 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3803 - "producedCount": 0,
3804 - "msgCount": 0
3805 - }
3806 - ]
3807 -}
3808 -
3809 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3810 -|results|Результаты импорта в разрезе ТС
3811 -|vehicleGuid|Guid ТС
3812 -|vehicleId|ID ТС
3813 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3814 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3815 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3816 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3817 -|msgCount|Кол-во обработанных сообщений всего
3818 -
3819 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3820 -
3821 -(% class="box infomessage" %)
3822 -(((
3823 -**GET /api/v3/vehicles/import/history/status**
3824 -)))
3825 -
3826 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3827 -
3828 -Ответ:
3829 -
3830 -{
3831 - "activity": true,
3832 - "progress": 0,
3833 - "message": "string"
3834 -}
3835 -
3836 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3837 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3838 -|progress|Guid ТС
3839 -
3840 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3841 -
3842 -(% class="box infomessage" %)
3843 -(((
3844 -**POST /api/v3/vehicles/export**
3845 -)))
3846 -
3847 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3848 -
3849 -Тело запроса:
3850 -
3851 -[
3852 - id
3853 -]
3854 -
3855 -Ответ: Success 200, получаете файлы с настройками.
3856 -
3857 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3858 -
3859 -(% class="box infomessage" %)
3860 -(((
3861 -**POST /api/v3/vehicles/export/history**
3862 -)))
3863 -
3864 -Метод возвращает список сообщений терминала объекта за выбранный период.
3865 -
3866 -Тело запроса:
3867 -
3868 -{
3869 - "vehicleId": 0,
3870 - "asArchive": true,
3871 - "from": "2023-09-27T12:17:45.973Z",
3872 - "to": "2023-09-27T12:17:45.973Z"
3873 -}
3874 -
3875 -Ответ:
3876 -
3877 -Получаете файл. Сообщение: Code 200/Success
3878 -
3879 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3880 -|vehicleId|ID объекта
3881 -|asArchive|true - Архивировать файл, False - не архивировать
3882 -|from|Дата и время начала запроса
3883 -|to|Дата и время окончания запроса
3884 -
3885 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3886 -
3887 -(% class="box infomessage" %)
3888 -(((
3889 -**GET /api/v3/vehicles/export/history/status**
3890 -)))
3891 -
3892 -Метод возвращает список сообщений терминала объекта за выбранный период.
3893 -
3894 -Ответ:
3895 -
3896 -{
3897 - "activity": true,
3898 - "progress": 0,
3899 - "message": "string"
3900 -}
3901 -
3902 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3903 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3904 -|progress|Прогресс экспорта, от 0 до 100%
3905 -|message|Текст описывающий статус
3906 -
3907 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3908 -
3909 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3910 -
3911 -(% class="box infomessage" %)
3912 -(((
3913 -**POST /api/v3/EcoDriving/rating**
3914 -)))
3915 -
3916 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3917 -
3918 -Тело запроса:
3919 -
3920 -{
3921 - "vehicleIds": [vehicleId],
3922 - "from": "2023-11-22T09:29:48.051Z",
3923 - "to": "2023-11-22T09:29:48.051Z"
3924 -}
3925 -
3926 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3927 -|vehicleIds|Массив ID объектов
3928 -|from|Дата начала запроса
3929 -|to|Дата окончания запроса
3930 -
3931 -Ответ:
3932 -
3933 -{
3934 - "items": [
3935 - {
3936 - "from": "2023-11-22T09:29:48.052Z",
3937 - "to": "2023-11-22T09:29:48.052Z",
3938 - "vehicleId": 0,
3939 - "vehicleName": "string",
3940 - "vehicleModel": "string",
3941 - "penalty": 0,
3942 - "score": 0,
3943 - "totalViolations": 0,
3944 - "violationsByType": {
3945 - "overspeedingViolations": 0,
3946 - "accelerationViolations": 0,
3947 - "brakingViolations": 0,
3948 - "turningViolations": 0,
3949 - "dangerousDrivingViolations": 0,
3950 - "sensorViolations": 0
3951 - },
3952 - "moveTime": 0,
3953 - "mileage": 0,
3954 - "tripsCount": 0,
3955 - "trips": [
3956 - {
3957 - "penalty": 0,
3958 - "score": 0,
3959 - "violationsCount": 0,
3960 - "violationsByType": {
3961 - "overspeedingViolations": 0,
3962 - "accelerationViolations": 0,
3963 - "brakingViolations": 0,
3964 - "turningViolations": 0,
3965 - "dangerousDrivingViolations": 0,
3966 - "sensorViolations": 0
3967 - },
3968 - "moveTime": 0,
3969 - "mileage": 0,
3970 - "motohours": 0,
3971 - "maxSpeed": 0,
3972 - "startAddress": "string",
3973 - "endAddress": "string",
3974 - "drivers": [
3975 - {
3976 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3977 - "driverName": "string",
3978 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3979 - }
3980 - ]
3981 - }
3982 - ]
3983 - }
3984 - ]
3985 -}
3986 -
3987 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3988 -|from|Дата начала запроса
3989 -|to|Дата  окончания
3990 -|vehicleId|ID объекта
3991 -|vehicleName|Имя объекта
3992 -|vehicleModel|Модель объекта
3993 -|penalty|Сумма штрафных баллов
3994 -|score|Оценка
3995 -|totalViolations|Суммарное количество нарушений
3996 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3997 -|overspeedingViolations|Превышение скорости
3998 -|accelerationViolations|Ускорение
3999 -|brakingViolations|Торможение
4000 -|turningViolations|Резкий поворот
4001 -|dangerousDrivingViolations|Резкое вождение
4002 -|sensorViolations|Нарушение по датчику
4003 -|moveTime|Время в движении
4004 -|mileage|Пробег
4005 -|tripsCount|Количество рейсов
4006 -|motohours|Моточасы
4007 -|maxSpeed|Максимальная скорость
4008 -|startAddress|Адрес начала рейса
4009 -|endAddress|Адрес окончания рейса
4010 -|drivers|Список водителей, которые были на объекте в течениии рейса
4011 -|driverGuid|Guid водителя
4012 -|driverName|Имя водителя
4013 -|driverRfid|Номер Карты-метки
4014 -
4015 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4016 -
4017 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4018 -
4019 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4020 -
4021 -(% class="box infomessage" %)
4022 -(((
4023 -POST /api/v3/fuelcards/transactions
4024 -)))
4025 -
4026 -Метод запроса: POST
4027 -
4028 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4029 -\\В заголовках запроса: X-Auth: Токен авторизации
4030 -
4031 -Параметры в теле запроса (JSON):
4032 -
4033 -{
4034 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4035 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4036 - "ids": [ 
4037 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4038 - ],
4039 - "timezone": 0 ~/~/Таймзона
4040 -}
4041 -
4042 -
4043 -Ответ:
4044 - {
4045 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4046 - "driver": "string", ~/~/Водители, привязанные к ТК
4047 - "object": "string", ~/~/Наименование ТС
4048 - "amount": 0, ~/~/Количество топлива
4049 - "amountDut": 0, ~/~/Количество по ДУТ
4050 - "amountDiff": 0, ~/~/Разница, л
4051 - "amountDiffPerc": 0, ~/~/Разница, %
4052 - "summa": 0, ~/~/Стоимость, руб
4053 - "serviceName": "string", ~/~/Тип топлива
4054 - "price": 0, ~/~/Цена за литр, руб
4055 - "cardName": "string", ~/~/Наименование ТК
4056 - "cardNum": "string", ~/~/Номер ТК
4057 - "operator": "string", ~/~/Оператор ТК
4058 - "address": "string" ~/~/Адрес АЗС
4059 - }
4060 -
4061 -
4062 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4063 -
4064 -
4065 -== **Получение полных данных о ретрансляторе** ==
4066 -
4067 -(% class="box infomessage" %)
4068 -(((
4069 -**GET ** **/api/v3/retranslations/{id}**
4070 -)))
4071 -
4072 -Идентификатор запроса: ID
4073 -
4074 -
4075 -Пример ответа:
4076 -
4077 -{  
4078 -"description": "", ~/~/ Определяет описание
4079 -"subscriberId": "", ~/~/ Подписчик
4080 -"protocolType": 0, ~/~/ Тип протокола
4081 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4082 -"address": "string", ~/~/ Адрес события
4083 -"objects": [ ~/~/Объекты для ретрансляции
4084 -{      
4085 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4086 -"name": "", ~/~/ Наименование объекта ретрансляции
4087 -"imei": "", ~/~/ IMEI объекта  
4088 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4089 -}
4090 - ],  
4091 -"id": "", ~/~/ идентификатор пользователя   
4092 -"parentId": "", ~/~/Guid родителя
4093 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4094 -}
4095 -
4096 -
4097 -== **Удаление данных ретранслятора** ==
4098 -
4099 -(% class="box infomessage" %)
4100 -(((
4101 -**DELETE** **/api/v3/retranslations/{id}**
4102 -)))
4103 -
4104 -Параметр запроса: ID
4105 -
4106 -
4107 -== **Создание ретранслятора** ==
4108 -
4109 -(% class="box infomessage" %)
4110 -(((
4111 -**POST ** **/api/v3/retranslations/{id}**
4112 -)))
4113 -
4114 -Запрос:
4115 -
4116 -{  
4117 -"description": "", ~/~/ Описание
4118 -"subscriberId": "", ~/~/ Подписчик
4119 -"protocolType": 0, ~/~/ Тип протокола
4120 -"address": "", ~/~/ Адрес ретрансляции
4121 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4122 -"objects": [ ~/~/Объекты для ретрансляции
4123 -{      
4124 -"id": "", ~/~/ идентификатор пользователя     
4125 -"imei": "", ~/~/IMEI объекта
4126 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4127 -}
4128 - ]
4129 -}
4130 -
4131 -
4132 -Ответ:
4133 -
4134 -{  
4135 -"description": "string", ~/~/ Определяет описание
4136 -"subscriberId": "", ~/~/ идентификатор запроса
4137 -"protocolType": 0, ~/~/ Тип протокола
4138 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4139 -"address": "", ~/~/ Адрес события
4140 -"objects": [ ~/~/Объекты для ретрансляции
4141 -{      
4142 -"id": "", ~/~/ идентификатор пользователя    
4143 -"name": "string", ~/~/ Название уведомления
4144 -"imei": "string", ~/~/IMEI объекта  
4145 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4146 -}
4147 - ],  
4148 -"id": "", ~/~/ идентификатор пользователя  
4149 -"parentId": "", ~/~/ Guid идентификатор родителя
4150 -"deleted": true ~/~/ Признак удаления
4151 -}
4152 -
4153 -
4154 -== **Редактирование ретранслятора** ==
4155 -
4156 -(% class="box infomessage" %)
4157 -(((
4158 -**PUT** **/api/v3/retranslations**
4159 -)))
4160 -
4161 -Пример запроса:
4162 -
4163 -{  
4164 -"id": "", ~/~/ идентификатор пользователя   
4165 -"description": "string", ~/~/ Определяет описание
4166 -"subscriberId": "", ~/~/ идентификатор запроса
4167 -"protocolType": 0, ~/~/ Тип протокола
4168 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4169 -"address": "string", ~/~/ Адрес события
4170 -"objects": ~/~/Объекты для ретрансляции
4171 -[    
4172 -{      
4173 -"id": "",  ~/~/ идентификатор пользователя         
4174 -"imei": "", ~/~/IMEI объекта
4175 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4176 -}
4177 - ]
4178 -}
4179 -
4180 -
4181 -Пример ответа:
4182 -
4183 -{  
4184 -"description": "", ~/~/ Определяет описание
4185 -"subscriberId": "", ~/~/ идентификатор запроса
4186 -"protocolType": 0, ~/~/ Тип протокола
4187 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4188 -"address": "string", ~/~/ Адрес события
4189 -"objects": [ ~/~/Объекты для ретрансляции
4190 -{      
4191 -"id": "", ~/~/ идентификатор пользователя     
4192 -"name": "string", ~/~/ Название уведомления    
4193 -"imei": "", ~/~/IMEI объекта
4194 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4195 -}
4196 - ],
4197 -"id": "", ~/~/ идентификатор пользователя   
4198 -"parentId": "", ~/~/ Guid идентификатор родителя
4199 -"deleted": true ~/~/ Признак удаления
4200 -}
4201 -
4202 -
4203 -== **Получение списка ретранслятора клиента** ==
4204 -
4205 -(% class="box infomessage" %)
4206 -(((
4207 -**POST /api/v3/retranslations/find**
4208 -)))
4209 -
4210 -Пример запроса:
4211 -
4212 -{  
4213 -"id": "", ~/~/ идентификатор пользователя   
4214 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4215 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4216 -}
4217 -
4218 -Ответ:
4219 -
4220 -[ 
4221 -{    
4222 -"description": "", ~/~/ Определяет описание
4223 -"subscriberId": "", ~/~/ идентификатор запроса
4224 -"protocolType": 0, ~/~/ Тип протокола
4225 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4226 -"address": "string", ~/~/ Адрес события
4227 -"id": "", ~/~/ идентификатор пользователя   
4228 -"parentId": "", ~/~/ Guid идентификатор родителя
4229 -"deleted": true ~/~/ Признак удаления
4230 -}
4231 -]
4232 -
4233 -
4234 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4235 -
4236 -== **API для отчета по выгрузке комбайнов** ==
4237 -
4238 -(% class="box infomessage" %)
4239 -(((
4240 -POST **/api/v3/Reports/harvesterUnloading**
4241 -)))
4242 -
4243 -Пример запроса:
4244 -
4245 -{
4246 - "byTime": 0, ~/~/ Объединение событий по времени
4247 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4248 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4249 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4250 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4251 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4252 - 0
4253 - ],
4254 - "from": "", ~/~/ Дата и время начало запроса
4255 - "to": "", ~/~/ Дата и время окончания запроса
4256 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4257 -}
4258 -
4259 -Пример ответа:
4260 -
4261 -[ 
4262 - {
4263 - "harvesterName": "", ~/~/Комбайн, номер
4264 - "harvesterId": 0, ~/~/Комбайн, id
4265 -"harvesterModel": "", ~/~/ Модель комбайна
4266 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4267 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4268 - "events": [ ~/~/Список событий в разрезе комбайна
4269 - {
4270 - "driverId": "", ~/~/Идентификатор водителя
4271 - "driverName": "", ~/~/Водитель комбайна, ФИО
4272 - "RFID": "", ~/~/ идентификатор карты-метки
4273 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4274 - "vehicleId": 0, ~/~/идентификатор объекта
4275 - "vehicleName": "string", ~/~/ Имя объекта
4276 - "modelName": "string", ~/~/ Имя модели объекта
4277 - "nearestVehicles": [ ~/~/Объекты рядом
4278 - {
4279 - "vehicleId": 0, ~/~/идентификатор объекта
4280 - "vehicleName": "string" ~/~/ Имя объекта
4281 - }
4282 - ],
4283 - "fields": [ ~/~/Поля, где происходила выгрузка
4284 - {
4285 - "id": 0, ~/~/ идентификатор пользователя 
4286 - "name": "string" ~/~/ имя пользователя 
4287 - }
4288 - ],
4289 - "event": "string", ~/~/Событие
4290 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4291 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4292 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4293 - "cultureName": "string", ~/~/ название культуры
4294 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4295 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4296 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4297 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4298 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4299 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4300 - "issued": 0, ~/~/Выдано, бункеров
4301 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4302 - "latitude": 0, ~/~/Широта
4303 - "longitude": 0, ~/~/ Долгота
4304 - "litresAway": 0, ~/~/Отдано, л
4305 - "m3Away": 0 ~/~/Отдано, м3
4306 - }
4307 - ]
4308 - }
4309 -]
4310 -
4311 -
4312 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4313 -
4314 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4315 -
4316 -
4317 -(% class="box infomessage" %)
4318 -(((
4319 -GET api/v3/Vehicles/recyclebin/all
4320 -)))
4321 -
4322 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4323 -
4324 -Параметр запроса: {parentId} - идентификатор агента
4325 -
4326 -В заголовках запроса: X-Auth: Токен авторизации
4327 -
4328 -Ответ:
4329 -
4330 -[ 
4331 - {
4332 - "recordTime": "", ~/~/Время записи
4333 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4334 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4335 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4336 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4337 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4338 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4339 - "items": [ ~/~/ 
4340 -nullable: true ~/~/Детали
4341 - {
4342 - "name": "string", ~/~/наименование столбца
4343 - "value": "string" ~/~/содержание столбца
4344 - }
4345 - ]
4346 - },
4347 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4348 - "string"
4349 - ]
4350 - }
4351 -]
4352 -
4353 -
4354 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4355 -
4356 -(% class="box infomessage" %)
4357 -(((
4358 -POST/api/v3/Vehicles/recyclebin/erase
4359 -)))
4360 -
4361 -В заголовках запроса: X-Auth: Токен авторизации
4362 -
4363 -Пример запроса:
4364 -
4365 -[
4366 -0
4367 -]
4368 4368  
4369 4369  
4370 -Пример ответа:
442 + **Проверка авторизации**
4371 4371  
4372 -[ 
4373 -{
4374 - "recordTime": "", ~/~/Время записи
4375 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4376 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4377 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4378 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4379 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4380 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4381 - "items": [ ~/~/Детали
4382 - {
4383 - "name": "", ~/~/Имя свойства
4384 - "value": "" ~/~/Значение свойства
4385 - }
4386 - ]
4387 - },
4388 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4389 - ""
4390 - ]
4391 - }
4392 -]
444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
4393 4393  
4394 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
446 +Метод запроса: GET
4395 4395  
4396 -== (% 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]]
4397 4397  
4398 -(% class="box infomessage" %)
4399 -(((
4400 -POST/api/v3/Vehicles/recyclebin/restore
4401 -)))
4402 -
4403 4403  В заголовках запроса: X-Auth: Токен авторизации
4404 4404  
4405 -Параметры в теле запроса (JSON):
452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
4406 4406  
4407 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4408 -
4409 -В заголовках запроса: X-Auth: Токен авторизации
4410 -
4411 -
4412 -Пример запроса:
4413 -
4414 -(((
4415 -[
4416 -)))
4417 -
4418 -(((
4419 - 0
4420 -)))
4421 -
4422 -(((
4423 -]
4424 -)))
4425 -
4426 -
4427 -Пример ответа:
4428 -
4429 -[
4430 -{
4431 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4432 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4433 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4434 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4435 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4436 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4437 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4438 - "items": [ ~/~/Детали
4439 - {
4440 - "name": "string", ~/~/Имя свойства
4441 - "value": "string" ~/~/Значение свойства
4442 - }
4443 - ]
4444 - },
4445 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4446 - "string"
4447 - ]
4448 - }
4449 -]
4450 -
4451 -
4452 -
4453 -(% class="box" lang="en-US" style="text-align: center;" %)
4454 -(((
4455 -(% 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]] **
4456 -)))
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 г.