Методы API для работы с ГЛОНАССSoft

1

(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)

2

(((

3

**Содержание страницы:**

)))

= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =

10

11

(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).

12

13

(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).

14

15

Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.

16

17

(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!

18

19

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =

20

21

== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==

22

23

(% class="box successmessage" %)

24

(((

25

(% lang="en-US" %)**POST /api/v3/auth/login**

26

)))

27

28

(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.

29

30

(% style="color:#000000" %)Метод запроса: **POST**

31

32

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]

33

34

(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».

35

36

(% style="color:#000000" %)Параметры в теле запроса (JSON):

37

38

(% style="color:#000000" %){

39

"login": "testuser",

40

"password": "testuser"

41

}

42

43

(% style="color:#000000" %)**Ответ:**

44

45

(% lang="en-US" %)

46

(% style="color:#000000" %){

47

48

(% lang="en-US" %)

49

(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации

50

"User": "testuser" , ~/~/ имя пользователя

(% lang="en-US" %)

}

**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.

56

57

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

58

|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя

59

|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя

60

|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации

61

|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя

62

63

== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==

64

65

(% class="box infomessage" %)

66

(((

67

(% lang="en-US" %)**GET /api/v3/auth/check**

68

)))

69

70

(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.

71

72

(% style="color:#000000" %)Метод запроса: **GET**

73

74

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]

75

76

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

77

78

(% lang="en-US" %)

79

(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**

80

81

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =

82

83

== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==

84

85

(% class="box infomessage" %)

86

(((

87

**GET api/v3/agents/{id}**

88

)))

89

90

Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:

91

92

(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;

93

94

(% style="color:#000000" %)Метод запроса: **GET**

95

96

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}

97

98

Запрос должен содержать данные параметра "**agentId**"

99

100

(% style="color:#000000" %)Ответ:

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

105

"name": "string",

106

"fullName": "string",

107

"agentInfoType": 0,

108

"isForeign": true/false,

109

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

116

"email": "string",

117

"director": "string",

118

"bankName": "string",

"bankBIK": "string",

"bankRS": "string",

"bankKS": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

125

|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента

126

|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя

127

|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя

128

|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента

129

|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента

130

|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)

131

|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент

132

|(% style="width:215px" %)district|(% style="width:861px" %)Округ

133

|(% style="width:215px" %)region|(% style="width:861px" %)Регион

134

|(% style="width:215px" %)city|(% style="width:861px" %)Город

135

|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента

136

|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента

137

|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес

138

|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес

139

|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта

140

|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя

141

|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк

142

|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК

143

|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета

144

|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет

145

146

== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==

147

148

(% class="box infomessage" %)

149

(((

150

(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**

151

)))

152

153

(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:

154

155

(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;

156

157

(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;

158

159

(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».

160

161

(% style="color:#000000" %)Метод запроса: **POST**

162

163

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find

164

165

(% style="color:#000000" %)Параметр запроса:

166

167

(% style="color:#000000" %){

"parentId": "string"

}

(% style="color:#000000" %)Ответ:

172

173

{

174

"agentId": "",(% style="color:#000000" %) (%%)

175

"parentId": "",

176

"parentName": "string",

177

"name": "string",

178

"fullName": "string",

179

"agentInfoType": 0,

180

(% style="color:#000000" %) "status": "",

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

185

|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента

186

|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя

187

|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя

188

|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента

189

|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента

190

|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)

191

|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен

192

193

== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==

194

195

(% class="box successmessage" %)

196

(((

197

**POST /api/v3/agents **

198

)))

199

200

Метод позволяет добавить клиента, указанного в запросе.

201

202

Метод запроса: **POST**

203

204

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]

205

206

В заголовках запроса: X-Auth: Токен авторизации

207

208

Параметры в теле запроса (JSON):

209

210

{

211

"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя

212

"name": "string", ~/~/ имя

213

"fullName": "string", ~/~/ полное наименование

214

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

215

"isForeign": true, ~/~/ иностранный контрагент

216

"district": "string", ~/~/ округ

217

"region": "string", ~/~/ регион

218

"city": "string", ~/~/ город

219

"inn": "string", ~/~/ ИНН

220

"kpp": "string", ~/~/ КПП

221

"address": "string", ~/~/ юридический адрес

222

"addressFact": "string", ~/~/ фактический адрес

223

"email": "string", ~/~/ email

224

"director": "string", ~/~/ ФИО руководителя

225

"bankName": "string", ~/~/ банк

226

"bankBIK": "string", ~/~/ БИК

227

"bankRS": "string", ~/~/ номер счёта

228

"bankKS": "string" ~/~/ корр. счёт

}

Ответ:

{

"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента

236

"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя

237

"name": "string", ~/~/ имя

238

"fullName": "string", ~/~/ полное наименование

239

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

240

"isForeign": true, ~/~/ иностранный контрагент

241

"district": "string", ~/~/ округ

242

"region": "string", ~/~/ регион

243

"city": "string", ~/~/ город

244

"inn": "string", ~/~/ ИНН

245

"kpp": "string", ~/~/ КПП

246

"address": "string", ~/~/ юридический адрес

247

"addressFact": "string", ~/~/ фактический адрес

248

"email": "string", ~/~/ email

249

"director": "string", ~/~/ ФИО руководителя

250

"bankName": "string", ~/~/ банк

251

"bankBIK": "string", ~/~/ БИК

252

"bankRS": "string", ~/~/ номер счёта

253

"bankKS": "string" ~/~/ корр. счёт

254

}

255

256

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

257

|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента

258

|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя

259

|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя

260

|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента

261

|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента

262

|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)

263

|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент

264

|(% style="width:215px" %)district|(% style="width:861px" %)Округ

265

|(% style="width:215px" %)region|(% style="width:861px" %)Регион

266

|(% style="width:215px" %)city|(% style="width:861px" %)Город

267

|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента

268

|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента

269

|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес

270

|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес

271

|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта

272

|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя

273

|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк

274

|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК

275

|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета

276

|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет

277

278

== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==

279

280

(% class="box warningmessage" %)

281

(((

282

**PUT /api/v3/agents**

283

)))

284

285

Метод позволяет отредактировать клиента, указанного в запросе.

286

287

Метод запроса: **PUT**

288

289

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]

290

291

В заголовках запроса: X-Auth: Токен авторизации

292

293

Параметры в теле запроса (JSON):

294

295

{

296

"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента

297

"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя

298

"name": "string", ~/~/ имя

299

"fullName": "string", ~/~/ полное наименование

300

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

301

"isForeign": true, ~/~/ иностранный контрагент

302

"district": "string", ~/~/ округ

303

"region": "string", ~/~/ регион

304

"city": "string", ~/~/ город

305

"inn": "string", ~/~/ ИНН

306

"kpp": "string", ~/~/ КПП

307

"address": "string", ~/~/ юридический адрес

308

"addressFact": "string", ~/~/ фактический адрес

309

"email": "string", ~/~/ email

310

"director": "string", ~/~/ ФИО руководителя

311

"bankName": "string", ~/~/ банк

312

"bankBIK": "string", ~/~/ БИК

313

"bankRS": "string", ~/~/ номер счёта

314

"bankKS": "string" ~/~/ корр. счёт

}

Ответ:

{

"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента

321

"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя

322

"name": "string", ~/~/ имя

323

"fullName": "string", ~/~/ полное наименование

324

"isForeign": true, ~/~/ иностранный контрагент

325

"district": "string", ~/~/ округ

326

"region": "string", ~/~/ регион

327

"city": "string", ~/~/ город

328

"inn": "string", ~/~/ ИНН

329

"kpp": "string", ~/~/ КПП

330

"address": "string", ~/~/ юридический адрес

331

"addressFact": "string", ~/~/ фактический адрес

332

"email": "string", ~/~/ email

333

"director": "string", ~/~/ ФИО руководителя

334

"bankName": "string", ~/~/ банк

335

"bankBIK": "string", ~/~/ БИК

336

"bankRS": "string", ~/~/ номер счёта

337

"bankKS": "string" ~/~/ корр. счёт

338

}

339

340

== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==

341

342

(% class="box errormessage" %)

343

(((

344

**DELETE /api/v3/agents/{clientId}**

345

)))

346

347

Метод позволяет удалить клиента, указанного в строке запроса.

348

349

Метод запроса: **DELETE**

350

351

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**

352

353

Параметр запроса: **{clientId}** - Guid пользователя

354

355

В заголовках запроса: X-Auth: Токен авторизации

356

357

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

358

359

== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==

360

361

(% class="box warningmessage" %)

362

(((

363

**PUT /api/v3/agents/{id}/changeStatus/{status}**

364

)))

365

366

Метод позволяет изменить статус клиента, указанного в запросе.

367

368

В пути указывается GUID клиента и статус клиента.

369

370

**status **- значение 0 - заблокирован, 1 - активен.

Ответ: Code 204

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =

375

376

== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==

377

378

(% class="box successmessage" %)

379

(((

380

(% lang="en-US" %)**POST /api/v3/users**

381

)))

382

383

(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.

384

385

(% style="color:#000000" %)Метод запроса: **POST**

386

387

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

388

389

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

390

391

(% style="color:#000000" %)Параметры в теле запроса (JSON):

392

393

(% style="color:#000000" %)

394

{

395

"lastName": "", ~/~/ фамилия

396

"firstName": "", ~/~/ имя

397

"position": "", ~/~/ должность

398

"phone": "", ~/~/ телефон

399

"organization": "", ~/~/ организация

400

"login": "", ~/~/ логин (обязателен)

401

"password": "", ~/~/ пароль (обязателен)

402

"email": "", ~/~/ email (обязателен)

403

"description": "string", ~/~/ Описание

404

"isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено

405

"isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен

406

"isEnabled": true, ~/~/ Включен, true - включен, false - отключен

407

"parentId": "", ~/~/ Guid родительского агента

408

"leaderId": "", ~/~/ Guid руководителя (null - не задан)

409

"sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)

410

"doubleAuth":

411

{

412

"kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен

413

"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации

},

"groups":

[

"string" ~/~/ группы пользователя, перечисление названия системных ролей

],

"customGroups":

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей

422

],

423

"language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский

}

{

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

428

"lastName": "string",

429

"firstName": "string",

430

"position": "string",

431

"phone": "string",

432

"organization": "string",

433

"login": "string",

434

"password": "string",

435

"email": "string",

436

437

(% style="text-align:left" %)

438

(% style="color:#000000; font-weight:normal" %)Ответ:

439

440

(% style="text-align:left" %)

441

(% style="color:#000000; font-weight:normal" %){

442

443

(% style="text-align:left" %)

444

(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя

445

"lastName": "" , ~/~/ Фамилия ,

446

"firstName": "" , ~/~/ Имя

447

"position": "" , ~/~/ Должность

448

"phone": "" , ~/~/ Телефон

449

"organization": "" , ~/~/ Организация

450

"login": "" , ~/~/ Логин

451

"password": "" , ~/~/ Пароль

452

"email": "" , ~/~/ Email

453

"description": "" , ~/~/ Описание

454

"isEnabled": "" , ~/~/ Признак включения

455

"parentId": "" , ~/~/ Guid родительского агента

456

"sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах

457

"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации

458

"kind": "" , ~/~/ тип аутентификации

459

"target": "" , ~/~/ в случае аутентификации по email - email-адрес

460

"groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя

461

462

(% style="text-align:left" %)

463

(% style="color:#000000; font-weight:normal" %)}

464

465

466

== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==

467

468

(% class="box infomessage" %)

469

(((

470

(% lang="en-US" %)**POST /api/v3/users/find**

471

)))

472

473

(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.

474

475

(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.

476

477

(% style="color:#000000" %)Метод запроса: **POST**

478

479

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]

480

481

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

482

483

(% style="color:#000000" %)Параметры в теле запроса (JSON):

484

485

(% style="color:#000000" %){

486

487

"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента

488

"userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно

489

"login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно

490

"email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно

491

492

(% style="color:#000000" %)}

493

494

(% style="color:#000000" %)Ответ:

495

496

(% style="color:#000000" %){ (%%)

497

498

"id": "" , ~/~/ идентификатор пользователя

499

"lastName": "" , ~/~/ фамилия

500

"firstName": "" , ~/~/ имя

501

"position": "" , ~/~/ должность

502

"phone": "" , ~/~/ телефон

503

"parentId": "" , ~/~/ идентификатор клиента-родителя

504

"parentName": "" , ~/~/ наименование клиента-родителя

505

"organization": "" , ~/~/ организация

506

"login": "" , ~/~/ логин

507

"email": "" , ~/~/ E-mail

508

"sessionDuration":"", ~/~/ длительность сессии в минутах

509

"status": "1", ~/~/ статус пользователя

510

"lastLogged": "", ~/~/ дата/время последней авторизации

511

512

(% style="color:#000000" %)}

513

514

== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==

515

516

(% class="box infomessage" %)

517

(((

518

(% lang="en-US" %)**GET /api/v3/users/{GUID}**

519

)))

520

521

(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.

522

523

(% style="color:#000000" %)Метод запроса: **GET**

524

525

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]

526

527

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

528

529

(% style="color:#000000" %)Ответ:

(((

(((

{

"id": "", ~/~/ GUID пользователя

535

"lastName": "", ~/~/ Фамилия

536

"firstName": "", ~/~/ Имя

537

"position": "", ~/~/ Должность

538

"phone": "", ~/~/ Номер телефона

539

"parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь

540

"parentName": "", Наименование клиента, которому принадлежит пользователь

541

"organization": "", ~/~/ Организация

542

"login": "", ~/~/ Логин пользователя

543

"email": "", ~/~/ Адрес электронной почты

544

"language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский

545

"isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено

546

"description": "", ~/~/ Описание

547

"isEnabled": , ~/~/ Включен, true - включен, false - отключен

548

"doubleAuth":

549

{

550

"kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен

551

"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации

552

},

553

"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен

554

"sessionDuration": 30, ~/~/ Длительность сессии в минутах

555

"status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован

556

"lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя

557

"groups": [], ~/~/ Список ролей пользователя

558

"customGroups": [], ~/~/ Список клиентских ролей пользователя

559

"authDevices": [ ], ~/~/ Список авторизованных устройств

560

"mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств

561

"pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления

}

)))

)))

== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==

567

568

(% class="box warningmessage" %)

569

(((

570

(% lang="en-US" %)**PUT /api/v3/users**

571

)))

572

573

(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.

574

575

(% style="color:#000000" %)Метод запроса: **PUT**

576

577

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

578

579

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

580

581

(% lang="en-US" style="text-align:left" %)

582

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):

583

584

(% lang="en-US" style="text-align:left" %)

585

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

586

587

(% lang="en-US" style="text-align:left" %)

588

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя

589

"lastName": "" , ~/~/ фамилия

590

"firstName": "" , ~/~/ имя

591

"position": "" , ~/~/ должность

592

"phone": "" , ~/~/ телефон

593

"organization": "" , ~/~/ организация

594

"login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%)

595

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)

596

"language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский

597

"isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено

598

"email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%)

599

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание

600

"isEnabled": "" , ~/~/ признак включения

601

"parentId": "" , ~/~/ Guid родительского агента

602

"leaderId": "" , ~/~/ Guid руководителя (null - не задан)

603

"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)

604

"doubleAuth":

605

{

606

"kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен

607

"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации

608

},

609

"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен

610

"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя

611

612

(% lang="en-US" style="text-align:left" %)

613

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__

614

615

(% lang="en-US" style="text-align:left" %)

616

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://

617

618

(% lang="en-US" style="text-align:left" %)

619

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

620

621

(% lang="en-US" style="text-align:left" %)

622

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя

623

"lastName": "" , ~/~/ фамилия

624

"firstName": "" , ~/~/ имя

625

"position": "" , ~/~/ должность

626

"phone": "" , ~/~/ телефон

627

"organization": "" , ~/~/ организация

628

"login": "" , ~/~/ логин

629

"password": "" , ~/~/ пароль

630

"email": "" , ~/~/ email

631

"description": "" , ~/~/ описание

632

"isEnabled": "" , ~/~/ признак включения

633

"parentId": "" , ~/~/ Guid родительского агента

634

"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах

635

"doubleAuth":

636

{

637

"kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен

638

"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации

639

},

640

"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен

641

"target": "" , ~/~/ в случае аутентификации по email - email-адрес

642

"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя

643

644

(% lang="en-US" style="text-align:left" %)

645

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

646

647

== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==

648

649

(% class="box warningmessage" %)

650

(((

651

(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**

652

)))

653

654

(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.

655

656

(% style="color:#000000" %)Метод запроса: **PUT**

657

658

(% 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}

659

660

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя

661

662

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

663

664

(% style="color:#000000" %)Параметры в теле запроса (JSON):

665

666

(% style="color:#000000" %){

667

668

"status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)

669

"description": "" , ~/~/ описание

670

"data": "" , ~/~/ данные, связанные со сменой статуса

671

672

(% style="color:#000000" %)}

673

674

(% style="text-align:left" %)

675

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**

676

677

== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==

678

679

(% class="box warningmessage" %)

680

(((

681

**POST /api/v3/users/disable**

682

)))

683

684

Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).

685

686

(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**

687

688

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]

689

690

(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):

691

692

[

693

"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",

694

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

695

]

696

697

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**

698

699

== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==

700

701

(% class="box warningmessage" %)

702

(((

703

**POST /api/v3/users/enable**

704

)))

705

706

Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).

707

708

(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**

709

710

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]

711

712

(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):

713

714

[

715

"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",

716

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

717

]

718

719

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)

720

\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__

(((

В теле ответа:

{

"errorMessages": [

"Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."

727

],

728

"users": [

729

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

730

]

731

}

732

\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.

733

"users" - массив id пользователей, которых не удалось включить или отключить.

734

)))

735

736

== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==

737

738

(% class="box errormessage" %)

739

(((

740

(% lang="en-US" %)**DELETE /api/v3/users/{id}**

741

)))

742

743

(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.

744

745

(% style="color:#000000" %)Метод запроса: **DELETE**

746

747

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}

748

749

(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя

750

751

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

752

753

(% style="text-align:left" %)

754

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

755

756

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =

757

758

== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==

759

760

(% class="box infomessage" %)

761

(((

762

(% lang="en-US" %)**GET /api/v3/models/{Id}**

763

)))

764

765

Метод возвращает полную информацию о модели объекта.

766

767

(% style="color:#000000" %)Метод запроса: **GET**

768

769

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}

770

771

(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта

772

773

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

774

775

(% style="color:#000000" %)Ответ:

776

777

(% style="color:#000000" %){

778

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

785

"hoppercapacity": 0,

786

"hopperdischargespeed": 0,

787

"modelType": 0,

788

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

789

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

794

|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта

795

|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта

796

|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта

797

|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч

798

|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч

799

|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах

800

|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат

801

|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера

802

|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек

803

|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car

804

|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта

805

|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта

806

|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean

807

808

== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==

809

810

(% class="box successmessage" %)

811

(((

812

(% lang="en-US" %)**POST /api/v3/models/find**

813

)))

814

815

(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.

816

817

(% style="color:#000000" %)Метод запроса: **POST**

818

819

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find

820

821

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

822

823

(% style="color:#000000" %)Параметры в теле запроса (JSON):{

824

825

(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

826

}

827

828

(% style="color:#000000" %)Ответ:

829

830

(% style="color:#000000" %)[

831

{

832

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

833

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

834

"parentName": "string",

"name": "string",

"modelType": 0

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

841

|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта

842

|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта

843

|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car

844

|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта

845

|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта

846

847

== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==

848

849

(% class="box successmessage" %)

850

(((

851

(% lang="en-US" %)**POST /api/v3/models**

852

)))

853

854

(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.

855

856

(% style="color:#000000" %)Метод запроса: **POST**

857

858

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models

859

860

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

861

862

(% style="color:#000000" %)Параметры в теле запроса (JSON):

863

864

{

865

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

866

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

875

"fueloutlay": 0,

876

"hoppercapacity": 0,

877

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

885

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

894

"hoppercapacity": 0,

895

"hopperdischargespeed": 0,

"modelType": 0

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

900

|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта

901

|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта

902

|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта

903

|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта

904

|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта

905

|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч

906

|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч

907

|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах

908

|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат

909

|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера

910

|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек

911

|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car

912

913

== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==

914

915

(% class="box warningmessage" %)

916

(((

917

(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**

918

)))

919

920

(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.

921

922

(% style="color:#000000" %)Метод запроса: **PUT**

923

924

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models

925

926

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

927

928

(% style="color:#000000" %)Параметры в теле запроса (JSON):

929

930

{

931

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

932

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

941

"fueloutlay": 0,

942

"hoppercapacity": 0,

943

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

951

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

960

"fueloutlay": 0,

961

"hoppercapacity": 0,

962

"hopperdischargespeed": 0,

"modelType": 0

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

967

|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта

968

|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта

969

|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта

970

|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта

971

|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта

972

|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч

973

|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч

974

|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах

975

|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат

976

|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера

977

|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек

978

|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car

979

980

== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==

981

982

(% class="box errormessage" %)

983

(((

984

(% lang="en-US" %)**DELETE /api/v3/models/{Id}**

985

)))

986

987

(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.

988

989

(% style="color:#000000" %)Метод запроса: **DELETE**

990

991

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}

992

993

(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели

994

995

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

996

997

Ответ: В случае успеха **Success 200**

998

999

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =

1000

1001

== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==

1002

1003

(% class="box infomessage" %)

1004

(((

1005

(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**

1006

)))

1007

1008

(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».

1009

1010

(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:

1011

1012

(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;

1013

1014

(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.

1015

1016

(% style="color:#000000" %)Метод запроса: **GET**

1017

1018

(% 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}

1019

1020

(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))

1021

1022

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1023

1024

(% style="color:#000000" %)Ответ:

(((

{

"vehicleId": "", ~/~/ ID объекта

1029

"name": "", ~/~/ Имя объекта

1030

"imei": "", ~/~/ IMEI объекта

1031

"deviceTypeId": , ~/~/ ID типа устройства

1032

"deviceTypeName": "", ~/~/ Название типа устройства

1033

"sim1": "", ~/~/ Номер SIM1

1034

"sim2": "", ~/~/ Номер SIM2

1035

1036

"parentId": "", ~/~/ ID клиента-родителя

1037

"parentName": "", ~/~/ Наименование клиента-родителя

1038

"modelId": "", ~/~/ ID модели объекта

1039

"modelName": "", ~/~/ Имя модели объекта

1040

1041

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения

1042

"unitName": "string", ~/~/ Наименование подразделения

1043

"status": 0, ~/~/ Статус объекта

1044

1045

"createdAt": "", ~/~/ Дата создания объекта

1046

},

1047

1048

"customFields": [ ~/~/ Произвольные поля

1049

{

1050

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля

1051

"name": "string", ~/~/ Имя поля

1052

"value": "string", ~/~/ Значение поля

1053

"forClient": true, ~/~/ Не используемая функция

1054

"forTooltip": true, ~/~/ Отображать в подсказке

1055

"forReport": true ~/~/ Отображать в отчете

1056

}

1057

1058

], ~/~/ Данные с вкладки нормы

1059

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1060

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1061

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1062

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1063

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1064

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1065

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1066

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1067

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1068

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1069

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1070

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1071

1072

"mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания

1073

"mileageCoeff": 0, ~/~/ коэффициент пробега

1074

"locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна

1075

"dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна

1076

"counters": { ~/~/ Счетчики

1077

"mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна

1078

"motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна

1079

"mileage": 0, ~/~/ Текущий пробег

1080

"motohours": 0, ~/~/ Текущие моточасы

1081

"mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега

1082

"motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов

1083

},

1084

1085

"cmsv6Parameters": { ~/~/ Настройки видеомониторинга

1086

"id": "string", ~/~/ ID объекта

1087

"enabled": true, ~/~/ Включить, true - активна, false - не активна

1088

"host": "string", ~/~/ CMSV6 Web Host

1089

"login": "string", ~/~/ CMSV6 Account

1090

"password": "string" ~/~/ CMSV6 Password

1091

},

1092

1093

"commandTemplates": [ ~/~/ Шаблоны команд

1094

{

1095

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды

1096

"name": "string", ~/~/ Наименование команды

1097

"command": "string", ~/~/ Текст команды

1098

"retries": 0 ~/~/ Количество попыток

}

],

"sensors": [ ~/~/ Датчики

1103

{

1104

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1105

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1106

"type": 0, ~/~/ Тип датчика

1107

"name": "string", ~/~/ Имя датчика

1108

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1109

"inputNumber": 0, ~/~/ Номер входа

1110

"pseudonym": "string", ~/~/ Псевдоним

1111

"medianDegree": 0, ~/~/ Медианная фильтрация

1112

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1113

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1114

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1115

"gradesTables": [ ~/~/ Массив таблиц тарировки

1116

{

1117

"grades": [ ~/~/ Таблица тарировки 1

1118

{

1119

"input": 0, ~/~/ Входящее значение

1120

"output": 0 ~/~/ Выходящее значение

1121

}

1122

],

1123

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1124

}

1125

],

1126

"showInTooltip": true, ~/~/ Отображать в подсказке

1127

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1128

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1129

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1130

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1131

"expr": "string", ~/~/ Формула

1132

"children": [ ~/~/ массив дочерних датчиков

1133

"string"

1134

],

1135

"customParams": { ~/~/ прочие произвольные параметры

1136

"additionalProp1": "string",

1137

"additionalProp2": "string",

1138

"additionalProp3": "string"

1139

},

1140

1141

~/~/ Характерные для произвольного:

1142

1143

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1144

1145

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1146

1147

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1148

1149

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1150

1151

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1152

1153

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1154

1155

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1156

1157

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1158

1159

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1160

1161

~/~/ "ValueOn": "Вкл.",

1162

1163

~/~/ "ValueOff": "Выкл."

1164

"summaryMaxValue": 0 ~/~/ Макс. значение

1165

}

1166

1167

"drivers": [ ~/~/ Водители

1168

{

1169

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

1170

"name": "string", ~/~/ Наименование

1171

"description": "string",

1172

"isDefault": true ~/~/ По умолчанию

}

],

"inspectionTasks": [ ~/~/ Задания на тех. обслуживание

1177

{

1178

"id": "", ~/~/ ID задания

1179

"enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)

1180

"name": "", ~/~/ Наименование задания

1181

"description": "", ~/~/ Описание задания

1182

"mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1183

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1184

"motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1185

"lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1186

"periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)

1187

"kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1188

"lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)

1189

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

}

],

"statusHistory": [ ~/~/ История статусов

1194

{

1195

"status": 0,

1196

"date": "2023-05-22T09:57:39.562Z",

1197

"description": "string",

1198

"additionalInfo": "string"

}

]

}

)))

(% style="text-align:left" %)

1206

Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:

1207

1208

(% style="text-align:left" %)

1209

0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».

1210

1211

== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==

1212

1213

(% class="box successmessage" %)

1214

(((

1215

(% lang="en-US" %)**POST /api/v3/vehicles**

1216

)))

1217

1218

(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.

1219

1220

(% style="color:#000000" %)Метод запроса: **POST**

1221

1222

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1223

1224

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1225

1226

(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON

1227

1228

(% style="color:#000000" %){

1229

1230

"parentId": "" , ~/~/ ID клиента

1231

"name": "" , ~/~/ имя ТС

1232

"imei": "" , ~/~/ IMEI

1233

"deviceTypeId": "" , ~/~/ ID типа устройства

1234

"modelId": "" , ~/~/ ID модели

1235

"unitId": "" , ~/~/ ID подразделения

1236

"sim1": "" , ~/~/ Номер SIM 1

1237

"sim2": "" , ~/~/ Номер SIM2

1238

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1239

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1240

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1241

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1242

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1243

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1244

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1245

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1246

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1247

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1248

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1249

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1250

1251

"mileageCalcMethod": 0,

1252

"mileageCoeff": 0,

1253

"locationByCellId": true,

1254

"dottedLineTrackWhenNoCoords": true,

1255

"counters": ~/~/ счетчики

1256

{

1257

"mileage": "" , ~/~/ пробег

1258

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1259

"motohours": "" , ~/~/ моточасы

1260

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1261

},

1262

"cmsv6Parameters": { ~/~/ параметры CMSv6

1263

"enabled": true, ~/~/ флаг включения

1264

"id": "" , ~/~/ идентификатор

1265

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1266

"login": "" , ~/~/ имя учетной записи

1267

"password": "" ~/~/ пароль учетной записи

1268

},

1269

"inspectionTasks": ~/~/ задания на ТО

1270

{

1271

"enabled": "" , ~/~/ Признак включения

1272

"name": "" , ~/~/ Имя задания

1273

"description": "" , ~/~/ Описание задания

1274

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1275

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1276

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1277

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1278

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1279

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1280

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1281

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1282

}

1283

1284

"drivers": [ ~/~/ Водители

1285

{

1286

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1291

{

1292

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1300

{

1301

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1302

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1303

"type": 0, ~/~/ Тип датчика

1304

"name": "string", ~/~/ Имя датчика

1305

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1306

"inputNumber": 0, ~/~/ Номер входа

1307

"pseudonym": "string", ~/~/ Псевдоним

1308

"medianDegree": 0, ~/~/ Медианная фильтрация

1309

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1310

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1311

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1312

"gradesTables": [ ~/~/ Массив таблиц тарировки

1313

{

1314

"grades": [ ~/~/ Таблица тарировки 1

1315

{

1316

"input": 0, ~/~/ Входящее значение

1317

"output": 0 ~/~/ Выходящее значение

1318

}

1319

],

1320

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1321

}

1322

],

1323

"showInTooltip": true, ~/~/ Отображать в подсказке

1324

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1325

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1326

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1327

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1328

"expr": "string", ~/~/ Формула

1329

"children": [ ~/~/ массив дочерних датчиков

1330

"string"

1331

],

1332

"customParams": { ~/~/ прочие произвольные параметры

1333

"additionalProp1": "string",

1334

"additionalProp2": "string",

1335

"additionalProp3": "string"

1336

},

1337

1338

~/~/ Характерные для произвольного:

1339

1340

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1341

1342

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1343

1344

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1345

1346

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1347

1348

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1349

1350

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1351

1352

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1353

1354

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1355

1356

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1357

1358

~/~/ "ValueOn": "Вкл.",

1359

1360

~/~/ "ValueOff": "Выкл."

1361

"summaryMaxValue": 0 ~/~/ Макс. значение

1362

}

1363

],

1364

"customFields": [ ~/~/ Произвольные поля

1365

{

1366

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1377

1378

(% style="color:#000000" %){

1379

1380

"vehicleId": "", ~/~/ID ТС

1381

"parentId": "", ~/~/Guid владельца ТС

1382

"name": "", ~/~/Имя объекта

1383

"imei": "", ~/~/IMEI

1384

"deviceTypeId": "", ~/~/ID типа устройства

1385

"modelId": "", ~/~/ID модели

1386

"unitId": "", ~/~/ID подразделения

1387

"sim1": "", ~/~/SIM1

1388

"sim2": "", ~/~/SIM2

1389

"consumptionPer100Km": "", ~/~/Расход топлива на 100 км

1390

"consumptionIdle": "", ~/~/Расход топлива на холостом ходу

1391

"counters": { ~/~/Счётчики

1392

"mileageEnabled": true,

1393

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

"cmsv6Parameters": { ~/~/Параметры CmsV6

1398

"id": null,

1399

"enabled": true, ~/~/флаг включения

1400

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1401

"login": "", ~/~/ имя учетной записи

1402

"password": "" ~/~/ пароль учетной записи

1403

},

1404

"inspectionTasks": { ~/~/ задания на ТО

1405

"id": "", ~/~/ ID задачи

1406

"enabled": false, ~/~/ Признак включения

1407

"name": "", ~/~/ Имя задания

1408

"description": "", ~/~/ Описание задания

1409

"mileageCondition": "", ~/~/ Условие по пробегу

1410

"lastMileage": "", ~/~/ Пробег (в метрах)

1411

"motohoursCondition": "", ~/~/ Условие по моточасам

1412

"lastMotohours": "", ~/~/ Моточасы

1413

"periodicCondition": "", ~/~/ Условие периодичности по времени

1414

"kind": "", ~/~/ Вид периодичности по времени

1415

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1416

}

1417

1418

(% style="text-align:left" %)

1419

(% style="color:#000000" %)}

1420

1421

**Валидация:**

1422

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1423

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1424

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1425

1426

== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==

1427

1428

(% class="box infomessage" %)

1429

(((

1430

(% lang="en-US" %)**POST /api/v3/vehicles/find**

1431

)))

1432

1433

(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

1434

1435

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:

1436

1437

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

1438

1439

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

1440

1441

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

1442

1443

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

1444

1445

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

1446

1447

(% style="color:#000000" %)Метод запроса: **POST**

1448

1449

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

1450

1451

(% style="color:#000000" %)В заголовках запроса:

1452

1453

(% style="color:#000000" %)− Content-Type: __**application/json**__

1454

1455

(% style="color:#000000" %)− X-Auth: Токен авторизации

1456

1457

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1458

1459

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1460

1461

{

1462

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1463

"name": null, ~/~/ Имя ТС (string, опционально)

1464

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1465

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1466

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1467

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1468

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1469

"customFields": null ~/~/ значение любого из произвольных полей ТС

1470

}

1471

1472

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1473

1474

(% style="color:#000000" %)Ответ:

1475

1476

(% style="color:#000000" %){

1477

1478

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1479

"name": "" ~/~/ наименование объекта

1480

"imei": "" ~/~/ IMEI объекта

1481

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1482

"deviceTypeName": "" ~/~/ наименование типа устройства

1483

"sim1": "" ~/~/ первый номер телефона

1484

"sim2": "" ~/~/ второй номер телефона

1485

"parentId": "" ~/~/ идентификатор клиента-родителя

1486

"parentName": "" ~/~/ наименование клиента-родителя

1487

"modelId": "" ~/~/ идентификатор модели объекта

1488

"modelName": "" ~/~/ наименование модели объекта

1489

"unitId": "" ~/~/ идентификатор подразделения

1490

"unitName": "" ~/~/ наименование подразделения

1491

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1492

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1493

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1494

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1495

"customFields": [

1496

{

1497

"id": "", ~/~/ идентификатор произвольного поля

1498

"name": "", ~/~/ имя произвольного поля

1499

"value": "", ~/~/ значение произвольного поля

1500

"forClient": true, ~/~/ право на отображение у клиента

1501

"forTooltip": false, ~/~/ право на отображение в подсказке

1502

"forReport": false ~/~/ право на отображение в отчетах

1503

}(%%)

1504

(% style="color:#000000" %)}

1505

1506

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1507

1508

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1509

1510

(% class="box successmessage" %)

1511

(((

1512

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1513

)))

1514

1515

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1516

1517

(% style="color:#000000" %)Метод запроса: **POST**

1518

1519

(% 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}

1520

1521

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1522

1523

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1524

1525

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1526

1527

(% style="color:#000000" %){

1528

1529

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1530

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1531

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1532

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1533

"description": "", ~/~/ Описание

1534

"data": "", ~/~/ Данные

1535

"overwrite": false, ~/~/ Флаг перезаписи

1536

"stage": "", ~/~/ Состояние, может быть null

1537

1538

(% style="color:#000000" %)}

1539

1540

(% style="color:#000000" %)Ответ:

1541

1542

(% style="color:#000000" %){

1543

1544

"status": "", ~/~/ значение статуса

1545

"date": "", ~/~/ Дата смены статуса

1546

"description": "", ~/~/ Описание

1547

"data": "", ~/~/ Данные

1548

"overwrite": false, ~/~/ Флаг перезаписи

1549

"stage": "", ~/~/ Состояние

1550

1551

(% style="text-align:left" %)

1552

(% style="color:#000000" %) }

1553

1554

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1555

1556

(% class="box warningmessage" %)

1557

(((

1558

(% lang="en-US" %)**PUT /api/v3/vehicles**

1559

)))

1560

1561

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1562

1563

(% style="color:#000000" %)Метод запроса: **PUT**

1564

1565

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1566

1567

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1568

1569

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1570

1571

(% style="color:#000000" %){

1572

"vehicleId": , ~/~/ ID объекта

1573

"parentId": "" , ~/~/ ID клиента

1574

"name": "" , ~/~/ имя ТС

1575

"imei": "" , ~/~/ IMEI

1576

"deviceTypeId": "" , ~/~/ ID типа устройства

1577

"modelId": "" , ~/~/ ID модели

1578

"unitId": "" , ~/~/ ID подразделения

1579

"sim1": "" , ~/~/ Номер SIM 1

1580

"sim2": "" , ~/~/ Номер SIM2

1581

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1582

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1583

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1584

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1585

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1586

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1587

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1588

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1589

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1590

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1591

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1592

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1593

1594

"mileageCalcMethod": 0,

1595

"mileageCoeff": 0,

1596

"locationByCellId": true,

1597

"dottedLineTrackWhenNoCoords": true,

1598

"counters": ~/~/ счетчики

1599

{

1600

"mileage": "" , ~/~/ пробег

1601

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1602

"motohours": "" , ~/~/ моточасы

1603

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1604

},

1605

"cmsv6Parameters": { ~/~/ параметры CMSv6

1606

"enabled": true, ~/~/ флаг включения

1607

"id": "" , ~/~/ идентификатор

1608

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1609

"login": "" , ~/~/ имя учетной записи

1610

"password": "" ~/~/ пароль учетной записи

1611

},

1612

"inspectionTasks": ~/~/ задания на ТО

1613

{

1614

"enabled": "" , ~/~/ Признак включения

1615

"name": "" , ~/~/ Имя задания

1616

"description": "" , ~/~/ Описание задания

1617

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1618

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1619

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1620

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1621

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1622

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1623

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1624

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1625

}

1626

1627

"drivers": [ ~/~/ Водители

1628

{

1629

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1634

{

1635

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1643

{

1644

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1645

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1646

"type": 0, ~/~/ Тип датчика

1647

"name": "string", ~/~/ Имя датчика

1648

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1649

"inputNumber": 0, ~/~/ Номер входа

1650

"pseudonym": "string", ~/~/ Псевдоним

1651

"medianDegree": 0, ~/~/ Медианная фильтрация

1652

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1653

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1654

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1655

"gradesTables": [ ~/~/ Массив таблиц тарировки

1656

{

1657

"grades": [ ~/~/ Таблица тарировки 1

1658

{

1659

"input": 0, ~/~/ Входящее значение

1660

"output": 0 ~/~/ Выходящее значение

1661

}

1662

],

1663

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1664

}

1665

],

1666

"showInTooltip": true, ~/~/ Отображать в подсказке

1667

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1668

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1669

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1670

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1671

"expr": "string", ~/~/ Формула

1672

"children": [ ~/~/ массив дочерних датчиков

1673

"string"

1674

],

1675

"customParams": { ~/~/ прочие произвольные параметры

1676

"additionalProp1": "string",

1677

"additionalProp2": "string",

1678

"additionalProp3": "string"

1679

},

1680

1681

~/~/ Характерные для произвольного:

1682

1683

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1684

1685

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1686

1687

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1688

1689

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1690

1691

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1692

1693

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1694

1695

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1696

1697

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1698

1699

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1700

1701

~/~/ "ValueOn": "Вкл.",

1702

1703

~/~/ "ValueOff": "Выкл."

1704

"summaryMaxValue": 0 ~/~/ Макс. значение

1705

}

1706

],

1707

"customFields": [ ~/~/ Произвольные поля

1708

{

1709

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1720

1721

(% lang="en-US" style="text-align:left" %)

1722

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1723

1724

(% lang="en-US" style="text-align:left" %)

1725

"vehicleId": "", ~/~/ ID ТС

1726

"parentId": "", ~/~/ ID клиента

1727

"name": "", ~/~/ имя ТС

1728

"imei": "", ~/~/ IMEI

1729

"deviceTypeId": "", ~/~/ типа устройства

1730

"modelId": "", ~/~/ ID модели

1731

"unitId": "", ~/~/ ID подразделения

1732

"sim1": "", ~/~/ SIM 1

1733

"sim2": "", ~/~/ SIM2

1734

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1735

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1736

"counters":

1737

{

1738

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1739

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1740

"mileage": "", ~/~/ пробег

1741

"motohours": "", ~/~/ моточасы

1742

}

1743

"cmsv6Parameters": ~/~/ параметры CMSv6

1744

{

1745

"id": ~/~/ идентификатор

1746

"enabled": true, ~/~/ флаг включения

1747

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1748

"login": "", ~/~/ имя учетной записи

1749

"password": "", ~/~/ пароль учетной записи

1750

}

1751

"inspectionTasks": ~/~/ задания на ТО

1752

{

1753

"id": "", ~/~/ ID задания

1754

"enabled": false, ~/~/ Признак включения

1755

"name": "", ~/~/ Имя задания

1756

"description": "", ~/~/ Описание задания

1757

"mileageCondition": "", ~/~/ Условие по пробегу

1758

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1759

"motohoursCondition": "", ~/~/ Условие по моточасам

1760

"lastMotohours": "", ~/~/ Моточасы

1761

"periodicCondition": "", ~/~/ Условие периодичности по времени

1762

"kind": "", ~/~/ Вид периодичности по времени

1763

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1764

}

1765

1766

(% lang="en-US" style="text-align:left" %)

1767

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1768

1769

**Валидация:**

1770

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1771

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1772

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1773

1774

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1775

1776

(% class="box errormessage" %)

1777

(((

1778

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1779

)))

1780

1781

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1782

1783

(% style="color:#000000" %)Метод запроса: **DELETE**

1784

1785

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1786

1787

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1788

1789

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1790

1791

(% style="text-align:left" %)

1792

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1793

1794

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1795

1796

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1797

1798

(% class="box infomessage" %)

1799

(((

1800

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1801

)))

1802

1803

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1804

1805

(% style="color:#000000" %)Метод запроса: **GET**

1806

1807

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]

1808

1809

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1810

1811

(% style="color:#000000" %)Ответ:

1812

1813

(% style="color:#000000" %){

1814

1815

"deviceTypeId" : "", ~/~/ ID типа устройства

1816

"deviceTypeName" : "" ~/~/ Название типа устройства

1817

1818

(% style="text-align:left" %)

1819

(% style="color:#000000" %)}

1820

1821

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1822

1823

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1824

1825

(% class="box infomessage" %)

1826

(((

1827

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1828

)))

1829

1830

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1831

1832

(% style="color:#000000" %)Метод запроса: **GET**

1833

1834

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1835

1836

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1837

1838

(% style="color:#000000" %)Ответ:

1839

1840

(% style="color:#000000" %){

1841

1842

"id": "", ~/~/ ID типа датчика

1843

"name": "", ~/~/ Название

1844

"description": "", ~/~/ Описание

1845

1846

(% style="text-align:left" %)

1847

(% style="color:#000000" %)}

1848

1849

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1850

1851

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1852

1853

(% class="box infomessage" style="text-align: left;" %)

1854

(((

1855

**POST /api/v3/terminalMessages/count**

1856

)))

1857

1858

(% style="text-align: left;" %)

1859

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1860

1861

(% style="text-align: left;" %)

1862

Метод запроса **POST**

1863

1864

(% style="text-align: left;" %)

1865

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1866

1867

(% style="text-align: left;" %)

1868

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1869

1870

(% style="text-align: left;" %)

1871

{

1872

"vehicleIds": [

1873

id ~/~/ здесь передается список идентификаторов объектов

1874

],

1875

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1876

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1877

}

1878

1879

(% style="text-align: left;" %)

1880

Ответ:

1881

1882

(% style="text-align: left;" %)

1883

[

1884

{

1885

"vehicleId": 0, ~/~/ идентификатор объекта

1886

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1891

1892

(% class="box infomessage" style="text-align: left;" %)

1893

(((

1894

**POST /api/v3/terminalMessages/mapping**

1895

)))

1896

1897

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

1898

1899

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

1900

1901

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

{

"protocolType": 0,

"params": ["string"]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1909

|protocolType|ID типа протокола

1910

|params|(((

1911

Массив наименований параметров в сообщении

)))

Ответ:

{

"protocolType": 0,

"mapping": {

"additionalProp1": {

"inputType": 0,

"inputNumber": 0

},

"additionalProp2": {

"inputType": 0,

"inputNumber": 0

}

}

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1931

|protocolType|Тип протокола

1932

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

1933

|inputNumber|Номер входа

1934

1935

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

1936

1937

(% class="box infomessage" %)

1938

(((

1939

**POST /api/v3/terminalMessages**

1940

)))

1941

1942

Метод возвращает список сообщений терминала объекта за выбранный период.

1943

1944

(% style="text-align: left;" %)

1945

Метод запроса **POST**

1946

1947

(% style="text-align: left;" %)

1948

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

1949

1950

(% style="text-align: left;" %)

1951

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1952

1953

{

1954

"vehicleId": 0, ~/~/ id объекта

1955

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

1956

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

}

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства

1966

"serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера

1967

"speed": 0, ~/~/ Скорость, км/ч

1968

"altitude": 0, ~/~/ Высота, м

1969

"latitude": 0, ~/~/ Широта [-90°;90°]

1970

"longitude": 0, ~/~/ Долгота [-180°;180°]

1971

"satellites": 0, ~/~/ Кол-во спутников

1972

"voltage": 0, ~/~/ Напряжение

1973

"parameters": { ~/~/ список параметров датчиков передаваемых терминалом

1974

"additionalProp1": "string",

1975

"additionalProp2": "string",

1976

"additionalProp3": "string"

1977

},

1978

"photoCount": 0 ~/~/ Кол-во фото

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

1985

1986

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

1987

1988

(% class="box infomessage" %)

1989

(((

1990

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

1991

)))

1992

1993

(% style="color:#000000" %)Метод запроса: **POST**

1994

1995

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

1996

1997

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1998

1999

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2004

"vehicleIds": [0], ~/~/ Список ID объектов

2005

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2006

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2007

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2015

"name": "string", ~/~/ Имя ТС

2016

"periods": [ ~/~/ Периоды

2017

{

2018

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2019

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2020

"mileageBegin": 0, ~/~/ Пробег на начало периода

2021

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2022

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2023

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2030

2031

(% class="box infomessage" %)

2032

(((

2033

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2034

)))

2035

2036

(% style="color:#000000" %)Метод запроса: **POST**

2037

2038

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2039

2040

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2041

2042

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2047

"vehicleIds": [0], ~/~/ Список ID объектов

2048

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2049

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2050

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2058

"name": "string", ~/~/ Имя ТС

2059

"periods": [ ~/~/ Периоды

2060

{

2061

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2062

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2063

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2064

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2065

"fuelConsumption": 0, ~/~/ Расход топлива

2066

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2073

2074

(% class="box infomessage" %)

2075

(((

2076

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2077

)))

2078

2079

(% style="color:#000000" %)Метод запроса: **POST**

2080

2081

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2082

2083

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2084

2085

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2090

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2091

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2092

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2100

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2101

"vehicleId": 0, ~/~/ ID объекта

2102

"name": "string", ~/~/ Имя объекта

2103

"model": "string", ~/~/ Модель объекта

2104

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2105

{

2106

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2107

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2108

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2109

"valueFuel": 0, ~/~/ Количество

2110

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2111

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2118

2119

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2120

2121

(% class="box infomessage" %)

2122

(((

2123

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2124

)))

2125

2126

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2127

2128

(% style="color:#000000" %)Метод запроса: **POST**

2129

2130

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2131

2132

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2133

2134

(% style="text-align:left" %)

2135

Тело запроса:

2136

2137

(% style="text-align:left" %)

2138

{

2139

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2140

}

2141

2142

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2148

"name": "string", ~/~/ Название объекта геозоны

2149

"type": 0, ~/~/ Тип объекта геозоны

2150

"fname": "string", ~/~/ Имя файла

2151

"parentId": "string", ~/~/ Идентификатор клиента

2152

"radius": 0, ~/~/ Радиус геообъекта

2153

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2154

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2155

"description": "string", ~/~/ Описание

2156

"area": 0, ~/~/ Площадь, м^^2^^

2157

"perimetr": 0, ~/~/ Периметр, м

2158

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2163

2164

(% class="box infomessage" %)

2165

(((

2166

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2167

)))

2168

2169

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2170

2171

(% style="color:#000000" %)Метод запроса: **POST**

2172

2173

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2174

2175

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2176

2177

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2182

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2183

"ids": [ ], ~/~/ Массив id объектов

2184

"byTime": 0, ~/~/ Объединение событий по времени

2185

"byDist": 0, ~/~/ Объединение событий по расстоянию

2186

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2187

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2194

"geozoneName": "string", ~/~/ Название геообъекта

2195

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2196

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2197

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2198

"vehicleId": 0, ~/~/ ID объекта

2199

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2204

2205

(% class="box infomessage" %)

2206

(((

2207

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2208

)))

2209

2210

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2211

2212

(% style="color:#000000" %)Метод запроса: **POST**

2213

2214

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2215

2216

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2217

2218

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2223

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2224

"ids": [ ], ~/~/ Массив id геообъектов

2225

"byTime": 0, ~/~/ Объединение событий по времени

2226

"byDist": 0, ~/~/ Объединение событий по расстоянию

2227

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2228

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2236

"geozoneName": "string", ~/~/ Название геообъекта

2237

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2238

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2239

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2240

"vehicleId": 0, ~/~/ ID объекта

2241

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2246

2247

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2248

2249

(% class="box infomessage" %)

2250

(((

2251

**POST /api/v3/notifications/find**

2252

)))

2253

2254

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2255

2256

(% style="text-align: left;" %)

2257

Метод запроса **POST**

2258

2259

(% style="text-align: left;" %)

2260

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2261

2262

(% style="text-align: left;" %)

2263

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2264

2265

{

2266

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2274

"name": "string", ~/~/ Название уведомления

2275

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2276

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2277

"userId": "", ~/~/ Пользователь, создавший уведомление

2278

"parentId": "", ~/~/ Идентификатор клиента

2279

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2284

2285

(% class="box infomessage" %)

2286

(((

2287

**GET /api/v3/notifications/{id}**

2288

)))

2289

2290

Метод возвращает данные правил формирования выбранного уведомления.

2291

2292

(% style="text-align: left;" %)

2293

Метод запроса **GET**

2294

2295

(% style="text-align: left;" %)

2296

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2297

2298

(% style="text-align: left;" %)

2299

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2300

2301

(% style="text-align: left;" %)

2302

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2303

2304

(% style="text-align: left;" %)

2305

(% style="color:#000000" %)Ответ:

2306

2307

(% style="text-align: left;" %)

2308

(% style="color:#000000" %){

2309

"id": 0, ~/~/ (%%)id уведомления

2310

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2311

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2312

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2313

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2314

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2315

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2316

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2317

(% style="color:#000000" %) 0

2318

],

2319

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2320

(% style="color:#000000" %) 0

2321

],

2322

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2323

(% style="color:#000000" %) 0

2324

],

2325

"settings": { ~/~/ Список параметров уведомления

2326

"additionalProp1": "string",

2327

"additionalProp2": "string",

2328

"additionalProp3": "string"

2329

},

2330

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2331

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2332

(% style="color:#000000" %) ""

2333

],

2334

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2335

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2336

(% style="color:#000000" %) "string"

2337

],

2338

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2339

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2340

(% style="color:#000000" %) {

2341

"id": 0, ~/~/ (%%)Идентификатор участника чата

2342

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2343

(% style="color:#000000" %) }

2344

],

2345

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2346

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2347

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2348

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2349

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2350

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2351

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2352

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2353

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2354

(% style="color:#000000" %)}

2355

2356

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2357

2358

(% class="box warningmessage" %)

2359

(((

2360

**PUT /api/v3/notifications/**

2361

)))

2362

2363

Метод позволяет отредактировать уведомление.

2364

2365

Метод запроса **PUT**

2366

2367

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2368

2369

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2374

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2375

"userId": "", ~/~/ Пользователь, создавший уведомление

2376

"parentId": "", ~/~/ Идентификатор клиента

2377

"parentName": "string", ~/~/ Имя клиента

2378

"name": "string", ~/~/ Название уведомления

2379

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2380

"vehicleIds": [ ~/~/ Список id объектов для анализа

2381

0

2382

],

2383

"geoids": [ ~/~/ Список id геообъектов для анализа

2384

0

2385

],

2386

"fieldids": [ ~/~/ Список id полей для анализа

2387

0

2388

],

2389

"settings": { ~/~/ Список параметров уведомления

2390

"additionalProp1": "string",

2391

"additionalProp2": "string",

2392

"additionalProp3": "string"

2393

},

2394

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2395

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2396

""

2397

],

2398

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2399

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2400

"string"

2401

],

2402

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2403

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2404

{

2405

"id": 0, ~/~/ Идентификатор участника чата

2406

"info": "string" ~/~/ Дополнительные сведения

2407

}

2408

],

2409

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2410

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2411

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2412

"kind": 0, ~/~/ Определяет вид уведомления

2413

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2414

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2415

"timezone": 0, ~/~/ Сдвиг часового пояса

2416

"validity": 0, ~/~/ Срок действия в днях (1-90)

2417

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2425

2426

(% class="box errormessage" %)

2427

(((

2428

**DELETE /api/v3/notifications/{id}**

2429

)))

2430

2431

Метод позволяет удалить выбранное уведомление.

2432

2433

Метод запроса **DELETE**

2434

2435

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2436

2437

Передаваемый параметр: {id} - id уведомления

2438

2439

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2447

2448

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2449

2450

(% class="box infomessage" %)

2451

(((

2452

**POST /api/v3/Drivers/find**

2453

)))

2454

2455

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2462

"description": "string", ~/~/ Определяет описание

2463

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2464

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2465

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2466

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2467

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2468

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2473

2474

(% class="box infomessage" %)

2475

(((

2476

**GET /api/v3/Drivers/{driverGuid}**

2477

)))

2478

2479

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2485

"description": "string", ~/~/ Определяет описание

2486

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2487

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2488

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2489

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2490

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2491

"deleted": true ~/~/ Признак удаления

2492

}

2493

2494

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2495

2496

(% class="box successmessage" %)

2497

(((

2498

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2506

"hiredate": "2023-06-30T12:50:54.020Z",

2507

"chopdate": "2023-06-30T12:50:54.020Z",

2508

"exclusive": true,

2509

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2510

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2519

"hiredate": "2023-06-30T12:50:54.051Z",

2520

"chopdate": "2023-06-30T12:50:54.051Z",

2521

"exclusive": true,

2522

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2523

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2529

2530

(% class="box warningmessage" %)

2531

(((

2532

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2540

"hiredate": "2023-06-30T12:50:27.910Z",

2541

"chopdate": "2023-06-30T12:50:27.910Z",

2542

"exclusive": true,

2543

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2544

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2553

"hiredate": "2023-06-30T12:50:27.929Z",

2554

"chopdate": "2023-06-30T12:50:27.929Z",

2555

"exclusive": true,

2556

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2557

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2563

2564

(% class="box errormessage" %)

2565

(((

2566

**DELETE /api/v3/Drivers/{driverGuid}**

2567

)))

2568

2569

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2577

2578

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2579

2580

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2581

2582

(% class="box infomessage" %)

2583

(((

2584

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2592

],

2593

"BeginTime": "2023-06-30T12:49:04.365Z",

2594

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2603

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2604

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2605

"BeginTime": "2023-06-30T09:52:31.240Z",

2606

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2612

2613

(% class="box infomessage" %)

2614

(((

2615

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2625

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2634

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2635

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2636

"BeginTime": "2023-06-30T09:54:01.631Z",

2637

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2643

2644

(% class="box successmessage" %)

2645

(((

2646

**POST /api/v3/DriversVehiclesAssignments**

2647

)))

2648

2649

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2656

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2657

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2658

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2659

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2669

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2670

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2671

"BeginTime": "2023-06-30T11:04:46.903Z",

2672

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2678

2679

(% class="box warningmessage" %)

2680

(((

2681

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2690

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2691

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2692

"BeginTime": "2023-06-30T11:14:08.117Z",

2693

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2703

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2704

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2705

"BeginTime": "2023-06-30T11:14:53.349Z",

2706

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2712

2713

(% class="box errormessage" %)

2714

(((

2715

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2730

2731

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2732

2733

(% class="box infomessage" %)

2734

(((

2735

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2743

],

2744

"BeginTime": "2023-06-30T12:47:12.162Z",

2745

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2753

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2754

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2755

"BeginTime": "2023-06-30T11:19:40.703Z",

2756

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2762

2763

(% class="box infomessage" %)

2764

(((

2765

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2773

],

2774

"BeginTime": "2023-06-30T12:47:12.162Z",

2775

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2783

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2784

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2785

"BeginTime": "2023-06-30T11:19:40.703Z",

2786

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2792

2793

(% class="box successmessage" %)

2794

(((

2795

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2803

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2804

"BeginTime": "2023-06-30T11:27:08.635Z",

2805

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2814

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2815

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2816

"BeginTime": "2023-06-30T11:27:08.677Z",

2817

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

2823

2824

(% class="box warningmessage" %)

2825

(((

2826

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2834

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2835

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2836

"BeginTime": "2023-06-30T11:28:43.330Z",

2837

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2846

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2847

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2848

"BeginTime": "2023-06-30T11:28:43.331Z",

2849

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

2855

2856

(% class="box errormessage" %)

2857

(((

2858

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

2873

2874

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

2875

2876

(% class="box infomessage" %)

2877

(((

2878

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2886

],

2887

"BeginTime": "2023-06-30T12:45:10.852Z",

2888

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2896

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2897

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2898

"BeginTime": "2023-06-30T11:58:04.695Z",

2899

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

2905

2906

(% class="box infomessage" %)

2907

(((

2908

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2916

],

2917

"BeginTime": "2023-06-30T12:45:10.852Z",

2918

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2926

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2927

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2928

"BeginTime": "2023-06-30T11:58:04.695Z",

2929

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

2935

2936

(% class="box successmessage" %)

2937

(((

2938

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2946

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2947

"BeginTime": "2023-06-30T12:09:53.175Z",

2948

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2957

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2958

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2959

"BeginTime": "2023-06-30T12:09:53.201Z",

2960

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

2966

2967

(% class="box warningmessage" %)

2968

(((

2969

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2977

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2978

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2979

"BeginTime": "2023-06-30T12:09:53.201Z",

2980

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2989

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2990

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2991

"BeginTime": "2023-06-30T12:09:53.201Z",

2992

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

2998

2999

(% class="box errormessage" %)

3000

(((

3001

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3016

3017

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3018

3019

(% class="box infomessage" %)

3020

(((

3021

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3028

"endDate": "2023-11-14T10:48:03.671Z",

"ids": [ 0 ],

"timezone": 0

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3034

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3035

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3036

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3037

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3044

"ED": "2023-11-14T10:48:03.717Z",

"id": 0,

"SLat": 0,

"SLon": 0,

"ELat": 0,

"ELon": 0,

"mileage": 0

"Duration": 0

"Address": "string",

"Address2": "string",

3054

"name": "string",

3055

"rid": "string",

3056

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3057

"trailer": {

3058

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3059

"Number": "string",

3060

"Description": "string",

3061

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3062

"ExternalID": "string",

3063

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3064

"CreateTime": "2023-11-14T10:48:03.717Z",

3065

"UpdateTime": "2023-11-14T10:48:03.717Z",

"IsDeleted": true

},

"filesCount": 0,

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3073

|SD|Дата и время начала события

3074

|ED|Дата и время окончания события

3075

|id|ID объекта

3076

|SLat|Широта начальной координаты

3077

|SLon|Долгота начальной координаты

3078

|ELat|Широта конечной координаты

3079

|ELon|Долгота конечной координаты

3080

|mileage|Пробег

3081

|Duration|Продолжительность

3082

|Address|Адрес начального местоположения

3083

|Address2|Адрес конечного местоположения

3084

|name|Имя радиометки

3085

|rid|Номер радиометки

3086

|rguid|ID радиометки

3087

|trailer|Информация об агрегате

3088

|ModelGuid|ID агрегата

3089

|Number|Название/номер агрегата

3090

|Description|Текст примечания агрегата

3091

3092

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3093

3094

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3095

3096

(% class="box infomessage" %)

3097

(((

3098

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3115

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3120

|parentId|ID клиента

3121

|name|Название карты-метки

3122

|number|Номер

3123

|period|Период запросов в секундах (работает только для агрегатов)

3124

|id|ID карты-метки

3125

3126

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3127

3128

(% class="box infomessage" %)

3129

(((

3130

**GET /api/v3/Rfids/{rfidGuid}**

3131

)))

3132

3133

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3143

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3148

|name|Название карты-метки

3149

|number|Номер

3150

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3155

3156

(% class="box successmessage" %)

3157

(((

3158

**POST /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3177

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3178

}

3179

3180

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3181

|name|Название карты-метки

3182

|number|Номер

3183

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3188

3189

(% class="box warningmessage" %)

3190

(((

3191

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3201

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3211

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3212

}

3213

3214

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3215

|name|Название карты-метки

3216

|number|Номер

3217

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3222

3223

(% class="box errormessage" %)

3224

(((

3225

**DELETE /api/v3/Rfids/{rfidGuid}**

3226

)))

3227

3228

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3236

3237

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3238

3239

(% class="box infomessage" %)

3240

(((

3241

**GET /api/v3/Billing/client/balance/{clientId}**

3242

)))

3243

3244

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3254

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3255

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3256

3257

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3258

3259

(% class="box infomessage" %)

3260

(((

3261

**GET /api/v3/Billing/client/constraint/{clientId}**

3262

)))

3263

3264

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3270

"CalculationType": 0,

3271

"PermissibleBalance": 0,

3272

"DefermentDays": 0,

3273

"SendUiNotifications": true,

3274

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3279

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3280

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3281

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3282

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3283

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3284

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3285

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3286

3287

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3288

3289

(% class="box infomessage" %)

3290

(((

3291

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3297

3298

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3304

"Plan": { **~/~/ Описание тарифного плана**

3305

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3306

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3311

"PermissibleBalance": 0,

3312

"DefermentDays": 0

3313

},

3314

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3326

"Features": [ **~/~/ Описание услуг тарифного плана как есть**

{

"Feature": "string",

"IsEnabled": true,

"IsPrivate": true,

"IsFactual": true,

"Limit": 0,

"Price": 0,

"DebitDate": "2023-10-18T12:46:24.213Z",

"PeriodValue": 0,

"PeriodType": 0

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3342

|ClientId|Идентификатор клиента

3343

|Id|Идентификатор тарифного плана

3344

|OwnerId|Идентификатор клиента-владельца

3345

|Name|Наименование тарифного плана

3346

|IsArchived|Признак, определяющий архивный тарифный план

3347

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3348

|PermissibleBalance|Допустимый баланс

3349

|DefermentDays|Отсрочка, количество дней

3350

|Feature|Код услуги

3351

|IsEnabled|Признак, определяющий активирована ли услуга

3352

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3353

|IsFactual|Признак, определяющий расчёт по факту

3354

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3355

|Price|Цена за единицу.

3356

|DebitDate|Следующий момент времени списания с баланса за услугу.

3357

|PeriodValue|Значение периода.

3358

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3359

3360

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3361

3362

(% class="box infomessage" %)

3363

(((

3364

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3365

)))

3366

3367

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3374

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3379

"PermissibleBalance": 0,

"DefermentDays": 0

},

"Features": [

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3396

|ClientId|Идентификатор клиента

3397

|Id|Идентификатор тарифного плана

3398

|OwnerId|Идентификатор клиента-владельца

3399

|Name|Наименование тарифного плана

3400

|IsArchived|Признак, определяющий архивный тарифный план

3401

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3402

|PermissibleBalance|Допустимый баланс

3403

|DefermentDays|Отсрочка, количество дней

3404

|Feature|Код услуги

3405

|IsFactual|Признак, определяющий расчёт по факту

3406

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3407

|Price|Цена за единицу.

3408

|PeriodValue|Значение периода.

3409

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3410

3411

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3412

3413

(% class="box infomessage" %)

3414

(((

3415

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3416

)))

3417

3418

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3425

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3430

"PermissibleBalance": 0,

"DefermentDays": 0

},

"Features": [

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3447

|ClientId|Идентификатор клиента

3448

|Id|Идентификатор тарифного плана

3449

|OwnerId|Идентификатор клиента-владельца

3450

|Name|Наименование тарифного плана

3451

|IsArchived|Признак, определяющий архивный тарифный план

3452

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3453

|PermissibleBalance|Допустимый баланс

3454

|DefermentDays|Отсрочка, количество дней

3455

|Feature|Код услуги

3456

|IsFactual|Признак, определяющий расчёт по факту

3457

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3458

|Price|Цена за единицу.

3459

|PeriodValue|Значение периода.

3460

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3461

3462

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3463

3464

(% class="box warningmessage" %)

3465

(((

3466

**PUT /api/v3/Billing/client/balance**

3467

)))

3468

3469

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3481

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3482

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3483

3484

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3485

3486

(% class="box warningmessage" %)

3487

(((

3488

**PUT /api/v3/billing/client/balance/deposit**

3489

)))

3490

3491

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3503

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3504

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3505

3506

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3507

3508

Создает операцию **Списание **с указанной суммой

3509

3510

(% class="box warningmessage" %)

3511

(((

3512

**PUT /api/v3/billing/client/balance/withdraw**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3525

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3526

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3527

3528

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3529

3530

(% class="box warningmessage" %)

3531

(((

3532

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3539

"CalculationType": 0,

3540

"PermissibleBalance": 0,

3541

"DefermentDays": 0,

3542

"SendUiNotifications": true,

3543

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3550

|ClientId|Идентификатор клиента

3551

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3552

|PermissibleBalance|Допустимый баланс

3553

|DefermentDays|(((

3554

Отсрочка, количество дней

3555

)))

3556

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3557

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3558

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3559

3560

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3561

3562

(% class="box warningmessage" %)

3563

(((

3564

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3571

"PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Features": [

{

"Feature": "string",

"IsEnabled": true,

"IsFactual": true,

"Limit": 0,

"Price": 0,

"DebitDate": "2023-10-18T13:26:58.987Z",

"PeriodValue": 0,

"PeriodType": 0

}

]

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3589

|ClientId|Идентификатор клиента

3590

|PlanId|Идентификатор тарифного плана

3591

|Feature|Код услуги

3592

|IsEnabled|Признак, определяющий активирована ли услуга

3593

|IsFactual|Признак, определяющий расчёт по факту

3594

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3595

|Price|Цена за единицу.

3596

|DebitDate|Следующий момент времени списания с баланса за услугу.

3597

|PeriodValue|Значение периода.

3598

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3599

3600

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3601

3602

(% class="box warningmessage" %)

3603

(((

3604

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3605

)))

3606

3607

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3608

3609

(% class="box infomessage" %)

3610

(((

3611

**POST /api/v3/vehicles/import/{agentId}**

3612

)))

3613

3614

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3615

3616

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3625

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3626

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3627

3628

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3633

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3634

|csv|В значении передаем файл датчиков, формат **csv**

Ответ:

{

"vehicleId": 0,

"name": "string",

"errors": ["string"]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3645

|vehicleId|ID созданного объекта

3646

|name|Имя созданного объекта

3647

|errors|Ошибки и их описание

3648

3649

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3650

3651

(% class="box infomessage" %)

3652

(((

3653

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3654

)))

3655

3656

(% class="wikigeneratedid" %)

3657

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3658

3659

(% class="wikigeneratedid" %)

3660

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3665

3666

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3671

|**history**|В значении передавать файл с историей

3672

3673

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3686

"lastMessageDate": "2023-11-28T09:27:58.949Z",

"producedCount": 0,

"msgCount": 0

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3694

|results|Результаты импорта в разрезе ТС

3695

|vehicleGuid|Guid ТС

3696

|vehicleId|ID ТС

3697

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3698

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3699

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3700

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3701

|msgCount|Кол-во обработанных сообщений всего

3702

3703

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3704

3705

(% class="box infomessage" %)

3706

(((

3707

**GET /api/v3/vehicles/import/history/status**

3708

)))

3709

3710

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3721

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3722

|progress|Guid ТС

3723

3724

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3725

3726

(% class="box infomessage" %)

3727

(((

3728

**POST /api/v3/vehicles/export**

3729

)))

3730

3731

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3740

3741

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3742

3743

(% class="box infomessage" %)

3744

(((

3745

**POST /api/v3/vehicles/export/history**

3746

)))

3747

3748

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3756

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3762

3763

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3764

|vehicleId|ID объекта

3765

|asArchive|true - Архивировать файл, False - не архивировать

3766

|from|Дата и время начала запроса

3767

|to|Дата и время окончания запроса

3768

3769

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3770

3771

(% class="box infomessage" %)

3772

(((

3773

**GET /api/v3/vehicles/export/history/status**

3774

)))

3775

3776

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3787

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3788

|progress|Прогресс экспорта, от 0 до 100%

3789

|message|Текст описывающий статус

3790

3791

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3792

3793

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==

3794

3795

(% class="box infomessage" %)

3796

(((

3797

**POST /api/v3/EcoDriving/rating**

3798

)))

3799

3800

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3806

"from": "2023-11-22T09:29:48.051Z",

3807

"to": "2023-11-22T09:29:48.051Z"

3808

}

3809

3810

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3811

|vehicleIds|Массив ID объектов

3812

|from|Дата начала запроса

3813

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

3821

"to": "2023-11-22T09:29:48.052Z",

3822

"vehicleId": 0,

3823

"vehicleName": "string",

3824

"vehicleModel": "string",

3825

"penalty": 0,

3826

"score": 0,

3827

"totalViolations": 0,

3828

"violationsByType": {

3829

"overspeedingViolations": 0,

3830

"accelerationViolations": 0,

3831

"brakingViolations": 0,

3832

"turningViolations": 0,

3833

"dangerousDrivingViolations": 0,

3834

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

3844

"violationsByType": {

3845

"overspeedingViolations": 0,

3846

"accelerationViolations": 0,

3847

"brakingViolations": 0,

3848

"turningViolations": 0,

3849

"dangerousDrivingViolations": 0,

3850

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

3857

"endAddress": "string",

3858

"drivers": [

3859

{

3860

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3861

"driverName": "string",

3862

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3872

|from|Дата начала запроса

3873

|to|Дата окончания

3874

|vehicleId|ID объекта

3875

|vehicleName|Имя объекта

3876

|vehicleModel|Модель объекта

3877

|penalty|Сумма штрафных баллов

3878

|score|Оценка

3879

|totalViolations|Суммарное количество нарушений

3880

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

3881

|overspeedingViolations|Превышение скорости

3882

|accelerationViolations|Ускорение

3883

|brakingViolations|Торможение

3884

|turningViolations|Резкий поворот

3885

|dangerousDrivingViolations|Резкое вождение

3886

|sensorViolations|Нарушение по датчику

3887

|moveTime|Время в движении

3888

|mileage|Пробег

3889

|tripsCount|Количество рейсов

3890

|motohours|Моточасы

3891

|maxSpeed|Максимальная скорость

3892

|startAddress|Адрес начала рейса

3893

|endAddress|Адрес окончания рейса

3894

|drivers|Список водителей, которые были на объекте в течениии рейса

3895

|driverGuid|Guid водителя

3896

|driverName|Имя водителя

3897

|driverRfid|Номер Карты-метки

3898

3899

(% class="box" lang="en-US" style="text-align: center;" %)

3900

(((

3901

(% 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]] **

3902

)))

Исходный код вики Методы API для работы с ГЛОНАССSoft