From version 1.1 >
edited by Андрей Калиновский
on 2022/05/16 11:15
To version < 132.1 >
edited by Андрей Калиновский
on 2024/01/30 15:11
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -API
1 +Методы API для работы с ГЛОНАССSoft
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,441 +1,4008 @@
1 -== Описание ГЛОНАССSoft Public API
2 - ==
1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +(((
3 +**Содержание страницы:**
4 +)))
3 3  
4 - **Действующие ограничения**
6 +{{toc/}}
5 5  
6 -Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
7 7  
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 +
8 8  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
9 9  
10 - **Авторизация**
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
11 11  
12 -Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
13 13  
14 -Метод запроса: GET
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
15 15  
16 -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 +(% class="box successmessage" %)
24 +(((
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 +)))
17 17  
18 -В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
19 19  
20 -Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
30 +(% style="color:#000000" %)Метод запроса: **POST**
21 21  
22 - **Получение списка объектов**
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
23 23  
24 -Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
25 25  
26 -−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
27 27  
28 -−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}
29 29  
30 -−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
43 +(% style="color:#000000" %)**Ответ:**
31 31  
32 -−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
45 +(% lang="en-US" %)
46 +(% style="color:#000000" %){
33 33  
34 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
48 +(% lang="en-US" %)
49 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 + "User": "testuser" , ~/~/ имя пользователя
35 35  
36 -Метод запроса: POST
52 +(% lang="en-US" %)
53 +}
37 37  
38 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
55 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
39 39  
40 -В заголовках запроса:
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
41 41  
42 -−Content-Type: application/json
63 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
43 43  
44 -−X-Auth: Токен авторизации
65 +(% class="box infomessage" %)
66 +(((
67 +(% lang="en-US" %)**GET /api/v3/auth/check**
68 +)))
45 45  
46 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
70 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
47 47  
48 -{{{ {"vehicleId": null,//84350, // ID ТС (int, опционально)
49 - "name": null, // Имя ТС (string, опционально)
50 - "imei": null,//"710179307", // IMEI (string, опционально)
51 - "sim": null,//"938112", // Номер телефона (string, опционально)
52 - "deviceTypeId": null,//5 // ID типа устройства (short, опционально)
53 - "parentId": null, // ID клиента (Guid, опционально)
54 - "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
72 +(% style="color:#000000" %)Метод запроса: **GET**
55 55  
56 -Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «si. Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
74 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
57 57  
58 -Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» // статус объекта }, … ]
76 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
59 59  
60 -Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
78 +(% lang="en-US" %)
79 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
61 61  
62 -0 - «Блокировка»
81 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
63 63  
64 -1 - «Активен»,
83 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
65 65  
66 -2 - «Отменен»
85 +(% class="box infomessage" %)
86 +(((
87 +**GET api/v3/agents/{id}**
88 +)))
67 67  
68 -3 - «Оборудован»
90 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
69 69  
70 -4 - «Диагностика»
92 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
71 71  
72 -5 - «Сервис»
94 +(% style="color:#000000" %)Метод запроса: **GET**
73 73  
74 -6 - «Демонтаж»
96 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
75 75  
76 -7 - «Монтаж»
98 +Запрос должен содержать данные параметра "**agentId**"
77 77  
78 -8 - «Дозаказ»
100 +(% style="color:#000000" %)Ответ:
101 +{
102 + "agentId": "",  (%%)
103 + "parentId": "",
104 + "parentName": "string",
105 + "name": "string",
106 + "fullName": "string",
107 + "agentInfoType": 0,
108 + "isForeign": true/false,
109 + "district": "string", 
110 + "region": "string",
111 + "city": "string",
112 + "inn": "string",
113 + "kpp": "string",
114 + "address": "string",
115 + "addressFact": "string",
116 + "email": "string",
117 + "director": "string",
118 + "bankName": "string",
119 + "bankBIK": "string",
120 + "bankRS": "string",
121 + "bankKS": "string"
122 + }
79 79  
80 -9 - «Обслужен»
124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
81 81  
82 -10 - «Списан»
146 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
83 83  
84 -11 - «Неисправен»
148 +(% class="box infomessage" %)
149 +(((
150 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
151 +)))
85 85  
86 -12 - «Проверен»
153 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
88 -13 - «Не эксплуатируется»
155 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 - **Получение списка клиентов.**
157 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91 91  
92 -Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
161 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
163 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
165 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -Метод запроса: GET
167 +(% style="color:#000000" %){
168 + "parentId": "string"
169 +}
101 101  
102 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
171 +(% style="color:#000000" %)Ответ:
103 103  
104 -Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
173 +{
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "name": "string",
177 + "fullName": "string",
178 + "agentInfoType": 0,
179 +(% style="color:#000000" %) "status": "",
180 +}
105 105  
182 +
183 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 +
191 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
192 +
193 +(% class="box successmessage" %)
194 +(((
195 +**POST /api/v3/agents **
196 +)))
197 +
198 +Метод позволяет добавить клиента, указанного в запросе.
199 +
200 +Метод запроса: **POST**
201 +
202 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
203 +
106 106  В заголовках запроса: X-Auth: Токен авторизации
107 107  
108 -Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
206 +Параметры в теле запроса (JSON):
109 109  
110 -Примечание. Возможные значение параметра agentInfoType:
208 +{
209 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
210 + "name": "string", ~/~/ имя
211 + "fullName": "string", ~/~/ полное наименование
212 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
213 + "isForeign": true, ~/~/ иностранный контрагент
214 + "district": "string", ~/~/ округ
215 + "region": "string", ~/~/ регион
216 + "city": "string", ~/~/ город
217 + "inn": "string", ~/~/ ИНН
218 + "kpp": "string", ~/~/ КПП
219 + "address": "string", ~/~/ юридический адрес
220 + "addressFact": "string", ~/~/ фактический адрес
221 + "email": "string", ~/~/ email
222 + "director": "string", ~/~/ ФИО руководителя
223 + "bankName": "string", ~/~/ банк
224 + "bankBIK": "string", ~/~/ БИК
225 + "bankRS": "string", ~/~/ номер счёта
226 + "bankKS": "string" ~/~/ корр. счёт
227 +}
111 111  
112 - **Получение списка пользователей.**
113 113  
114 -Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
230 +Ответ:
115 115  
116 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
232 +{
233 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
234 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
235 + "name": "string", ~/~/ имя
236 + "fullName": "string", ~/~/ полное наименование
237 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
238 + "isForeign": true, ~/~/ иностранный контрагент
239 + "district": "string", ~/~/ округ
240 + "region": "string", ~/~/ регион
241 + "city": "string", ~/~/ город
242 + "inn": "string", ~/~/ ИНН
243 + "kpp": "string", ~/~/ КПП
244 + "address": "string", ~/~/ юридический адрес
245 + "addressFact": "string", ~/~/ фактический адрес
246 + "email": "string", ~/~/ email
247 + "director": "string", ~/~/ ФИО руководителя
248 + "bankName": "string", ~/~/ банк
249 + "bankBIK": "string", ~/~/ БИК
250 + "bankRS": "string", ~/~/ номер счёта
251 + "bankKS": "string" ~/~/ корр. счёт
252 +}
117 117  
118 -Метод запроса: POST
254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
119 119  
120 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
276 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
121 121  
122 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
278 +(% class="box warningmessage" %)
279 +(((
280 +**PUT /api/v3/agents**
281 +)))
123 123  
124 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
125 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
126 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
127 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
283 +Метод позволяет отредактировать клиента, указанного в запросе.
128 128  
285 +Метод запроса: **PUT**
286 +
287 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
288 +
289 +В заголовках запроса: X-Auth: Токен авторизации
290 +
291 +Параметры в теле запроса (JSON):
292 +
293 +{
294 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
295 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
296 + "name": "string", ~/~/ имя
297 + "fullName": "string", ~/~/ полное наименование
298 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
299 + "isForeign": true, ~/~/ иностранный контрагент
300 + "district": "string", ~/~/ округ
301 + "region": "string", ~/~/ регион
302 + "city": "string", ~/~/ город
303 + "inn": "string", ~/~/ ИНН
304 + "kpp": "string", ~/~/ КПП
305 + "address": "string", ~/~/ юридический адрес
306 + "addressFact": "string", ~/~/ фактический адрес
307 + "email": "string", ~/~/ email
308 + "director": "string", ~/~/ ФИО руководителя
309 + "bankName": "string", ~/~/ банк
310 + "bankBIK": "string", ~/~/ БИК
311 + "bankRS": "string", ~/~/ номер счёта
312 + "bankKS": "string" ~/~/ корр. счёт
129 129  }
130 130  
131 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
315 +Ответ:
132 132  
133 -{{{ "sessionDuration": "", // длительность сессии в минутах}}}
317 +{
318 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
319 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
320 + "name": "string", ~/~/ имя
321 + "fullName": "string", ~/~/ полное наименование
322 + "isForeign": true, ~/~/ иностранный контрагент
323 + "district": "string", ~/~/ округ
324 + "region": "string", ~/~/ регион
325 + "city": "string", ~/~/ город
326 + "inn": "string", ~/~/ ИНН
327 + "kpp": "string", ~/~/ КПП
328 + "address": "string", ~/~/ юридический адрес
329 + "addressFact": "string", ~/~/ фактический адрес
330 + "email": "string", ~/~/ email
331 + "director": "string", ~/~/ ФИО руководителя
332 + "bankName": "string", ~/~/ банк
333 + "bankBIK": "string", ~/~/ БИК
334 + "bankRS": "string", ~/~/ номер счёта
335 + "bankKS": "string" ~/~/ корр. счёт
336 +}
134 134  
135 - «status»: 1, //статус пользователя «lastLogge: «» //дата/время последней авторизации }, … ]
338 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
136 136  
137 - **Получение списка типов устройств**
340 +(% class="box errormessage" %)
341 +(((
342 +**DELETE /api/v3/agents/{clientId}**
343 +)))
138 138  
139 -Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
345 +Метод позволяет удалить клиента, указанного в строке запроса.
140 140  
141 -Метод запроса: GET
347 +Метод запроса: **DELETE**
142 142  
143 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
349 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
144 144  
145 -В заголовках запроса:X-Auth: Токен авторизации
351 +Параметр запроса: **{clientId}** - Guid пользователя
146 146  
147 -Ответ: [
353 +В заголовках запроса: X-Auth: Токен авторизации
148 148  
149 -{{{ {
150 - "deviceTypeId" : "", // ID типа устройства
151 - "deviceTypeName" : "" // Название типа устройства
152 - },}}}
355 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
153 153  
154 - ]
357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
155 155  
156 - **Получение списка типов датчиков**
359 +(% class="box warningmessage" %)
360 +(((
361 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 +)))
157 157  
158 -Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
364 +Метод позволяет изменить статус клиента, указанного в запросе.
159 159  
160 -Метод запроса: GET
366 +В пути указывается GUID клиента и статус клиента.
161 161  
162 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
368 +**status **- значение 0 - заблокирован, 1 - активен.
163 163  
164 -В заголовках запроса:X-Auth: Токен авторизации
370 +Ответ: Code 204
165 165  
166 -Ответ: [
372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
167 167  
168 -{{{ {}}}
374 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
169 169  
170 -«id»: «», //ID типа датчика «name»: «», //Название
376 +(% class="box successmessage" %)
377 +(((
378 +(% lang="en-US" %)**POST /api/v3/users**
379 +)))
171 171  
172 -{{{ "description": "" // Описание
173 - },}}}
381 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
174 174  
175 - ]
383 +(% style="color:#000000" %)Метод запроса: **POST**
176 176  
177 - **Получение информации об объекте**
385 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
178 178  
179 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
387 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
180 180  
181 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
389 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
182 182  
183 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
391 +(% style="color:#000000" %)
392 +{ 
393 + "lastName": "", ~/~/ фамилия
394 + "firstName": "", ~/~/ имя
395 + "position": "", ~/~/ должность
396 + "phone": "", ~/~/ телефон
397 + "organization": "", ~/~/ организация
398 + "login": "", ~/~/ логин (обязателен)
399 + "password": "", ~/~/ пароль (обязателен)
400 + "email": "", ~/~/ email (обязателен)
401 + "description": "string", ~/~/ Описание
402 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
403 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
404 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
405 + "parentId": "", ~/~/ Guid родительского агента
406 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
407 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
408 + "doubleAuth":
409 + {
410 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
411 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
412 + },
413 + "groups":
414 + [
415 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
416 + ],
417 + "customGroups":
418 + [
419 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
420 + ],
421 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
422 +}
184 184  
185 -Метод запроса: GET
424 +{
425 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
426 + "lastName": "string",
427 + "firstName": "string",
428 + "position": "string",
429 + "phone": "string",
430 + "organization": "string",
431 + "login": "string",
432 + "password": "string",
433 + "email": "string",
186 186  
187 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
435 +(% style="text-align:left" %)
436 +(% style="color:#000000; font-weight:normal" %)Ответ:
188 188  
189 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
438 +(% style="text-align:left" %)
439 +(% style="color:#000000; font-weight:normal" %){    
190 190  
191 -В заголовках запроса: X-Auth: Токен авторизации
441 +(% style="text-align:left" %)
442 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
443 + "lastName": "" , ~/~/ Фамилия ,
444 + "firstName": "" , ~/~/ Имя
445 + "position": "" , ~/~/ Должность
446 + "phone": "" , ~/~/ Телефон
447 + "organization": "" , ~/~/ Организация
448 + "login": "" , ~/~/ Логин
449 + "password": "" , ~/~/ Пароль
450 + "email": "" , ~/~/ Email
451 + "description": "" , ~/~/ Описание
452 + "isEnabled": "" , ~/~/ Признак включения
453 + "parentId": "" , ~/~/ Guid родительского агента
454 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
455 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
456 + "kind": "" , ~/~/ тип аутентификации
457 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
458 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
192 192  
460 +(% style="text-align:left" %)
461 +(% style="color:#000000; font-weight:normal" %)}
462 +
463 +
464 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 +
466 +(% class="box infomessage" %)
467 +(((
468 +(% lang="en-US" %)**POST /api/v3/users/find**
469 +)))
470 +
471 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
472 +
473 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
474 +
475 +(% style="color:#000000" %)Метод запроса: **POST**
476 +
477 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
478 +
479 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
480 +
481 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
482 +
483 +(% style="color:#000000" %){
484 +
485 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
486 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
487 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
488 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
489 +
490 +(% style="color:#000000" %)}
491 +
492 +(% style="color:#000000" %)Ответ:
493 +
494 +(% style="color:#000000" %){         (%%)
495 +
496 + "id": "" , ~/~/ идентификатор пользователя
497 + "lastName": "" , ~/~/ фамилия
498 + "firstName": "" , ~/~/ имя
499 + "position": "" , ~/~/ должность
500 + "phone": "" , ~/~/ телефон
501 + "parentId": "" , ~/~/ идентификатор клиента-родителя
502 + "parentName": "" , ~/~/ наименование клиента-родителя
503 + "organization": "" , ~/~/ организация
504 + "login": "" , ~/~/ логин
505 + "email": "" , ~/~/ E-mail
506 + "sessionDuration":"", ~/~/ длительность сессии в минутах
507 + "status": "1",  ~/~/ статус пользователя
508 + "lastLogged": "", ~/~/ дата/время последней авторизации
509 +
510 +(% style="color:#000000" %)}
511 +
512 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
513 +
514 +(% class="box infomessage" %)
515 +(((
516 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
517 +)))
518 +
519 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
520 +
521 +(% style="color:#000000" %)Метод запроса: **GET**
522 +
523 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
524 +
525 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
526 +
527 +(% style="color:#000000" %)Ответ:
528 +
529 +(((
530 +(((
531 +{
532 + "id": "", ~/~/ GUID пользователя
533 + "lastName": "", ~/~/ Фамилия 
534 + "firstName": "", ~/~/ Имя
535 + "position": "", ~/~/ Должность
536 + "phone": "", ~/~/ Номер телефона
537 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
538 + "parentName": "", Наименование клиента, которому принадлежит пользователь
539 + "organization": "", ~/~/ Организация
540 + "login": "", ~/~/ Логин пользователя
541 + "email": "", ~/~/ Адрес электронной почты
542 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
543 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
544 + "description": "", ~/~/ Описание
545 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
546 + "doubleAuth":
547 + {
548 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
549 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
550 + },
551 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
552 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
553 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
554 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
555 + "groups": [], ~/~/ Список ролей пользователя
556 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
557 + "authDevices": [ ], ~/~/ Список авторизованных устройств
558 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
559 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
560 +}
561 +)))
562 +)))
563 +
564 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
565 +
566 +(% class="box warningmessage" %)
567 +(((
568 +(% lang="en-US" %)**PUT /api/v3/users**
569 +)))
570 +
571 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
572 +
573 +(% style="color:#000000" %)Метод запроса: **PUT**
574 +
575 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
576 +
577 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
578 +
579 +(% lang="en-US" style="text-align:left" %)
580 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
581 +
582 +(% lang="en-US" style="text-align:left" %)
583 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
584 +
585 +(% lang="en-US" style="text-align:left" %)
586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
587 + "lastName": "" , ~/~/ фамилия
588 + "firstName": "" , ~/~/ имя
589 + "position": "" , ~/~/ должность
590 + "phone": "" , ~/~/ телефон
591 + "organization": "" , ~/~/ организация
592 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
593 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
594 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
595 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
596 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
597 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
598 + "isEnabled": "" , ~/~/ признак включения
599 + "parentId": "" , ~/~/ Guid родительского агента
600 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
601 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
602 + "doubleAuth":
603 + {
604 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
605 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
606 + },
607 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
608 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
609 +
610 +(% lang="en-US" style="text-align:left" %)
611 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
612 +
613 +(% lang="en-US" style="text-align:left" %)
614 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
615 +
616 +(% lang="en-US" style="text-align:left" %)
617 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
618 +
619 +(% lang="en-US" style="text-align:left" %)
620 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
621 + "lastName": "" , ~/~/ фамилия
622 + "firstName": "" , ~/~/ имя
623 + "position": "" , ~/~/ должность
624 + "phone": "" , ~/~/ телефон
625 + "organization": "" , ~/~/ организация
626 + "login": "" , ~/~/ логин
627 + "password": "" , ~/~/ пароль 
628 + "email": "" , ~/~/ email
629 + "description": "" , ~/~/ описание
630 + "isEnabled": "" , ~/~/ признак включения
631 + "parentId": "" , ~/~/ Guid родительского агента
632 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
633 + "doubleAuth":
634 + {
635 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
636 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
637 + },
638 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
639 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
640 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
641 +
642 +(% lang="en-US" style="text-align:left" %)
643 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
644 +
645 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
646 +
647 +(% class="box warningmessage" %)
648 +(((
649 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
650 +)))
651 +
652 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
653 +
654 +(% style="color:#000000" %)Метод запроса: **PUT**
655 +
656 +(% 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}
657 +
658 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
659 +
660 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
661 +
662 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
663 +
664 +(% style="color:#000000" %){
665 +
666 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
667 + "description": "" , ~/~/ описание
668 + "data": "" , ~/~/ данные, связанные со сменой статуса
669 +
670 +(% style="color:#000000" %)}
671 +
672 +(% style="text-align:left" %)
673 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
674 +
675 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
676 +
677 +(% class="box warningmessage" %)
678 +(((
679 +**POST /api/v3/users/disable**
680 +)))
681 +
682 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
683 +
684 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
685 +
686 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
687 +
688 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
689 +
690 + [ 
691 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
692 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
693 + ]
694 +
695 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
696 +
697 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
698 +
699 +(% class="box warningmessage" %)
700 +(((
701 +**POST /api/v3/users/enable**
702 +)))
703 +
704 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
705 +
706 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
707 +
708 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
709 +
710 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
711 +
712 + [ 
713 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
714 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
715 + ]
716 +
717 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
718 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
719 +
720 +(((
721 +В теле ответа:
722 +{
723 + "errorMessages": [
724 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
725 + ],
726 + "users": [
727 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
728 + ]
729 +}
730 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
731 +"users" - массив id пользователей, которых не удалось включить или отключить.
732 +)))
733 +
734 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
735 +
736 +(% class="box errormessage" %)
737 +(((
738 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
739 +)))
740 +
741 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
742 +
743 +(% style="color:#000000" %)Метод запроса: **DELETE**
744 +
745 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
746 +
747 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
748 +
749 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
750 +
751 +(% style="text-align:left" %)
752 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
753 +
754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
755 +
756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
757 +
758 +(% class="box infomessage" %)
759 +(((
760 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
761 +)))
762 +
763 +Метод возвращает полную информацию о модели объекта.
764 +
765 +(% style="color:#000000" %)Метод запроса: **GET**
766 +
767 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
768 +
769 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
770 +
771 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
772 +
773 +(% style="color:#000000" %)Ответ:
774 +
775 +(% style="color:#000000" %){
776 + "parentName": "string",
777 + "name": "string",
778 + "picture": "string",
779 + "minspeed": 0,
780 + "maxspeed": 0,
781 + "width": 0,
782 + "imbeddedtrailer": true,
783 + "hoppercapacity": 0,
784 + "hopperdischargespeed": 0,
785 + "modelType": 0,
786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788 + "deleted": true
789 +}
790 +
791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
792 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
793 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
794 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
795 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
796 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
799 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
801 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
804 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
805 +
806 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
807 +
808 +(% class="box successmessage" %)
809 +(((
810 +(% lang="en-US" %)**POST /api/v3/models/find**
811 +)))
812 +
813 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
814 +
815 +(% style="color:#000000" %)Метод запроса: **POST**
816 +
817 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
818 +
819 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
820 +
821 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
822 +
823 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
824 +}
825 +
826 +(% style="color:#000000" %)Ответ:
827 +
828 +(% style="color:#000000" %)[
829 + {
830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "parentName": "string",
833 + "name": "string",
834 + "modelType": 0
835 + }
836 +]
837 +
838 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
839 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
840 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
841 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
842 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
844 +
845 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
846 +
847 +(% class="box successmessage" %)
848 +(((
849 +(% lang="en-US" %)**POST /api/v3/models**
850 +)))
851 +
852 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
853 +
854 +(% style="color:#000000" %)Метод запроса: **POST**
855 +
856 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
857 +
858 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
859 +
860 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
861 +
862 +{
863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 + "deleted": true,
866 + "extId": "string",
867 + "name": "string",
868 + "picture": "string",
869 + "minspeed": 0,
870 + "maxspeed": 0,
871 + "width": 0,
872 + "imbeddedtrailer": true,
873 + "fueloutlay": 0,
874 + "hoppercapacity": 0,
875 + "hopperdischargespeed": 0,
876 + "modelType": 0
877 +}
878 +
193 193  Ответ:
194 194  
195 195  {
882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
883 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
884 + "deleted": true,
885 + "extId": "string",
886 + "name": "string",
887 + "picture": "string",
888 + "minspeed": 0,
889 + "maxspeed": 0,
890 + "width": 0,
891 + "imbeddedtrailer": true,
892 + "hoppercapacity": 0,
893 + "hopperdischargespeed": 0,
894 + "modelType": 0
895 +}
196 196  
197 -{{{ "vehicleId": “”, // идентификатор объекта
198 - "name": "", // имя объекта
199 - "imei": "", // IMEI объекта
200 - "deviceTypeId": “”, // идентификатор устройства объекта
201 - "deviceTypeName": "" // наименование устройства объекта
202 - "parentId": "", // идентификатор клиента-родителя
203 - "parentName": "" // наименование клиента-родителя,
204 - "modelId": "", // идентификатор модели объекта
205 - "modelName": "" // наименование модели объекта,
206 - "unitId": "", // идентификатор подразделения
207 - "unitName": "", // наименование подразделения
208 - "status": “”, // статус объекта
209 - ...
897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 +
911 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 +
913 +(% class="box warningmessage" %)
914 +(((
915 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
916 +)))
917 +
918 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
919 +
920 +(% style="color:#000000" %)Метод запроса: **PUT**
921 +
922 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
923 +
924 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
925 +
926 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
927 +
928 +{
929 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 + "deleted": true,
932 + "extId": "string",
933 + "name": "string",
934 + "picture": "string",
935 + "minspeed": 0,
936 + "maxspeed": 0,
937 + "width": 0,
938 + "imbeddedtrailer": true,
939 + "fueloutlay": 0,
940 + "hoppercapacity": 0,
941 + "hopperdischargespeed": 0,
942 + "modelType": 0
943 +}
944 +
945 +Ответ:
946 +
947 +{
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
950 + "deleted": true,
951 + "extId": "string",
952 + "name": "string",
953 + "picture": "string",
954 + "minspeed": 0,
955 + "maxspeed": 0,
956 + "width": 0,
957 + "imbeddedtrailer": true,
958 + "fueloutlay": 0,
959 + "hoppercapacity": 0,
960 + "hopperdischargespeed": 0,
961 + "modelType": 0
962 +}
963 +
964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 +
978 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 +
980 +(% class="box errormessage" %)
981 +(((
982 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
983 +)))
984 +
985 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
986 +
987 +(% style="color:#000000" %)Метод запроса: **DELETE**
988 +
989 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
990 +
991 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
992 +
993 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
994 +
995 +Ответ: В случае успеха **Success 200**
996 +
997 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
998 +
999 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1000 +
1001 +(% class="box infomessage" %)
1002 +(((
1003 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1004 +)))
1005 +
1006 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1007 +
1008 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1009 +
1010 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1011 +
1012 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1013 +
1014 +(% style="color:#000000" %)Метод запроса: **GET**
1015 +
1016 +(% 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}
1017 +
1018 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1019 +
1020 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1021 +
1022 +(% style="color:#000000" %)Ответ:
1023 +
1024 +(((
1025 +{
1026 + "vehicleId": "", ~/~/ ID объекта
1027 + "name": "", ~/~/ Имя объекта
1028 + "imei": "", ~/~/ IMEI объекта
1029 + "deviceTypeId": , ~/~/ ID типа устройства
1030 + "deviceTypeName": "", ~/~/ Название типа устройства
1031 + "sim1": "", ~/~/ Номер SIM1
1032 + "sim2": "", ~/~/ Номер SIM2
1033 +
1034 + "parentId": "", ~/~/ ID клиента-родителя
1035 + "parentName": "", ~/~/ Наименование клиента-родителя
1036 + "modelId": "", ~/~/ ID модели объекта
1037 + "modelName": "", ~/~/ Имя модели объекта
1038 +
1039 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1040 + "unitName": "string", ~/~/ Наименование подразделения
1041 + "status": 0, ~/~/ Статус объекта
1042 +
1043 + "createdAt": "", ~/~/ Дата создания объекта
1044 + },
1045 +
1046 +"customFields": [ ~/~/ Произвольные поля
1047 + {
1048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1049 + "name": "string", ~/~/ Имя поля
1050 + "value": "string", ~/~/ Значение поля
1051 + "forClient": true, ~/~/ Не используемая функция
1052 + "forTooltip": true, ~/~/ Отображать в подсказке
1053 + "forReport": true ~/~/ Отображать в отчете
1054 + }
1055 +
1056 +], ~/~/ Данные с вкладки нормы
1057 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1058 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1059 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1060 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1061 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1062 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1063 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1064 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1065 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1066 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1067 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1068 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1069 +
1070 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1071 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1072 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1073 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1074 + "counters": { ~/~/ Счетчики
1075 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1076 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1077 + "mileage": 0, ~/~/ Текущий пробег
1078 + "motohours": 0, ~/~/ Текущие моточасы
1079 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1080 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
210 210   },
211 - ...}}}
212 212  
1083 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1084 + "id": "string", ~/~/ ID объекта
1085 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1086 + "host": "string", ~/~/ CMSV6 Web Host
1087 + "login": "string", ~/~/ CMSV6 Account
1088 + "password": "string" ~/~/ CMSV6 Password
1089 + },
1090 +
1091 +"commandTemplates": [ ~/~/ Шаблоны команд
1092 + {
1093 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1094 + "name": "string", ~/~/ Наименование команды
1095 + "command": "string", ~/~/ Текст команды
1096 + "retries": 0 ~/~/ Количество попыток
1097 + }
1098 + ],
1099 +
1100 + "sensors": [ ~/~/ Датчики
1101 + {
1102 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1103 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1104 + "type": 0, ~/~/ Тип датчика
1105 + "name": "string", ~/~/ Имя датчика
1106 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1107 + "inputNumber": 0, ~/~/ Номер входа
1108 + "pseudonym": "string", ~/~/ Псевдоним
1109 + "medianDegree": 0, ~/~/ Медианная фильтрация
1110 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1111 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1112 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1113 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1114 + {
1115 + "grades": [ ~/~/ Таблица тарировки 1
1116 + {
1117 + "input": 0, ~/~/ Входящее значение
1118 + "output": 0 ~/~/ Выходящее значение
1119 + }
1120 + ],
1121 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1122 + }
1123 + ],
1124 + "showInTooltip": true, ~/~/ Отображать в подсказке
1125 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1126 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1127 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1128 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1129 + "expr": "string", ~/~/ Формула
1130 + "children": [ ~/~/ массив дочерних датчиков
1131 + "string"
1132 + ],
1133 + "customParams": { ~/~/ прочие произвольные параметры
1134 + "additionalProp1": "string",
1135 + "additionalProp2": "string",
1136 + "additionalProp3": "string"
1137 + },
1138 +
1139 +~/~/ Характерные для произвольного:
1140 +
1141 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1142 +
1143 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1144 +
1145 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1146 +
1147 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 +
1149 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1150 +
1151 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1152 +
1153 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1154 +
1155 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1156 +
1157 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1158 +
1159 +~/~/ "ValueOn": "Вкл.",
1160 +
1161 +~/~/ "ValueOff": "Выкл."
1162 + "summaryMaxValue": 0 ~/~/ Макс. значение
1163 + }
1164 +
1165 + "drivers": [ ~/~/ Водители
1166 + {
1167 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1168 + "name": "string", ~/~/ Наименование
1169 + "description": "string",
1170 + "isDefault": true ~/~/ По умолчанию
1171 + }
1172 + ],
1173 +
1174 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1175 + {
1176 + "id": "", ~/~/ ID  задания
1177 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1178 + "name": "", ~/~/ Наименование задания
1179 + "description": "", ~/~/ Описание задания
1180 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1181 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1182 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1183 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1184 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1185 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1186 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1187 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1188 + }
1189 + ],
1190 +
1191 + "statusHistory": [ ~/~/ История статусов
1192 + {
1193 + "status": 0,
1194 + "date": "2023-05-22T09:57:39.562Z",
1195 + "description": "string",
1196 + "additionalInfo": "string"
1197 + }
1198 + ]
1199 +
213 213  }
1201 +)))
214 214  
215 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
1203 +(% style="text-align:left" %)
1204 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
216 216  
217 - **Добавление пользователя**
1206 +(% style="text-align:left" %)
1207 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
218 218  
219 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1209 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
220 220  
221 -Метод запроса: POST
1211 +(% class="box successmessage" %)
1212 +(((
1213 +(% lang="en-US" %)**POST /api/v3/vehicles**
1214 +)))
222 222  
223 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1216 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
224 224  
225 -В заголовках запроса: X-Auth: Токен авторизации
1218 +(% style="color:#000000" %)Метод запроса: **POST**
226 226  
227 -Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
1220 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
228 228  
229 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
1222 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
230 230  
231 - **Редактирование пользователя**
1224 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
232 232  
233 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Aut)
1226 +(% style="color:#000000" %){
234 234  
235 -Метод запроса: PUT
1228 + "parentId": "" , ~/~/ ID клиента
1229 + "name": "" , ~/~/ имя ТС
1230 + "imei": "" , ~/~/ IMEI
1231 + "deviceTypeId": "" , ~/~/ ID типа устройства
1232 + "modelId": "" , ~/~/ ID модели
1233 + "unitId": "" , ~/~/ ID подразделения
1234 + "sim1": "" , ~/~/ Номер SIM 1
1235 + "sim2": "" , ~/~/ Номер SIM2
1236 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1237 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1238 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1239 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1240 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1241 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1242 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1243 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1244 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1245 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1246 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1247 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
236 236  
237 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1249 + "mileageCalcMethod": 0,
1250 + "mileageCoeff": 0,
1251 + "locationByCellId": true,
1252 + "dottedLineTrackWhenNoCoords": true,
1253 + "counters": ~/~/ счетчики
1254 + {
1255 + "mileage": "" , ~/~/ пробег
1256 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1257 + "motohours": "" , ~/~/ моточасы
1258 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1259 + },
1260 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1261 + "enabled": true, ~/~/ флаг включения
1262 + "id": "" , ~/~/ идентификатор
1263 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1264 + "login": "" , ~/~/ имя учетной записи
1265 + "password": "" ~/~/ пароль учетной записи
1266 + },
1267 + "inspectionTasks": ~/~/ задания на ТО
1268 + {
1269 + "enabled": "" , ~/~/ Признак включения
1270 + "name": "" , ~/~/ Имя задания
1271 + "description": "" , ~/~/ Описание задания
1272 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1273 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1274 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1275 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1276 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1277 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1278 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1279 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1280 + }
238 238  
239 -В заголовках запроса: X-Auth: Токен авторизации
1282 +"drivers": [ ~/~/ Водители
1283 + {
1284 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1285 + "isDefault": true
1286 + }
1287 + ],
1288 + "commandTemplates": [ ~/~/ Шаблон команды
1289 + {
1290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1291 + "name": "string",
1292 + "command": "string",
1293 + "retries": 0
1294 + }
1295 + ],
240 240  
241 -Параметры в теле запроса (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 - блокирован)
1297 + "sensors": [ ~/~/ Датчики
1298 + {
1299 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1300 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1301 + "type": 0, ~/~/ Тип датчика
1302 + "name": "string", ~/~/ Имя датчика
1303 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1304 + "inputNumber": 0, ~/~/ Номер входа
1305 + "pseudonym": "string", ~/~/ Псевдоним
1306 + "medianDegree": 0, ~/~/ Медианная фильтрация
1307 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1308 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1309 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1310 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1311 + {
1312 + "grades": [ ~/~/ Таблица тарировки 1
1313 + {
1314 + "input": 0, ~/~/ Входящее значение
1315 + "output": 0 ~/~/ Выходящее значение
1316 + }
1317 + ],
1318 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1319 + }
1320 + ],
1321 + "showInTooltip": true, ~/~/ Отображать в подсказке
1322 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1323 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1324 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1325 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1326 + "expr": "string", ~/~/ Формула
1327 + "children": [ ~/~/ массив дочерних датчиков
1328 + "string"
1329 + ],
1330 + "customParams": { ~/~/ прочие произвольные параметры
1331 + "additionalProp1": "string",
1332 + "additionalProp2": "string",
1333 + "additionalProp3": "string"
1334 + },
242 242  
243 -{{{ "description": "", // описание
244 - "data": "" // данные, связанные со сменой статуса}}}
1336 +~/~/ Характерные для произвольного:
245 245  
1338 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1339 +
1340 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1341 +
1342 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1343 +
1344 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1345 +
1346 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1347 +
1348 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1349 +
1350 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1351 +
1352 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1353 +
1354 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1355 +
1356 +~/~/ "ValueOn": "Вкл.",
1357 +
1358 +~/~/ "ValueOff": "Выкл."
1359 + "summaryMaxValue": 0 ~/~/ Макс. значение
1360 + }
1361 + ],
1362 + "customFields": [ ~/~/ Произвольные поля
1363 + {
1364 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1365 + "name": "string",
1366 + "value": "string",
1367 + "forClient": true,
1368 + "forTooltip": true,
1369 + "forReport": true
1370 + }
1371 + ]
246 246  }
247 247  
248 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
1374 +(% style="color:#000000" %)Ответ:
249 249  
250 - **Удаление пользователя**
1376 +(% style="color:#000000" %){
251 251  
252 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1378 + "vehicleId": "", ~/~/ID ТС 
1379 + "parentId": "", ~/~/Guid владельца ТС
1380 + "name": "", ~/~/Имя объекта
1381 + "imei": "", ~/~/IMEI
1382 + "deviceTypeId": "", ~/~/ID типа устройства
1383 + "modelId": "", ~/~/ID модели
1384 + "unitId": "", ~/~/ID подразделения
1385 + "sim1": "", ~/~/SIM1
1386 + "sim2": "", ~/~/SIM2
1387 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1388 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1389 + "counters": { ~/~/Счётчики
1390 + "mileageEnabled": true,
1391 + "motohoursEnabled": true,
1392 + "mileage": "",
1393 + "motohours": 345.0
1394 + },
1395 + "cmsv6Parameters": { ~/~/Параметры CmsV6
1396 + "id": null,
1397 + "enabled": true, ~/~/флаг включения
1398 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1399 + "login": "", ~/~/ имя учетной записи
1400 + "password": "" ~/~/ пароль учетной записи
1401 + },
1402 + "inspectionTasks": { ~/~/ задания на ТО
1403 + "id": "", ~/~/ ID задачи
1404 + "enabled": false, ~/~/ Признак включения
1405 + "name": "", ~/~/ Имя задания
1406 + "description": "", ~/~/ Описание задания
1407 + "mileageCondition": "", ~/~/ Условие по пробегу
1408 + "lastMileage": "", ~/~/ Пробег (в метрах)
1409 + "motohoursCondition": "", ~/~/ Условие по моточасам
1410 + "lastMotohours": "", ~/~/ Моточасы
1411 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1412 + "kind": "", ~/~/ Вид периодичности по времени 
1413 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1414 + }
253 253  
254 -Метод запроса: DELETE
1416 +(% style="text-align:left" %)
1417 +(% style="color:#000000" %)}
255 255  
256 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
1419 +**Валидация:**
1420 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1421 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1422 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
257 257  
258 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1424 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
259 259  
260 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
1426 +(% class="box infomessage" %)
1427 +(((
1428 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
1429 +)))
261 261  
262 - **Добавление объекта**
1431 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
263 263  
264 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1433 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
265 265  
266 -Метод запроса: POST
1435 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
267 267  
268 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1437 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
269 269  
270 -В заголовках запроса: X-Auth: Токен авторизации
1439 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
271 271  
272 -Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1441 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
273 273  
274 -{{{ "parentId": "", // ID клиента
275 - "name": "", // имя ТС
276 - "imei": "", // IMEI
277 - "deviceTypeId": "",// ID типа устройства
278 - "modelId": "",
279 - "unitId": "", // ID подразделения
280 - "sim1": "", // Номер SIM 1
281 - "sim2": "", // Номер SIM2
282 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
283 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
284 - "consumptionIdle": "",// Расход топлива на холостом ходу
285 - "counters": {
286 - "mileage": "", // пробег
287 - "mileageEnabled": true, // флаг активности счётчика "пробег"
288 - "motohours":"", // моточасы
289 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
290 - },
291 - "cmsv6Parameters": { // параметры CMSv6
292 - "enabled": true, // флаг включения
293 - //"id": "", // идентификатор
294 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
295 - "login": "", // имя учетной записи
296 - "password": "" // пароль учетной записи
1443 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1444 +
1445 +(% style="color:#000000" %)Метод запроса: **POST**
1446 +
1447 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1448 +
1449 +(% style="color:#000000" %)В заголовках запроса:
1450 +
1451 +(% style="color:#000000" %)− Content-Type: __**application/json**__
1452 +
1453 +(% style="color:#000000" %)− X-Auth: Токен авторизации
1454 +
1455 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1456 +
1457 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
1458 +
1459 +{
1460 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1461 + "name": null, ~/~/ Имя ТС (string, опционально)
1462 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1463 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1464 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1465 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1466 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1467 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1468 +}
1469 +
1470 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1471 +
1472 +(% style="color:#000000" %)Ответ:
1473 +
1474 +(% style="color:#000000" %){
1475 +
1476 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1477 + "name": "" ~/~/ наименование объекта
1478 + "imei": "" ~/~/ IMEI объекта
1479 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
1480 + "deviceTypeName": "" ~/~/ наименование типа устройства
1481 + "sim1": "" ~/~/ первый номер телефона
1482 + "sim2": "" ~/~/ второй номер телефона
1483 + "parentId": "" ~/~/ идентификатор клиента-родителя
1484 + "parentName": "" ~/~/ наименование клиента-родителя
1485 + "modelId": "" ~/~/ идентификатор модели объекта
1486 + "modelName": "" ~/~/ наименование модели объекта
1487 + "unitId": "" ~/~/ идентификатор подразделения
1488 + "unitName": "" ~/~/ наименование подразделения
1489 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1490 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1491 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1492 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1493 + "customFields": [ 
1494 + {
1495 + "id": "", ~/~/ идентификатор произвольного поля
1496 + "name": "", ~/~/ имя произвольного поля
1497 + "value": "", ~/~/ значение произвольного поля
1498 + "forClient": true, ~/~/ право на отображение у клиента
1499 + "forTooltip": false, ~/~/ право на отображение в подсказке
1500 + "forReport": false ~/~/ право на отображение в отчетах
1501 + }(%%)
1502 +(% style="color:#000000" %)}
1503 +
1504 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1505 +
1506 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1507 +
1508 +(% class="box successmessage" %)
1509 +(((
1510 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1511 +)))
1512 +
1513 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1514 +
1515 +(% style="color:#000000" %)Метод запроса: **POST**
1516 +
1517 +(% 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}
1518 +
1519 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1520 +
1521 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1522 +
1523 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
1524 +
1525 +(% style="color:#000000" %){
1526 +
1527 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1528 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1529 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1530 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1531 + "description": "", ~/~/ Описание
1532 + "data": "", ~/~/ Данные
1533 + "overwrite": false, ~/~/ Флаг перезаписи
1534 + "stage": "", ~/~/ Состояние, может быть null
1535 +
1536 +(% style="color:#000000" %)}
1537 +
1538 +(% style="color:#000000" %)Ответ:
1539 +
1540 +(% style="color:#000000" %){
1541 +
1542 + "status": "", ~/~/ значение статуса
1543 + "date": "", ~/~/ Дата смены статуса 
1544 + "description": "", ~/~/ Описание
1545 + "data": "", ~/~/ Данные
1546 + "overwrite": false, ~/~/ Флаг перезаписи
1547 + "stage": "", ~/~/ Состояние
1548 +
1549 +(% style="text-align:left" %)
1550 +(% style="color:#000000" %) }
1551 +
1552 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1553 +
1554 +(% class="box warningmessage" %)
1555 +(((
1556 +(% lang="en-US" %)**PUT /api/v3/vehicles**
1557 +)))
1558 +
1559 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1560 +
1561 +(% style="color:#000000" %)Метод запроса: **PUT**
1562 +
1563 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1564 +
1565 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1566 +
1567 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
1568 +
1569 +(% style="color:#000000" %){
1570 + "vehicleId": , ~/~/ ID объекта
1571 + "parentId": "" , ~/~/ ID клиента
1572 + "name": "" , ~/~/ имя ТС
1573 + "imei": "" , ~/~/ IMEI
1574 + "deviceTypeId": "" , ~/~/ ID типа устройства
1575 + "modelId": "" , ~/~/ ID модели
1576 + "unitId": "" , ~/~/ ID подразделения
1577 + "sim1": "" , ~/~/ Номер SIM 1
1578 + "sim2": "" , ~/~/ Номер SIM2
1579 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1580 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1581 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1582 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1583 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1584 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1585 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1586 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1587 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1588 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1589 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1590 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1591 +
1592 + "mileageCalcMethod": 0,
1593 + "mileageCoeff": 0,
1594 + "locationByCellId": true,
1595 + "dottedLineTrackWhenNoCoords": true,
1596 + "counters": ~/~/ счетчики
1597 + {
1598 + "mileage": "" , ~/~/ пробег
1599 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1600 + "motohours": "" , ~/~/ моточасы
1601 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
297 297   },
298 - "inspectionTasks": [ // задания на ТО
1603 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1604 + "enabled": true, ~/~/ флаг включения
1605 + "id": "" , ~/~/ идентификатор
1606 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1607 + "login": "" , ~/~/ имя учетной записи
1608 + "password": "" ~/~/ пароль учетной записи
1609 + },
1610 + "inspectionTasks": ~/~/ задания на ТО
299 299   {
300 - "enabled": "", // Признак включения
301 - "name": "", // Имя задания
302 - "description": "", // Описание задания
303 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
304 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
305 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
306 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
307 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
308 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
309 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
310 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1612 + "enabled": "" , ~/~/ Признак включения
1613 + "name": "" , ~/~/ Имя задания
1614 + "description": "" , ~/~/ Описание задания
1615 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1616 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1617 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1618 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1619 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1620 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1621 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1622 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1623 + }
1624 +
1625 +"drivers": [ ~/~/ Водители
1626 + {
1627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1628 + "isDefault": true
1629 + }
1630 + ],
1631 + "commandTemplates": [ ~/~/ Шаблон команды
1632 + {
1633 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1634 + "name": "string",
1635 + "command": "string",
1636 + "retries": 0
1637 + }
1638 + ],
1639 +
1640 + "sensors": [ ~/~/ Датчики
1641 + {
1642 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1643 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1644 + "type": 0, ~/~/ Тип датчика
1645 + "name": "string", ~/~/ Имя датчика
1646 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1647 + "inputNumber": 0, ~/~/ Номер входа
1648 + "pseudonym": "string", ~/~/ Псевдоним
1649 + "medianDegree": 0, ~/~/ Медианная фильтрация
1650 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1651 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1652 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1653 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1654 + {
1655 + "grades": [ ~/~/ Таблица тарировки 1
1656 + {
1657 + "input": 0, ~/~/ Входящее значение
1658 + "output": 0 ~/~/ Выходящее значение
1659 + }
1660 + ],
1661 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1662 + }
1663 + ],
1664 + "showInTooltip": true, ~/~/ Отображать в подсказке
1665 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1666 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1667 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1668 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1669 + "expr": "string", ~/~/ Формула
1670 + "children": [ ~/~/ массив дочерних датчиков
1671 + "string"
1672 + ],
1673 + "customParams": { ~/~/ прочие произвольные параметры
1674 + "additionalProp1": "string",
1675 + "additionalProp2": "string",
1676 + "additionalProp3": "string"
311 311   },
312 - ]}}}
313 313  
314 - }
1679 +~/~/ Характерные для произвольного:
315 315  
1681 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1682 +
1683 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1684 +
1685 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1686 +
1687 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1688 +
1689 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1690 +
1691 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1692 +
1693 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1694 +
1695 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1696 +
1697 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1698 +
1699 +~/~/ "ValueOn": "Вкл.",
1700 +
1701 +~/~/ "ValueOff": "Выкл."
1702 + "summaryMaxValue": 0 ~/~/ Макс. значение
1703 + }
1704 + ],
1705 + "customFields": [ ~/~/ Произвольные поля
1706 + {
1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1708 + "name": "string",
1709 + "value": "string",
1710 + "forClient": true,
1711 + "forTooltip": true,
1712 + "forReport": true
1713 + }
1714 + ]
1715 +}
1716 +
1717 +(% style="color:#000000" %)Ответ:
1718 +
1719 +(% lang="en-US" style="text-align:left" %)
1720 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1721 +
1722 +(% lang="en-US" style="text-align:left" %)
1723 + "vehicleId": "", ~/~/ ID ТС
1724 + "parentId": "", ~/~/ ID клиента
1725 + "name": "", ~/~/ имя ТС
1726 + "imei": "", ~/~/ IMEI
1727 + "deviceTypeId": "", ~/~/ типа устройства
1728 + "modelId": "", ~/~/ ID модели
1729 + "unitId": "", ~/~/ ID подразделения
1730 + "sim1": "", ~/~/ SIM 1
1731 + "sim2": "", ~/~/ SIM2
1732 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1733 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1734 + "counters": 
1735 + {
1736 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1737 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1738 + "mileage": "", ~/~/ пробег
1739 + "motohours": "", ~/~/ моточасы
1740 + }
1741 + "cmsv6Parameters": ~/~/ параметры CMSv6
1742 + {
1743 + "id": ~/~/ идентификатор
1744 + "enabled": true, ~/~/ флаг включения
1745 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1746 + "login": "", ~/~/ имя учетной записи
1747 + "password": "", ~/~/ пароль учетной записи
1748 + }
1749 + "inspectionTasks": ~/~/ задания на ТО
1750 + {
1751 + "id": "", ~/~/ ID задания
1752 + "enabled": false, ~/~/ Признак включения
1753 + "name": "", ~/~/ Имя задания
1754 + "description": "", ~/~/ Описание задания
1755 + "mileageCondition": "", ~/~/ Условие по пробегу
1756 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1757 + "motohoursCondition": "", ~/~/ Условие по моточасам
1758 + "lastMotohours": "", ~/~/ Моточасы
1759 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1760 + "kind": "", ~/~/ Вид периодичности по времени
1761 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1762 + }
1763 +
1764 +(% lang="en-US" style="text-align:left" %)
1765 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1766 +
1767 +**Валидация:**
1768 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1769 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1770 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1771 +
1772 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1773 +
1774 +(% class="box errormessage" %)
1775 +(((
1776 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1777 +)))
1778 +
1779 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1780 +
1781 +(% style="color:#000000" %)Метод запроса: **DELETE**
1782 +
1783 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1784 +
1785 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1786 +
1787 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1788 +
1789 +(% style="text-align:left" %)
1790 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1791 +
1792 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1793 +
1794 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1795 +
1796 +(% class="box infomessage" %)
1797 +(((
1798 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1799 +)))
1800 +
1801 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1802 +
1803 +(% style="color:#000000" %)Метод запроса: **GET**
1804 +
1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1806 +
1807 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1808 +
1809 +(% style="color:#000000" %)Ответ:
1810 +
1811 +(% style="color:#000000" %){
1812 +
1813 + "deviceTypeId" : "", ~/~/ ID типа устройства
1814 + "deviceTypeName" : "" ~/~/ Название типа устройства
1815 +
1816 +(% style="text-align:left" %)
1817 +(% style="color:#000000" %)}
1818 +
1819 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1820 +
1821 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1822 +
1823 +(% class="box infomessage" %)
1824 +(((
1825 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1826 +)))
1827 +
1828 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1829 +
1830 +(% style="color:#000000" %)Метод запроса: **GET**
1831 +
1832 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1833 +
1834 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1835 +
1836 +(% style="color:#000000" %)Ответ:
1837 +
1838 +(% style="color:#000000" %){
1839 +
1840 + "id": "", ~/~/ ID типа датчика 
1841 + "name": "", ~/~/ Название
1842 + "description": "", ~/~/ Описание
1843 +
1844 +(% style="text-align:left" %)
1845 +(% style="color:#000000" %)}
1846 +
1847 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1848 +
1849 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1850 +
1851 +(% class="box infomessage" style="text-align: left;" %)
1852 +(((
1853 +**POST /api/v3/terminalMessages/count**
1854 +)))
1855 +
1856 +(% style="text-align: left;" %)
1857 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1858 +
1859 +(% style="text-align: left;" %)
1860 +Метод запроса **POST**
1861 +
1862 +(% style="text-align: left;" %)
1863 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1864 +
1865 +(% style="text-align: left;" %)
1866 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1867 +
1868 +(% style="text-align: left;" %)
1869 +{
1870 + "vehicleIds": [
1871 + id ~/~/ здесь передается список идентификаторов объектов
1872 + ],
1873 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1874 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1875 +}
1876 +
1877 +(% style="text-align: left;" %)
316 316  Ответ:
317 317  
1880 +(% style="text-align: left;" %)
1881 +[
1882 + {
1883 + "vehicleId": 0, ~/~/ идентификатор объекта
1884 + "count": 0 ~/~/ количество сообщений за период
1885 + }
1886 +]
1887 +
1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 +
1890 +(% class="box infomessage" style="text-align: left;" %)
1891 +(((
1892 +**POST /api/v3/terminalMessages/mapping**
1893 +)))
1894 +
1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 +
1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 +
1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 +
318 318  {
1902 + "protocolType": 0,
1903 + "params": ["string"]
1904 +}
319 319  
320 -{{{ "vehicleId": "", //ID ТС
321 - "parentId": "", //Guid владельца ТС
322 - "name": "", //Имя объекта
323 - "imei": "", //IMEI
324 - "deviceTypeId": "", //ID типа устройства
325 - "modelId": "", //ID модели
326 - "unitId": "", //ID подразделения
327 - "sim1": "", //SIM1
328 - "sim2": "", //SIM2
329 - "consumptionPer100Km": "", //Расход топлива на 100 км
330 - "consumptionIdle": "", //Расход топлива на холостом ходу
331 - "counters": { //Счётчики
332 - "mileageEnabled": true,
333 - "motohoursEnabled": true,
334 - "mileage": "",
335 - "motohours": 345.0
336 - },
337 - "cmsv6Parameters": { //Параметры CmsV6
338 - "id": null,
339 - "enabled": true, //флаг включения
340 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
341 - "login": "", // имя учетной записи
342 - "password": "" // пароль учетной записи
343 - },
344 - "inspectionTasks": [ // задания на ТО
1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 +|protocolType|ID типа протокола
1908 +|params|(((
1909 +Массив наименований параметров в сообщении
1910 +)))
1911 +
1912 +Ответ:
1913 +
1914 +{
1915 + "protocolType": 0,
1916 + "mapping": {
1917 + "additionalProp1": {
1918 + "inputType": 0,
1919 + "inputNumber": 0
1920 + },
1921 + "additionalProp2": {
1922 + "inputType": 0,
1923 + "inputNumber": 0
1924 + }
1925 + }
1926 +}
1927 +
1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 +|protocolType|Тип протокола
1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 +|inputNumber|Номер входа
1932 +
1933 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934 +
1935 +(% class="box infomessage" %)
1936 +(((
1937 +**POST /api/v3/terminalMessages**
1938 +)))
1939 +
1940 +Метод возвращает список сообщений терминала объекта за выбранный период.
1941 +
1942 +(% style="text-align: left;" %)
1943 +Метод запроса **POST**
1944 +
1945 +(% style="text-align: left;" %)
1946 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1947 +
1948 +(% style="text-align: left;" %)
1949 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1950 +
1951 +{
1952 + "vehicleId": 0, ~/~/ id объекта
1953 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1954 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 +}
1956 +
1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 +|vehicleId|ID объекта
1959 +|from|Дата и время начала периода запроса
1960 +|to|Дата и время окончания периода запроса
1961 +
1962 +Ответ:
1963 +
1964 +[
1965 + {
1966 + "messages": [
345 345   {
346 - "id": "", // ID задачи
347 - "enabled": false, // Признак включения
348 - "name": "", // Имя задания
349 - "description": "", // Описание задания
350 - "mileageCondition": "", // Условие по пробегу
351 - "lastMileage": "", // Пробег (в метрах)
352 - "motohoursCondition": "", // Условие по моточасам
353 - "lastMotohours": "", // Моточасы
354 - "periodicCondition": "", // Условие периодичности по времени}}}
1968 + "deviceTime": "2023-11-29T07:40:44.052Z",
1969 + "serverTime": "2023-11-29T07:40:44.052Z",
1970 + "speed": 0,
1971 + "altitude": 0,
1972 + "latitude": 0,
1973 + "longitude": 0,
1974 + "satellites": 0,
1975 + "course": 0,
1976 + "voltage": 0,
1977 + "parameters": {
1978 + "additionalProp1": "string",
1979 + "additionalProp2": "string",
1980 + "additionalProp3": "string"
1981 + },
1982 + "photoCount": 0,
1983 + "lbsCorrectedCoords": true,
1984 + "protocolType": 0
1985 + }
1986 + ]
1987 + }
1988 +]
355 355  
356 -{{{ "kind": "", // Вид периодичности по времени
357 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 +|deviceTime|Время сообщения терминала
1992 +|serverTime|Время когда сообщение поступило на сервер
1993 +|speed|Скорость
1994 +|altitude|Высота над уровнем моря
1995 +|latitude|Широта
1996 +|longitude|Долгота
1997 +|satellites|Кол-во спутников
1998 +|course|Курс
1999 +|voltage|Бортовое напряжение
2000 +|parameters|Список параметров и их значений
2001 +|photoCount|Количество фото
2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 +|protocolType|ID типа протокола
2004 +
2005 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 +
2007 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2008 +
2009 +(% class="box infomessage" %)
2010 +(((
2011 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2012 +)))
2013 +
2014 +(% style="color:#000000" %)Метод запроса: **POST**
2015 +
2016 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2017 +
2018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2019 +
2020 +(% style="text-align:left" %)
2021 +Тело запроса:
2022 +
2023 +{
2024 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2025 + "vehicleIds": [0], ~/~/ Список ID объектов
2026 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2027 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2028 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2029 +}
2030 +
2031 +Ответ:
2032 +
2033 +[
2034 + {
2035 + "vehicleId": 0, ~/~/ ID объекта
2036 + "name": "string", ~/~/ Имя ТС
2037 + "periods": [ ~/~/ Периоды
2038 + {
2039 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2040 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2041 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2042 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2043 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2044 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
358 358   }
359 - ]}}}
2046 + ]
2047 + }
2048 +]
360 360  
2050 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2051 +
2052 +(% class="box infomessage" %)
2053 +(((
2054 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2055 +)))
2056 +
2057 +(% style="color:#000000" %)Метод запроса: **POST**
2058 +
2059 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2060 +
2061 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2062 +
2063 +(% style="text-align:left" %)
2064 +Тело запроса:
2065 +
2066 +{
2067 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2068 + "vehicleIds": [0], ~/~/ Список ID объектов
2069 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2070 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2071 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
361 361  }
362 362  
363 - **Удаление объекта**
2074 +Ответ:
364 364  
365 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2076 +[
2077 + {
2078 + "vehicleId": 0, ~/~/ ID объекта
2079 + "name": "string", ~/~/ Имя ТС
2080 + "periods": [ ~/~/ Периоды
2081 + {
2082 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2083 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2084 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2085 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2086 + "fuelConsumption": 0, ~/~/ Расход топлива
2087 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2088 + }
2089 + ]
2090 + }
2091 +]
366 366  
367 -Метод запроса: DELETE
2093 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
368 368  
369 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
2095 +(% class="box infomessage" %)
2096 +(((
2097 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 +)))
370 370  
371 -Параметр запроса: {id} - Guid объекта
2100 +(% style="color:#000000" %)Метод запроса: **POST**
372 372  
373 -В заголовках запроса: X-Auth: Токен авторизации
2102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
374 374  
375 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
2104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
376 376  
377 - **Редактирование объекта**
2106 +(% style="text-align:left" %)
2107 +Тело запроса:
378 378  
379 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2109 +{
2110 + "vehicleIds": [0], ~/~/ Список ID объектов
2111 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 +}
380 380  
381 -Метод запроса: PUT
2116 +Ответ:
382 382  
383 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
2118 +[
2119 + {
2120 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 + "vehicleId": 0, ~/~/ ID объекта
2123 + "name": "string", ~/~/ Имя объекта
2124 + "model": "string", ~/~/ Модель объекта
2125 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 + {
2127 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 + "valueFuel": 0, ~/~/ Количество
2131 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 + }
2134 + ]
2135 + }
2136 +]
384 384  
2138 +
2139 +(% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**
2140 +
2141 +(% class="box infomessage" %)
2142 +(((
2143 +**POST/api/v3/vehicles/moveStop**
2144 +)))
2145 +
2146 +Метод запроса: **POST**
2147 +
2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 +
385 385  В заголовках запроса: X-Auth: Токен авторизации
386 386  
387 -Параметры в теле запроса (JSON):
388 388  
389 -//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
2153 +Тело запроса:
390 390  
2155 +{
2156 +
2157 + "vehicleIds": [ ], ~/~/ Список ID объектов
2158 +
2159 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2160 +
2161 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2162 +
2163 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2164 +
2165 +}
2166 +
2167 +
391 391  Ответ:
392 392  
393 -{ «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»: «» //Сколько раз выполнить задание } ] }
2170 +[
394 394  
395 - **Изменение статуса объекта**
2172 + {
396 396  
397 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2174 + "vehicleId": 0, ~/~/ ID объекта
398 398  
399 -Метод запроса: POST
2176 + "vehicleName": "string", ~/~/ Имя объекта
400 400  
401 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
2178 + "moves": [ ~/~/ Событие движения
402 402  
403 -Параметр запроса: {vehicleId} - ID ТС
2180 + {
404 404  
405 -В заголовках запроса: X-Auth: Токен авторизации
2182 + "mileage": 0, ~/~/ Пробег, км
406 406  
407 -Параметры в теле запроса (JSON): {
2184 + "eventId": 0, ~/~/ Идентификатор события
408 408  
409 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
410 - "date": "", // Дата смены статуса (null если сменить немедленно)
411 - "description": "", // Описание
412 - "data": "", // Данные
413 - "overwrite": false, // Флаг перезаписи
414 - "stage": "", // Состояние, может быть null}}}
2186 + "eventName": "string", ~/~/ Название события
415 415  
2188 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2189 +
2190 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2191 +
2192 + "duration": 0 ~/~/ Продолжительность события, секунд
2193 +
2194 + }
2195 +
2196 + ],
2197 +
2198 + "stops": [ ~/~/ События стоянок
2199 +
2200 + {
2201 +
2202 + "address": "string", ~/~/ Адрес события
2203 +
2204 + "eventId": 0, ~/~/ Идентификатор события
2205 +
2206 + "eventName": "string", ~/~/ Название события
2207 +
2208 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2209 +
2210 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2211 +
2212 + "duration": 0 ~/~/ Продолжительность события, секунд
2213 +
2214 +
2215 + }
2216 +
2217 + ]
2218 +
2219 + }
2220 +
2221 +]
2222 +
2223 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2224 +
2225 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2226 +
2227 +(% class="box infomessage" %)
2228 +(((
2229 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2230 +)))
2231 +
2232 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2233 +
2234 +(% style="color:#000000" %)Метод запроса: **POST**
2235 +
2236 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2237 +
2238 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2239 +
2240 +(% style="text-align:left" %)
2241 +Тело запроса:
2242 +
2243 +(% style="text-align:left" %)
2244 +{
2245 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
416 416  }
417 417  
418 -Ответ: {
2248 +(% style="text-align:left" %)
2249 +Ответ:
419 419  
420 -{{{ "status": "", // значение статуса
421 - "date": "", // Дата смены статуса
422 - "description": "", // Описание
423 - "data": "", // Данные
424 - "overwrite": false, // Флаг перезаписи
425 - "stage": "", // Состояние}}}
2251 +[
2252 + {
2253 + "id": 0, ~/~/ Идентификатор объекта геозоны
2254 + "name": "string", ~/~/ Название объекта геозоны
2255 + "type": 0, ~/~/ Тип объекта геозоны
2256 + "fname": "string", ~/~/ Имя файла
2257 + "parentId": "string", ~/~/ Идентификатор клиента
2258 + "radius": 0, ~/~/ Радиус геообъекта
2259 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2260 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2261 + "description": "string", ~/~/ Описание
2262 + "area": 0, ~/~/ Площадь, м^^2^^
2263 + "perimetr": 0, ~/~/ Периметр, м
2264 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2265 + }
2266 +]
426 426  
2268 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2269 +
2270 +(% class="box infomessage" %)
2271 +(((
2272 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2273 +)))
2274 +
2275 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2276 +
2277 +(% style="color:#000000" %)Метод запроса: **POST**
2278 +
2279 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2280 +
2281 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2282 +
2283 +(% style="text-align:left" %)
2284 +Тело запроса:
2285 +
2286 +{
2287 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2288 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2289 + "ids": [ ], ~/~/ Массив id объектов
2290 + "byTime": 0, ~/~/ Объединение событий по времени 
2291 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2292 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2293 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
427 427  }
428 428  
429 - **Проверка авторизации**
2296 +Ответ:
2297 +[
2298 + {
2299 + "geozoneId": 0, ~/~/ ID геообъекта
2300 + "geozoneName": "string", ~/~/ Название геообъекта
2301 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2302 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2303 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2304 + "vehicleId": 0, ~/~/ ID объекта
2305 + "vehicleName": "string" ~/~/ Имя объекта
2306 + }
2307 +]
430 430  
431 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
2309 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
432 432  
433 -Метод запроса: GET
2311 +(% class="box infomessage" %)
2312 +(((
2313 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2314 +)))
434 434  
435 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
2316 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
436 436  
2318 +(% style="color:#000000" %)Метод запроса: **POST**
2319 +
2320 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2321 +
2322 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2323 +
2324 +(% style="text-align:left" %)
2325 +Тело запроса:
2326 +
2327 +{
2328 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2329 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2330 + "ids": [ ], ~/~/ Массив id геообъектов
2331 + "byTime": 0, ~/~/ Объединение событий по времени 
2332 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2333 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2334 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2335 +}
2336 +
2337 +Ответ:
2338 +
2339 +[
2340 + {
2341 + "geozoneId": 0, ~/~/ ID геообъекта
2342 + "geozoneName": "string", ~/~/ Название геообъекта
2343 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2344 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2345 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2346 + "vehicleId": 0, ~/~/ ID объекта
2347 + "vehicleName": "string" ~/~/ Имя объекта
2348 + }
2349 +]
2350 +
2351 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2352 +
2353 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2354 +
2355 +(% class="box infomessage" %)
2356 +(((
2357 +**POST /api/v3/notifications/find**
2358 +)))
2359 +
2360 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2361 +
2362 +(% style="text-align: left;" %)
2363 +Метод запроса **POST**
2364 +
2365 +(% style="text-align: left;" %)
2366 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2367 +
2368 +(% style="text-align: left;" %)
2369 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2370 +
2371 +{
2372 + "parentId": "" ~/~/ id клиента
2373 +}
2374 +
2375 +Ответ:
2376 +
2377 +[
2378 + {
2379 + "id": 0, ~/~/ ID уведомления
2380 + "name": "string", ~/~/ Название уведомления
2381 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2382 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2383 + "userId": "", ~/~/ Пользователь, создавший уведомление
2384 + "parentId": "", ~/~/ Идентификатор клиента
2385 + "parentName": "string" ~/~/ Имя клиента
2386 + }
2387 +]
2388 +
2389 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2390 +
2391 +(% class="box infomessage" %)
2392 +(((
2393 +**GET /api/v3/notifications/{id}**
2394 +)))
2395 +
2396 +Метод возвращает данные правил формирования выбранного уведомления.
2397 +
2398 +(% style="text-align: left;" %)
2399 +Метод запроса **GET**
2400 +
2401 +(% style="text-align: left;" %)
2402 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2403 +
2404 +(% style="text-align: left;" %)
2405 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2406 +
2407 +(% style="text-align: left;" %)
2408 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2409 +
2410 +(% style="text-align: left;" %)
2411 +(% style="color:#000000" %)Ответ:
2412 +
2413 +(% style="text-align: left;" %)
2414 +(% style="color:#000000" %){
2415 + "id": 0, ~/~/ (%%)id уведомления
2416 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2417 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2418 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2419 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2420 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2421 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2422 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2423 +(% style="color:#000000" %) 0
2424 + ],
2425 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2426 +(% style="color:#000000" %) 0
2427 + ],
2428 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2429 +(% style="color:#000000" %) 0
2430 + ],
2431 + "settings": { ~/~/ Список параметров уведомления
2432 + "additionalProp1": "string",
2433 + "additionalProp2": "string",
2434 + "additionalProp3": "string"
2435 + },
2436 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2437 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2438 +(% style="color:#000000" %) ""
2439 + ],
2440 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2441 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2442 +(% style="color:#000000" %) "string"
2443 + ],
2444 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2445 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2446 +(% style="color:#000000" %) {
2447 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2448 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2449 +(% style="color:#000000" %) }
2450 + ],
2451 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2452 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2453 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2454 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2455 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2456 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2457 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2458 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2459 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2460 +(% style="color:#000000" %)}
2461 +
2462 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2463 +
2464 +(% class="box warningmessage" %)
2465 +(((
2466 +**PUT /api/v3/notifications/**
2467 +)))
2468 +
2469 +Метод позволяет отредактировать уведомление.
2470 +
2471 +Метод запроса **PUT**
2472 +
2473 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2474 +
437 437  В заголовках запроса: X-Auth: Токен авторизации
438 438  
439 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
2477 +Тело запроса:
2478 +{
2479 + "id": 0, ~/~/ id уведомления
2480 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2481 + "userId": "", ~/~/ Пользователь, создавший уведомление
2482 + "parentId": "", ~/~/ Идентификатор клиента
2483 + "parentName": "string", ~/~/ Имя клиента
2484 + "name": "string", ~/~/ Название уведомления
2485 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2486 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2487 + 0
2488 + ],
2489 + "geoids": [ ~/~/ Список id геообъектов для анализа
2490 + 0
2491 + ],
2492 + "fieldids": [ ~/~/ Список id полей для анализа
2493 + 0
2494 + ],
2495 + "settings": { ~/~/ Список параметров уведомления
2496 + "additionalProp1": "string",
2497 + "additionalProp2": "string",
2498 + "additionalProp3": "string"
2499 + },
2500 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2501 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2502 + ""
2503 + ],
2504 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2505 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2506 + "string"
2507 + ],
2508 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2509 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2510 + {
2511 + "id": 0, ~/~/ Идентификатор участника чата
2512 + "info": "string" ~/~/ Дополнительные сведения
2513 + }
2514 + ],
2515 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2516 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2517 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2518 + "kind": 0, ~/~/ Определяет вид уведомления
2519 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2520 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2521 + "timezone": 0, ~/~/ Сдвиг часового пояса
2522 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2523 + "autoProlongation": true ~/~/ Автопродление срока действия
2524 +}
440 440  
441 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
2526 +Ответ:
2527 +
2528 +Success
2529 +
2530 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2531 +
2532 +(% class="box errormessage" %)
2533 +(((
2534 +**DELETE /api/v3/notifications/{id}**
2535 +)))
2536 +
2537 +Метод позволяет удалить выбранное уведомление.
2538 +
2539 +Метод запроса **DELETE**
2540 +
2541 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2542 +
2543 +Передаваемый параметр: {id} - id уведомления
2544 +
2545 +В заголовках запроса: X-Auth: Токен авторизации
2546 +
2547 +Ответ:
2548 +
2549 +Success
2550 +
2551 +
2552 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2553 +
2554 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2555 +
2556 +(% class="box infomessage" %)
2557 +(((
2558 +**POST /api/v3/Drivers/find**
2559 +)))
2560 +
2561 +Передается параметр: parentId - ID клиента-родителя
2562 +
2563 +Ответ:
2564 +
2565 +[
2566 + {
2567 + "name": "string", ~/~/ Определяет наименование
2568 + "description": "string", ~/~/ Определяет описание
2569 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2570 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2571 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2572 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2573 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2574 + "deleted": true ~/~/ Признак удаления
2575 + }
2576 +]
2577 +
2578 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2579 +
2580 +(% class="box infomessage" %)
2581 +(((
2582 +**GET /api/v3/Drivers/{driverGuid}**
2583 +)))
2584 +
2585 +Передается параметр: ID водителя
2586 +
2587 +Ответ:
2588 +
2589 +{
2590 + "name": "string", ~/~/ Определяет наименование
2591 + "description": "string", ~/~/ Определяет описание
2592 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2593 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2594 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2595 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2596 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2597 + "deleted": true ~/~/ Признак удаления
2598 +}
2599 +
2600 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2601 +
2602 +(% class="box successmessage" %)
2603 +(((
2604 +**POST /api/v3/Drivers**
2605 +)))
2606 +
2607 +Запрос:
2608 +
2609 +{
2610 + "name": "string",
2611 + "description": "string",
2612 + "hiredate": "2023-06-30T12:50:54.020Z",
2613 + "chopdate": "2023-06-30T12:50:54.020Z",
2614 + "exclusive": true,
2615 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2616 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2617 + "deleted": true
2618 +}
2619 +
2620 +Ответ:
2621 +
2622 +{
2623 + "name": "string",
2624 + "description": "string",
2625 + "hiredate": "2023-06-30T12:50:54.051Z",
2626 + "chopdate": "2023-06-30T12:50:54.051Z",
2627 + "exclusive": true,
2628 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2629 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2630 + "deleted": true
2631 +}
2632 +
2633 +
2634 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2635 +
2636 +(% class="box warningmessage" %)
2637 +(((
2638 +**PUT /api/v3/Drivers**
2639 +)))
2640 +
2641 +Запрос:
2642 +
2643 +{
2644 + "name": "string",
2645 + "description": "string",
2646 + "hiredate": "2023-06-30T12:50:27.910Z",
2647 + "chopdate": "2023-06-30T12:50:27.910Z",
2648 + "exclusive": true,
2649 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2650 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2651 + "deleted": true
2652 +}
2653 +
2654 +Ответ:
2655 +
2656 +{
2657 + "name": "string",
2658 + "description": "string",
2659 + "hiredate": "2023-06-30T12:50:27.929Z",
2660 + "chopdate": "2023-06-30T12:50:27.929Z",
2661 + "exclusive": true,
2662 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2663 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2664 + "deleted": true
2665 +}
2666 +
2667 +
2668 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2669 +
2670 +(% class="box errormessage" %)
2671 +(((
2672 +**DELETE /api/v3/Drivers/{driverGuid}**
2673 +)))
2674 +
2675 +Передается параметр: ID водителя
2676 +
2677 +Ответ:
2678 +
2679 +Success
2680 +
2681 +
2682 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2683 +
2684 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2685 +
2686 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2687 +
2688 +(% class="box infomessage" %)
2689 +(((
2690 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2691 +)))
2692 +
2693 +Запрос:
2694 +
2695 +{
2696 + "Ids": [
2697 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2698 + ],
2699 + "BeginTime": "2023-06-30T12:49:04.365Z",
2700 + "EndTime": "2023-06-30T12:49:04.365Z"
2701 +}
2702 +
2703 +Ответ:
2704 +
2705 +[
2706 + {
2707 + "VehicleId": 0,
2708 + "CreateTime": "2023-06-30T09:52:31.240Z",
2709 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2710 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2711 + "BeginTime": "2023-06-30T09:52:31.240Z",
2712 + "EndTime": "2023-06-30T09:52:31.240Z"
2713 + }
2714 +]
2715 +
2716 +
2717 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2718 +
2719 +(% class="box infomessage" %)
2720 +(((
2721 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2722 +)))
2723 +
2724 +Запрос:
2725 +
2726 +{
2727 + "Ids": [
2728 + 0
2729 + ],
2730 + "BeginTime": "2023-06-30T12:48:39.419Z",
2731 + "EndTime": "2023-06-30T12:48:39.419Z"
2732 +}
2733 +
2734 +Ответ:
2735 +
2736 +[
2737 + {
2738 + "VehicleId": 0,
2739 + "CreateTime": "2023-06-30T09:54:01.631Z",
2740 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2741 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2742 + "BeginTime": "2023-06-30T09:54:01.631Z",
2743 + "EndTime": "2023-06-30T09:54:01.631Z"
2744 + }
2745 +]
2746 +
2747 +
2748 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2749 +
2750 +(% class="box successmessage" %)
2751 +(((
2752 +**POST /api/v3/DriversVehiclesAssignments**
2753 +)))
2754 +
2755 +Передается массив назначений
2756 +
2757 +Запрос:
2758 +
2759 +[
2760 + {
2761 + "VehicleId": 0, ~/~/ Идентификатор объекта
2762 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2763 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2764 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2765 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2766 + }
2767 +]
2768 +
2769 +Ответ:
2770 +
2771 +[
2772 + {
2773 + "VehicleId": 0,
2774 + "CreateTime": "2023-06-30T11:04:46.903Z",
2775 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2776 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 + "BeginTime": "2023-06-30T11:04:46.903Z",
2778 + "EndTime": "2023-06-30T11:04:46.903Z"
2779 + }
2780 +]
2781 +
2782 +
2783 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2784 +
2785 +(% class="box warningmessage" %)
2786 +(((
2787 +**PUT /api/v3/DriversVehiclesAssignments**
2788 +)))
2789 +
2790 +Запрос:
2791 +
2792 +[
2793 + {
2794 + "VehicleId": 0,
2795 + "CreateTime": "2023-06-30T11:14:08.117Z",
2796 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2797 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2798 + "BeginTime": "2023-06-30T11:14:08.117Z",
2799 + "EndTime": "2023-06-30T11:14:08.117Z"
2800 + }
2801 +]
2802 +
2803 +Ответ:
2804 +
2805 +[
2806 + {
2807 + "VehicleId": 0,
2808 + "CreateTime": "2023-06-30T11:14:53.349Z",
2809 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2810 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2811 + "BeginTime": "2023-06-30T11:14:53.349Z",
2812 + "EndTime": "2023-06-30T11:14:53.349Z"
2813 + }
2814 +]
2815 +
2816 +
2817 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2818 +
2819 +(% class="box errormessage" %)
2820 +(((
2821 +**DELETE /api/v3/DriversVehiclesAssignments**
2822 +)))
2823 +
2824 +Запрос:
2825 +
2826 +[
2827 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2828 +]
2829 +
2830 +Ответ:
2831 +
2832 +Success
2833 +
2834 +
2835 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2836 +
2837 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2838 +
2839 +(% class="box infomessage" %)
2840 +(((
2841 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2842 +)))
2843 +
2844 +Запрос:
2845 +
2846 +{
2847 + "Ids": [
2848 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2849 + ],
2850 + "BeginTime": "2023-06-30T12:47:12.162Z",
2851 + "EndTime": "2023-06-30T12:47:12.162Z"
2852 +}
2853 +
2854 +Ответ:
2855 +
2856 +[
2857 + {
2858 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2859 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2860 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2861 + "BeginTime": "2023-06-30T11:19:40.703Z",
2862 + "EndTime": "2023-06-30T11:19:40.703Z"
2863 + }
2864 +]
2865 +
2866 +
2867 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2868 +
2869 +(% class="box infomessage" %)
2870 +(((
2871 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2872 +)))
2873 +
2874 +Запрос:
2875 +
2876 +{
2877 + "Ids": [
2878 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2879 + ],
2880 + "BeginTime": "2023-06-30T12:47:12.162Z",
2881 + "EndTime": "2023-06-30T12:47:12.162Z"
2882 +}
2883 +
2884 +Ответ:
2885 +
2886 +[
2887 + {
2888 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2889 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2890 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2891 + "BeginTime": "2023-06-30T11:19:40.703Z",
2892 + "EndTime": "2023-06-30T11:19:40.703Z"
2893 + }
2894 +]
2895 +
2896 +
2897 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2898 +
2899 +(% class="box successmessage" %)
2900 +(((
2901 +**POST /api/v3/DriversRfidsAssignments**
2902 +)))
2903 +
2904 +Запрос:
2905 +
2906 +[
2907 + {
2908 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2909 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2910 + "BeginTime": "2023-06-30T11:27:08.635Z",
2911 + "EndTime": "2023-06-30T11:27:08.635Z"
2912 + }
2913 +]
2914 +
2915 +Ответ:
2916 +
2917 +[
2918 + {
2919 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2920 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2921 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2922 + "BeginTime": "2023-06-30T11:27:08.677Z",
2923 + "EndTime": "2023-06-30T11:27:08.677Z"
2924 + }
2925 +]
2926 +
2927 +
2928 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2929 +
2930 +(% class="box warningmessage" %)
2931 +(((
2932 +**PUT /api/v3/DriversRfidsAssignments**
2933 +)))
2934 +
2935 +Запрос:
2936 +
2937 +[
2938 + {
2939 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2940 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2941 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2942 + "BeginTime": "2023-06-30T11:28:43.330Z",
2943 + "EndTime": "2023-06-30T11:28:43.330Z"
2944 + }
2945 +]
2946 +
2947 +Ответ:
2948 +
2949 +[
2950 + {
2951 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2952 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2953 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "BeginTime": "2023-06-30T11:28:43.331Z",
2955 + "EndTime": "2023-06-30T11:28:43.331Z"
2956 + }
2957 +]
2958 +
2959 +
2960 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2961 +
2962 +(% class="box errormessage" %)
2963 +(((
2964 +**DELETE /api/v3/DriversRfidsAssignments**
2965 +)))
2966 +
2967 +Запрос:
2968 +
2969 +[
2970 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2971 +]
2972 +
2973 +Ответ:
2974 +
2975 +Success
2976 +
2977 +
2978 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2979 +
2980 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2981 +
2982 +(% class="box infomessage" %)
2983 +(((
2984 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2985 +)))
2986 +
2987 +Запрос:
2988 +
2989 +{
2990 + "Ids": [
2991 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2992 + ],
2993 + "BeginTime": "2023-06-30T12:45:10.852Z",
2994 + "EndTime": "2023-06-30T12:45:10.852Z"
2995 +}
2996 +
2997 +Ответ:
2998 +
2999 +[
3000 + {
3001 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3002 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3003 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3004 + "BeginTime": "2023-06-30T11:58:04.695Z",
3005 + "EndTime": "2023-06-30T11:58:04.695Z"
3006 + }
3007 +]
3008 +
3009 +
3010 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3011 +
3012 +(% class="box infomessage" %)
3013 +(((
3014 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3015 +)))
3016 +
3017 +Запрос:
3018 +
3019 +{
3020 + "Ids": [
3021 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3022 + ],
3023 + "BeginTime": "2023-06-30T12:45:10.852Z",
3024 + "EndTime": "2023-06-30T12:45:10.852Z"
3025 +}
3026 +
3027 +Ответ:
3028 +
3029 +[
3030 + {
3031 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3032 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3033 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 + "BeginTime": "2023-06-30T11:58:04.695Z",
3035 + "EndTime": "2023-06-30T11:58:04.695Z"
3036 + }
3037 +]
3038 +
3039 +
3040 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3041 +
3042 +(% class="box successmessage" %)
3043 +(((
3044 +**POST /api/v3/DriversFuelCardsAssignments**
3045 +)))
3046 +
3047 +Запрос:
3048 +
3049 +[
3050 + {
3051 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3052 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3053 + "BeginTime": "2023-06-30T12:09:53.175Z",
3054 + "EndTime": "2023-06-30T12:09:53.175Z"
3055 + }
3056 +]
3057 +
3058 +Ответ:
3059 +
3060 +[
3061 + {
3062 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3063 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3064 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3065 + "BeginTime": "2023-06-30T12:09:53.201Z",
3066 + "EndTime": "2023-06-30T12:09:53.201Z"
3067 + }
3068 +]
3069 +
3070 +
3071 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3072 +
3073 +(% class="box warningmessage" %)
3074 +(((
3075 +**PUT /api/v3/DriversFuelCardsAssignments**
3076 +)))
3077 +
3078 +Запрос:
3079 +
3080 +[
3081 + {
3082 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "BeginTime": "2023-06-30T12:09:53.201Z",
3086 + "EndTime": "2023-06-30T12:09:53.201Z"
3087 + }
3088 +]
3089 +
3090 +Ответ:
3091 +
3092 +[
3093 + {
3094 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3095 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3096 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3097 + "BeginTime": "2023-06-30T12:09:53.201Z",
3098 + "EndTime": "2023-06-30T12:09:53.201Z"
3099 + }
3100 +]
3101 +
3102 +
3103 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3104 +
3105 +(% class="box errormessage" %)
3106 +(((
3107 +**DELETE /api/v3/DriversFuelCardsAssignments**
3108 +)))
3109 +
3110 +Запрос:
3111 +
3112 +[
3113 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3114 +]
3115 +
3116 +Ответ:
3117 +
3118 +Success
3119 +
3120 +
3121 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3122 +
3123 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3124 +
3125 +(% class="box infomessage" %)
3126 +(((
3127 +**POST /api/v3/Trailers**
3128 +)))
3129 +
3130 +Пример запроса:
3131 +
3132 +{
3133 + "startDate": "2023-11-14T10:48:03.671Z",
3134 + "endDate": "2023-11-14T10:48:03.671Z",
3135 + "ids": [ 0 ],
3136 + "timezone": 0
3137 +}
3138 +
3139 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3140 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3141 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3142 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3143 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3144 +
3145 +Пример ответа:
3146 +
3147 +[
3148 + {
3149 + "SD": "2023-11-14T10:48:03.717Z",
3150 + "ED": "2023-11-14T10:48:03.717Z", 
3151 + "id": 0,
3152 + "SLat": 0,
3153 + "SLon": 0,
3154 + "ELat": 0,
3155 + "ELon": 0,
3156 + "mileage": 0
3157 + "Duration": 0
3158 + "Address": "string",
3159 + "Address2": "string",
3160 + "name": "string",
3161 + "rid": "string",
3162 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 + "trailer": {
3164 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3165 + "Number": "string",
3166 + "Description": "string",
3167 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3168 + "ExternalID": "string",
3169 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3170 + "CreateTime": "2023-11-14T10:48:03.717Z",
3171 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3172 + "IsDeleted": true
3173 + },
3174 + "filesCount": 0,
3175 + }
3176 +]
3177 +
3178 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3179 +|SD|Дата и время начала события
3180 +|ED|Дата и время окончания события
3181 +|id|ID объекта
3182 +|SLat|Широта начальной координаты
3183 +|SLon|Долгота начальной координаты
3184 +|ELat|Широта конечной координаты
3185 +|ELon|Долгота конечной координаты
3186 +|mileage|Пробег
3187 +|Duration|Продолжительность
3188 +|Address|Адрес начального местоположения
3189 +|Address2|Адрес конечного местоположения
3190 +|name|Имя радиометки
3191 +|rid|Номер радиометки
3192 +|rguid|ID радиометки
3193 +|trailer|Информация об агрегате
3194 +|ModelGuid|ID агрегата
3195 +|Number|Название/номер агрегата
3196 +|Description|Текст примечания агрегата
3197 +
3198 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3199 +
3200 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3201 +
3202 +(% class="box infomessage" %)
3203 +(((
3204 +**POST /api/v3/Rfids/find**
3205 +)))
3206 +
3207 +Запрос:
3208 +
3209 +{
3210 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3211 +}
3212 +
3213 +Ответ:
3214 +
3215 +[
3216 + {
3217 + "name": "string",
3218 + "number": 0,
3219 + "period": 0,
3220 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3221 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3222 + }
3223 +]
3224 +
3225 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3226 +|parentId|ID клиента
3227 +|name|Название карты-метки
3228 +|number|Номер
3229 +|period|Период запросов в секундах (работает только для агрегатов)
3230 +|id|ID карты-метки
3231 +
3232 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3233 +
3234 +(% class="box infomessage" %)
3235 +(((
3236 +**GET /api/v3/Rfids/{rfidGuid}**
3237 +)))
3238 +
3239 +Передаем параметр rfidGuid - идентификатор карты-метки
3240 +
3241 +Ответ:
3242 +
3243 +[
3244 + {
3245 + "name": "string",
3246 + "number": 0,
3247 + "period": 0,
3248 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3249 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3250 + }
3251 +]
3252 +
3253 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3254 +|name|Название карты-метки
3255 +|number|Номер
3256 +|period|Период запросов в секундах (работает только для агрегатов)
3257 +|id|ID карты-метки
3258 +|parentId|ID клиента
3259 +
3260 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3261 +
3262 +(% class="box successmessage" %)
3263 +(((
3264 +**POST /api/v3/Rfids**
3265 +)))
3266 +
3267 +Запрос:
3268 +
3269 +{
3270 + "name": "string",
3271 + "number": 0,
3272 + "period": 0,
3273 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3274 +}
3275 +
3276 +Ответ:
3277 +
3278 +{
3279 + "name": "string",
3280 + "number": 0,
3281 + "period": 0,
3282 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3283 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3284 +}
3285 +
3286 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3287 +|name|Название карты-метки
3288 +|number|Номер
3289 +|period|Период запросов в секундах (работает только для агрегатов)
3290 +|id|ID карты-метки
3291 +|parentId|ID клиента
3292 +
3293 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3294 +
3295 +(% class="box warningmessage" %)
3296 +(((
3297 +**PUT /api/v3/Rfids**
3298 +)))
3299 +
3300 +Запрос:
3301 +
3302 +{
3303 + "name": "string",
3304 + "number": 0,
3305 + "period": 0,
3306 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3307 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
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 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3321 +|name|Название карты-метки
3322 +|number|Номер
3323 +|period|Период запросов в секундах (работает только для агрегатов)
3324 +|id|ID карты-метки
3325 +|parentId|ID клиента
3326 +
3327 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3328 +
3329 +(% class="box errormessage" %)
3330 +(((
3331 +**DELETE /api/v3/Rfids/{rfidGuid}**
3332 +)))
3333 +
3334 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3335 +
3336 +Ответ:
3337 +
3338 +Success
3339 +
3340 +
3341 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3342 +
3343 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3344 +
3345 +(% class="box infomessage" %)
3346 +(((
3347 +**GET /api/v3/Billing/client/balance/{clientId}**
3348 +)))
3349 +
3350 +Параметр запроса: **clientId **- идентификатор клиента.
3351 +
3352 +Ответ:
3353 +
3354 +{
3355 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3356 + "Balance": 0
3357 +}
3358 +
3359 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3360 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3361 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3362 +
3363 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3364 +
3365 +(% class="box infomessage" %)
3366 +(((
3367 +**GET /api/v3/Billing/client/constraint/{clientId}**
3368 +)))
3369 +
3370 +Параметр запроса: **clientId **- идентификатор клиента.
3371 +
3372 +Ответ:
3373 +
3374 +{
3375 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3376 + "CalculationType": 0,
3377 + "PermissibleBalance": 0,
3378 + "DefermentDays": 0,
3379 + "SendUiNotifications": true,
3380 + "SendEmailNotifications": true,
3381 + "IsPrivate": true,
3382 +}
3383 +
3384 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3385 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3386 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3387 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3388 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3389 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3390 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3391 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3392 +
3393 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3394 +
3395 +(% class="box infomessage" %)
3396 +(((
3397 +**GET /api/v3/Billing/client/plan/{clientId}**
3398 +)))
3399 +
3400 +Параметры запроса:
3401 +
3402 +**clientId **- идентификатор клиента.
3403 +
3404 +**planId **- идентификатор тарифного плана.
3405 +
3406 +Ответ:
3407 +
3408 +{
3409 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3410 + "Plan": { **~/~/ Описание тарифного плана**
3411 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3412 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 + "Name": "string",
3414 + "IsArchived": true,
3415 + "Constraint": {
3416 + "CalculationType": 0,
3417 + "PermissibleBalance": 0,
3418 + "DefermentDays": 0
3419 + },
3420 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3421 + {
3422 + "Feature": "string",
3423 + "IsFactual": true,
3424 + "Limit": 0,
3425 + "Price": 0,
3426 + "PeriodValue": 0,
3427 + "PeriodType": 0
3428 + }
3429 + ]
3430 + },
3431 + "DebitDate": "2023-10-18T12:46:24.213Z",
3432 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3433 + {
3434 + "Feature": "string",
3435 + "IsEnabled": true,
3436 + "IsPrivate": true,
3437 + "IsFactual": true,
3438 + "Limit": 0,
3439 + "Price": 0,
3440 + "DebitDate": "2023-10-18T12:46:24.213Z",
3441 + "PeriodValue": 0,
3442 + "PeriodType": 0
3443 + }
3444 + ]
3445 +}
3446 +
3447 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3448 +|ClientId|Идентификатор клиента
3449 +|Id|Идентификатор тарифного плана
3450 +|OwnerId|Идентификатор клиента-владельца
3451 +|Name|Наименование тарифного плана
3452 +|IsArchived|Признак, определяющий архивный тарифный план
3453 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3454 +|PermissibleBalance|Допустимый баланс
3455 +|DefermentDays|Отсрочка, количество дней
3456 +|Feature|Код услуги
3457 +|IsEnabled|Признак, определяющий активирована ли услуга
3458 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3459 +|IsFactual|Признак, определяющий расчёт по факту
3460 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3461 +|Price|Цена за единицу.
3462 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3463 +|PeriodValue|Значение периода.
3464 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3465 +
3466 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3467 +
3468 +(% class="box infomessage" %)
3469 +(((
3470 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3471 +)))
3472 +
3473 +Параметр запроса: **clientId **- идентификатор клиента.
3474 +
3475 +Ответ:
3476 +
3477 +[
3478 + {
3479 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3480 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3481 + "Name": "string",
3482 + "IsArchived": true,
3483 + "Constraint": {
3484 + "CalculationType": 0,
3485 + "PermissibleBalance": 0,
3486 + "DefermentDays": 0
3487 + },
3488 + "Features": [
3489 + {
3490 + "Feature": "string",
3491 + "IsFactual": true,
3492 + "Limit": 0,
3493 + "Price": 0,
3494 + "PeriodValue": 0,
3495 + "PeriodType": 0
3496 + }
3497 + ]
3498 + }
3499 +]
3500 +
3501 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3502 +|ClientId|Идентификатор клиента
3503 +|Id|Идентификатор тарифного плана
3504 +|OwnerId|Идентификатор клиента-владельца
3505 +|Name|Наименование тарифного плана
3506 +|IsArchived|Признак, определяющий архивный тарифный план
3507 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3508 +|PermissibleBalance|Допустимый баланс
3509 +|DefermentDays|Отсрочка, количество дней
3510 +|Feature|Код услуги
3511 +|IsFactual|Признак, определяющий расчёт по факту
3512 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3513 +|Price|Цена за единицу.
3514 +|PeriodValue|Значение периода.
3515 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3516 +
3517 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3518 +
3519 +(% class="box infomessage" %)
3520 +(((
3521 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3522 +)))
3523 +
3524 +Параметр запроса: **clientId **- идентификатор клиента.
3525 +
3526 +Ответ:
3527 +
3528 +[
3529 + {
3530 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3531 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 + "Name": "string",
3533 + "IsArchived": true,
3534 + "Constraint": {
3535 + "CalculationType": 0,
3536 + "PermissibleBalance": 0,
3537 + "DefermentDays": 0
3538 + },
3539 + "Features": [
3540 + {
3541 + "Feature": "string",
3542 + "IsFactual": true,
3543 + "Limit": 0,
3544 + "Price": 0,
3545 + "PeriodValue": 0,
3546 + "PeriodType": 0
3547 + }
3548 + ]
3549 + }
3550 +]
3551 +
3552 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3553 +|ClientId|Идентификатор клиента
3554 +|Id|Идентификатор тарифного плана
3555 +|OwnerId|Идентификатор клиента-владельца
3556 +|Name|Наименование тарифного плана
3557 +|IsArchived|Признак, определяющий архивный тарифный план
3558 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3559 +|PermissibleBalance|Допустимый баланс
3560 +|DefermentDays|Отсрочка, количество дней
3561 +|Feature|Код услуги
3562 +|IsFactual|Признак, определяющий расчёт по факту
3563 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3564 +|Price|Цена за единицу.
3565 +|PeriodValue|Значение периода.
3566 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3567 +
3568 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3569 +
3570 +(% class="box warningmessage" %)
3571 +(((
3572 +**PUT /api/v3/Billing/client/balance**
3573 +)))
3574 +
3575 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3576 +
3577 +Тело запроса:
3578 +
3579 +{
3580 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3581 + "Balance": 0
3582 +}
3583 +
3584 +Ответ: Success
3585 +
3586 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3587 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3588 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3589 +
3590 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3591 +
3592 +(% class="box warningmessage" %)
3593 +(((
3594 +**PUT /api/v3/billing/client/balance/deposit**
3595 +)))
3596 +
3597 +Создает операцию **Пополнение **с указанной суммой
3598 +
3599 +Тело запроса:
3600 +
3601 +{
3602 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3603 + "Balance": 0
3604 +}
3605 +
3606 +Ответ: Success
3607 +
3608 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3609 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3610 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3611 +
3612 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3613 +
3614 +Создает операцию **Списание **с указанной суммой
3615 +
3616 +(% class="box warningmessage" %)
3617 +(((
3618 +**PUT /api/v3/billing/client/balance/withdraw**
3619 +)))
3620 +
3621 +Тело запроса:
3622 +
3623 +{
3624 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 + "Balance": 0
3626 +}
3627 +
3628 +Ответ: Success
3629 +
3630 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3631 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3632 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3633 +
3634 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3635 +
3636 +(% class="box warningmessage" %)
3637 +(((
3638 +**PUT /api/v3/Billing/client/constraint**
3639 +)))
3640 +
3641 +Тело запроса:
3642 +
3643 +{
3644 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3645 + "CalculationType": 0,
3646 + "PermissibleBalance": 0,
3647 + "DefermentDays": 0,
3648 + "SendUiNotifications": true,
3649 + "SendEmailNotifications": true,
3650 + "IsPrivate": true,
3651 +}
3652 +
3653 +Ответ: Success
3654 +
3655 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3656 +|ClientId|Идентификатор клиента
3657 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3658 +|PermissibleBalance|Допустимый баланс
3659 +|DefermentDays|(((
3660 +Отсрочка, количество дней
3661 +)))
3662 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3663 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3664 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3665 +
3666 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3667 +
3668 +(% class="box warningmessage" %)
3669 +(((
3670 +**PUT /api/v3/Billing/client/plan**
3671 +)))
3672 +
3673 +Тело запроса:
3674 +
3675 +{
3676 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3677 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3678 + "Features": [
3679 + {
3680 + "Feature": "string",
3681 + "IsEnabled": true,
3682 + "IsFactual": true,
3683 + "Limit": 0,
3684 + "Price": 0,
3685 + "DebitDate": "2023-10-18T13:26:58.987Z",
3686 + "PeriodValue": 0,
3687 + "PeriodType": 0
3688 + }
3689 + ]
3690 +}
3691 +
3692 +Ответ: Success
3693 +
3694 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3695 +|ClientId|Идентификатор клиента
3696 +|PlanId|Идентификатор тарифного плана
3697 +|Feature|Код услуги
3698 +|IsEnabled|Признак, определяющий активирована ли услуга
3699 +|IsFactual|Признак, определяющий расчёт по факту
3700 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3701 +|Price|Цена за единицу.
3702 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3703 +|PeriodValue|Значение периода.
3704 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3705 +
3706 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3707 +
3708 +(% class="box warningmessage" %)
3709 +(((
3710 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3711 +)))
3712 +
3713 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3714 +
3715 +(% class="box infomessage" %)
3716 +(((
3717 +**POST /api/v3/vehicles/import/{agentId}**
3718 +)))
3719 +
3720 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3721 +
3722 +В пути указывается **agentId** - id клиента.
3723 +
3724 +**Заголовок**
3725 +
3726 +**X-Auth: [токен авторизации]**
3727 +
3728 +**Параметры**
3729 +
3730 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3731 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3732 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3733 +
3734 +В теле использовать тип **form-data,** тип значения** file**
3735 +
3736 +**Ключи**
3737 +
3738 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3739 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3740 +|csv|В значении передаем файл датчиков, формат **csv**
3741 +
3742 +Ответ:
3743 +
3744 +{
3745 + "vehicleId": 0,
3746 + "name": "string",
3747 + "errors": ["string"]
3748 +}
3749 +
3750 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3751 +|vehicleId|ID созданного объекта
3752 +|name|Имя созданного объекта
3753 +|errors|Ошибки и их описание
3754 +
3755 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3756 +
3757 +(% class="box infomessage" %)
3758 +(((
3759 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3760 +)))
3761 +
3762 +(% class="wikigeneratedid" %)
3763 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3764 +
3765 +(% class="wikigeneratedid" %)
3766 +В пути указывается **vehicleId **- id объекта.
3767 +
3768 +**Заголовок**
3769 +
3770 +**X-Auth: [токен авторизации]**
3771 +
3772 +В теле использовать тип **form-data.**
3773 +
3774 +Ключи:
3775 +
3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 +|**history**|В значении передавать файл с историей
3778 +
3779 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3780 +
3781 +Ответ:
3782 +
3783 +{
3784 + "results": [
3785 + {
3786 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3787 + "vehicleId": 0,
3788 + "errors": [
3789 + "string"
3790 + ],
3791 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3792 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3793 + "producedCount": 0,
3794 + "msgCount": 0
3795 + }
3796 + ]
3797 +}
3798 +
3799 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3800 +|results|Результаты импорта в разрезе ТС
3801 +|vehicleGuid|Guid ТС
3802 +|vehicleId|ID ТС
3803 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3804 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3805 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3806 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3807 +|msgCount|Кол-во обработанных сообщений всего
3808 +
3809 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3810 +
3811 +(% class="box infomessage" %)
3812 +(((
3813 +**GET /api/v3/vehicles/import/history/status**
3814 +)))
3815 +
3816 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3817 +
3818 +Ответ:
3819 +
3820 +{
3821 + "activity": true,
3822 + "progress": 0,
3823 + "message": "string"
3824 +}
3825 +
3826 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3827 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3828 +|progress|Guid ТС
3829 +
3830 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3831 +
3832 +(% class="box infomessage" %)
3833 +(((
3834 +**POST /api/v3/vehicles/export**
3835 +)))
3836 +
3837 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3838 +
3839 +Тело запроса:
3840 +
3841 +[
3842 + id
3843 +]
3844 +
3845 +Ответ: Success 200, получаете файлы с настройками.
3846 +
3847 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3848 +
3849 +(% class="box infomessage" %)
3850 +(((
3851 +**POST /api/v3/vehicles/export/history**
3852 +)))
3853 +
3854 +Метод возвращает список сообщений терминала объекта за выбранный период.
3855 +
3856 +Тело запроса:
3857 +
3858 +{
3859 + "vehicleId": 0,
3860 + "asArchive": true,
3861 + "from": "2023-09-27T12:17:45.973Z",
3862 + "to": "2023-09-27T12:17:45.973Z"
3863 +}
3864 +
3865 +Ответ:
3866 +
3867 +Получаете файл. Сообщение: Code 200/Success
3868 +
3869 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3870 +|vehicleId|ID объекта
3871 +|asArchive|true - Архивировать файл, False - не архивировать
3872 +|from|Дата и время начала запроса
3873 +|to|Дата и время окончания запроса
3874 +
3875 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3876 +
3877 +(% class="box infomessage" %)
3878 +(((
3879 +**GET /api/v3/vehicles/export/history/status**
3880 +)))
3881 +
3882 +Метод возвращает список сообщений терминала объекта за выбранный период.
3883 +
3884 +Ответ:
3885 +
3886 +{
3887 + "activity": true,
3888 + "progress": 0,
3889 + "message": "string"
3890 +}
3891 +
3892 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3893 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3894 +|progress|Прогресс экспорта, от 0 до 100%
3895 +|message|Текст описывающий статус
3896 +
3897 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3898 +
3899 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3900 +
3901 +(% class="box infomessage" %)
3902 +(((
3903 +**POST /api/v3/EcoDriving/rating**
3904 +)))
3905 +
3906 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3907 +
3908 +Тело запроса:
3909 +
3910 +{
3911 + "vehicleIds": [vehicleId],
3912 + "from": "2023-11-22T09:29:48.051Z",
3913 + "to": "2023-11-22T09:29:48.051Z"
3914 +}
3915 +
3916 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3917 +|vehicleIds|Массив ID объектов
3918 +|from|Дата начала запроса
3919 +|to|Дата окончания запроса
3920 +
3921 +Ответ:
3922 +
3923 +{
3924 + "items": [
3925 + {
3926 + "from": "2023-11-22T09:29:48.052Z",
3927 + "to": "2023-11-22T09:29:48.052Z",
3928 + "vehicleId": 0,
3929 + "vehicleName": "string",
3930 + "vehicleModel": "string",
3931 + "penalty": 0,
3932 + "score": 0,
3933 + "totalViolations": 0,
3934 + "violationsByType": {
3935 + "overspeedingViolations": 0,
3936 + "accelerationViolations": 0,
3937 + "brakingViolations": 0,
3938 + "turningViolations": 0,
3939 + "dangerousDrivingViolations": 0,
3940 + "sensorViolations": 0
3941 + },
3942 + "moveTime": 0,
3943 + "mileage": 0,
3944 + "tripsCount": 0,
3945 + "trips": [
3946 + {
3947 + "penalty": 0,
3948 + "score": 0,
3949 + "violationsCount": 0,
3950 + "violationsByType": {
3951 + "overspeedingViolations": 0,
3952 + "accelerationViolations": 0,
3953 + "brakingViolations": 0,
3954 + "turningViolations": 0,
3955 + "dangerousDrivingViolations": 0,
3956 + "sensorViolations": 0
3957 + },
3958 + "moveTime": 0,
3959 + "mileage": 0,
3960 + "motohours": 0,
3961 + "maxSpeed": 0,
3962 + "startAddress": "string",
3963 + "endAddress": "string",
3964 + "drivers": [
3965 + {
3966 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3967 + "driverName": "string",
3968 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3969 + }
3970 + ]
3971 + }
3972 + ]
3973 + }
3974 + ]
3975 +}
3976 +
3977 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3978 +|from|Дата начала запроса
3979 +|to|Дата  окончания
3980 +|vehicleId|ID объекта
3981 +|vehicleName|Имя объекта
3982 +|vehicleModel|Модель объекта
3983 +|penalty|Сумма штрафных баллов
3984 +|score|Оценка
3985 +|totalViolations|Суммарное количество нарушений
3986 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3987 +|overspeedingViolations|Превышение скорости
3988 +|accelerationViolations|Ускорение
3989 +|brakingViolations|Торможение
3990 +|turningViolations|Резкий поворот
3991 +|dangerousDrivingViolations|Резкое вождение
3992 +|sensorViolations|Нарушение по датчику
3993 +|moveTime|Время в движении
3994 +|mileage|Пробег
3995 +|tripsCount|Количество рейсов
3996 +|motohours|Моточасы
3997 +|maxSpeed|Максимальная скорость
3998 +|startAddress|Адрес начала рейса
3999 +|endAddress|Адрес окончания рейса
4000 +|drivers|Список водителей, которые были на объекте в течениии рейса
4001 +|driverGuid|Guid водителя
4002 +|driverName|Имя водителя
4003 +|driverRfid|Номер Карты-метки
4004 +
4005 +(% class="box" lang="en-US" style="text-align: center;" %)
4006 +(((
4007 +(% 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]] **
4008 +)))
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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