Методы 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

(% class="wikigeneratedid" %)

64

Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])

65

66

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

67

68

(% class="box infomessage" %)

69

(((

70

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

71

)))

72

73

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

74

75

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

76

77

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

78

79

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

80

81

(% lang="en-US" %)

82

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

83

84

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

85

86

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

87

88

(% class="box infomessage" %)

89

(((

90

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

91

)))

92

93

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

94

95

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

96

97

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

98

99

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

100

101

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

102

103

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

108

"name": "string",

109

"fullName": "string",

110

"agentInfoType": 0,

111

"isForeign": true/false,

112

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

119

"email": "string",

120

"director": "string",

121

"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);" %)**Описание**

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

149

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

150

151

(% class="box infomessage" %)

152

(((

153

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

154

)))

155

156

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

157

158

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

159

160

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

161

162

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

163

164

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

165

166

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

167

168

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

169

170

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

"parentId": "string"

}

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

175

176

{

177

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

178

"parentId": "",

179

"name": "string",

180

"fullName": "string",

181

"agentInfoType": 0,

182

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

}

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

187

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

188

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

189

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

190

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

191

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

192

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

193

194

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

195

196

(% class="box successmessage" %)

197

(((

198

**POST /api/v3/agents **

199

)))

200

201

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

202

203

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

204

205

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

206

207

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

208

209

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

210

211

{

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

}

Ответ:

{

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

}

256

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

279

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

280

281

(% class="box warningmessage" %)

282

(((

283

**PUT /api/v3/agents**

284

)))

285

286

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

287

288

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

289

290

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

291

292

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

293

294

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

295

296

{

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

}

Ответ:

{

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

}

340

341

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

342

343

(% class="box errormessage" %)

344

(((

345

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

346

)))

347

348

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

349

350

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

351

352

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

353

354

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

355

356

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

357

358

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

359

360

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

361

362

(% class="box warningmessage" %)

363

(((

364

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

365

)))

366

367

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

368

369

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

370

371

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

Ответ: Code 204

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

376

377

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

378

379

(% class="box successmessage" %)

380

(((

381

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

382

)))

383

384

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

385

386

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

387

388

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

389

390

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

391

392

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

393

394

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

395

{

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

"doubleAuth":

412

{

413

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

414

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

},

"groups":

[

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

],

"customGroups":

[

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

423

],

424

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

}

{

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

429

"lastName": "string",

430

"firstName": "string",

431

"position": "string",

432

"phone": "string",

433

"organization": "string",

434

"login": "string",

435

"password": "string",

436

"email": "string",

437

438

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

439

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

440

441

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

442

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

443

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

463

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

464

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

465

466

467

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

468

469

(% class="box infomessage" %)

470

(((

471

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

472

)))

473

474

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

475

476

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

477

478

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

479

480

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

481

482

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

483

484

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

485

486

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

487

488

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

489

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

490

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

491

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

492

493

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

494

495

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

496

497

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

498

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

513

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

514

515

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

516

517

(% class="box infomessage" %)

518

(((

519

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

520

)))

521

522

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

523

524

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

525

526

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

527

528

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

529

530

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

(((

(((

{

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

"doubleAuth":

550

{

551

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

552

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

553

},

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

}

)))

)))

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

568

569

(% class="box warningmessage" %)

570

(((

571

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

572

)))

573

574

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

575

576

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

577

578

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

579

580

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

581

582

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

583

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

584

585

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

586

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

587

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

"doubleAuth":

606

{

607

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

608

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

609

},

610

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

611

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

612

613

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

614

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

615

616

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

617

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

618

619

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

620

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

621

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

"doubleAuth":

637

{

638

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

639

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

640

},

641

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

642

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

643

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

644

645

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

646

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

647

648

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

649

650

(% class="box warningmessage" %)

651

(((

652

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

653

)))

654

655

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

656

657

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

658

659

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

660

661

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

662

663

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

664

665

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

666

667

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

668

669

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

670

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

671

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

672

673

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

674

675

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

676

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

677

678

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

679

680

(% class="box warningmessage" %)

681

(((

682

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

683

)))

684

685

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

686

687

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

688

689

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

690

691

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

692

693

[

694

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

695

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

696

]

697

698

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

699

700

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

701

702

(% class="box warningmessage" %)

703

(((

704

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

705

)))

706

707

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

708

709

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

710

711

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

712

713

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

714

715

[

716

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

717

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

718

]

719

720

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

721

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

(((

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

{

"errorMessages": [

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

728

],

729

"users": [

730

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

731

]

732

}

733

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

734

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

735

)))

736

737

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

738

739

(% class="box errormessage" %)

740

(((

741

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

742

)))

743

744

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

745

746

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

747

748

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

749

750

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

751

752

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

753

754

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

755

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

756

757

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

758

759

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

760

761

(% class="box infomessage" %)

762

(((

763

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

764

)))

765

766

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

767

768

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

769

770

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

771

772

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

773

774

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

775

776

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

777

778

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

779

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

786

"hoppercapacity": 0,

787

"hopperdischargespeed": 0,

788

"modelType": 0,

789

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

790

"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);" %)**Описание**

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

808

809

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

810

811

(% class="box successmessage" %)

812

(((

813

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

814

)))

815

816

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

817

818

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

819

820

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

821

822

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

823

824

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

825

826

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

827

}

828

829

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

830

831

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

832

{

833

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

834

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

835

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

842

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

843

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

844

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

845

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

846

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

847

848

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

849

850

(% class="box successmessage" %)

851

(((

852

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

853

)))

854

855

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

856

857

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

858

859

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

860

861

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

862

863

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

864

865

{

866

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

867

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

876

"fueloutlay": 0,

877

"hoppercapacity": 0,

878

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

886

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

895

"hoppercapacity": 0,

896

"hopperdischargespeed": 0,

"modelType": 0

}

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

914

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

915

916

(% class="box warningmessage" %)

917

(((

918

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

919

)))

920

921

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

922

923

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

924

925

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

926

927

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

928

929

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

930

931

{

932

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

933

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

942

"fueloutlay": 0,

943

"hoppercapacity": 0,

944

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

952

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

961

"fueloutlay": 0,

962

"hoppercapacity": 0,

963

"hopperdischargespeed": 0,

"modelType": 0

}

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

979

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

980

981

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

982

983

(% class="box errormessage" %)

984

(((

985

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

986

)))

987

988

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

989

990

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

991

992

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

993

994

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

995

996

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

997

998

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

999

1000

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

1001

1002

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

1003

1004

(% class="box infomessage" %)

1005

(((

1006

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

1007

)))

1008

1009

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

1010

1011

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

1012

1013

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

1014

1015

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

1016

1017

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

1018

1019

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

1020

1021

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

1022

1023

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

1024

1025

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

(((

{

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

1037

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

1038

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

1039

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

1040

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

1041

1042

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

1043

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

1044

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

1045

1046

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

1047

},

1048

1049

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

1050

{

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

}

1058

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

1072

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

},

1085

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

},

1093

1094

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

1095

{

1096

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

1097

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

1098

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

1099

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

}

],

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

1104

{

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

{

1118

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

1119

{

1120

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

1121

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

1122

}

1123

],

1124

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

1125

}

1126

],

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

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

1134

"string"

1135

],

1136

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

1137

"additionalProp1": "string",

1138

"additionalProp2": "string",

1139

"additionalProp3": "string"

1140

},

1141

1142

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

1143

1144

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

1145

1146

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

1147

1148

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

1149

1150

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

1151

1152

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

1153

1154

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

1155

1156

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

1157

1158

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

1159

1160

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

1161

1162

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

1163

1164

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

1165

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

1166

}

1167

1168

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

1169

{

1170

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

1171

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

1172

"description": "string",

1173

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

}

],

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

1178

{

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

}

],

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

1195

{

1196

"status": 0,

1197

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

1198

"description": "string",

1199

"additionalInfo": "string"

}

]

}

)))

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

1207

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

1208

1209

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

1210

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

1211

1212

1213

== **Получить ответ на отправленную на ТС команду** ==

1214

1215

(% class="box infomessage" %)

1216

(((

1217

(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**

1218

)))

1219

1220

Идентификатор команды: cmdid

1221

1222

Запрос от терминала на ответ команды

1223

1224

Пример ответ от терминала:

1225

1226

ID= "" ~/~/ идентификатор произвольного поля

1227

Soft="" ~/~/ версия софта

1228

GPS=4 ~/~/ тип трекера

1229

Time=11:05:43 28.06.24 ~/~/ время запроса

1230

Lat=45.056221 ~/~/ широта

1231

Lon=39.035938 ~/~/ долгота

1232

Speed=0.0 ~/~/ скорость

1233

Course=181.4 ~/~/направление

1234

1235

(((

1236

== **Список отправленных объекту команд с ответами** ==

1237

1238

(% class="box infomessage" %)

1239

(((

1240

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

1241

)))

1242

1243

Идентификатор ТС: vehicleId

1244

1245

В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.

1246

1247

Пример ответа терминала

[

{

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

1252

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

1253

"templateId": "", ~/~/Идентификатор шаблона

1254

"updated": "", ~/~/ Время отправки

1255

"tryCount": 0, ~/~/ Количество попыток отправки команды

1256

"answer": "", ~/~/ Ответ терминала.

1257

"status": "" ~/~/ Статус отправки

}

]

)))

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

1265

1266

(% class="box successmessage" %)

1267

(((

1268

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

1269

)))

1270

1271

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

1272

1273

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

1274

1275

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

1276

1277

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

1278

1279

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

1280

1281

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

1282

1283

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

1284

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

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

1291

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

1292

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

1293

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

1294

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

1295

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

1296

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

1297

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

1298

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

1299

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

1300

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

1301

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

1302

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

1303

1304

"mileageCalcMethod": 0,

1305

"mileageCoeff": 0,

1306

"locationByCellId": true,

1307

"dottedLineTrackWhenNoCoords": true,

1308

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

1309

{

1310

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

1311

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

1312

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

1313

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

1314

},

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

},

1322

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

1323

{

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

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

1331

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

1332

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

1333

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

1334

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

1335

}

1336

1337

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

1338

{

1339

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

"isDefault": true

}

],

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

1344

{

1345

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1353

{

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

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

1361

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

1362

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

1363

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

1364

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

1365

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

1366

{

1367

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

1368

{

1369

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

1370

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

1371

}

1372

],

1373

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

1374

}

1375

],

1376

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

1377

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

1378

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

1379

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

1380

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

1381

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

1382

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

1383

"string"

1384

],

1385

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

1386

"additionalProp1": "string",

1387

"additionalProp2": "string",

1388

"additionalProp3": "string"

1389

},

1390

1391

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

1392

1393

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

1394

1395

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

1396

1397

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

1398

1399

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

1400

1401

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

1402

1403

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

1404

1405

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

1406

1407

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

1408

1409

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

1410

1411

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

1412

1413

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

1414

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

1415

}

1416

],

1417

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

1418

{

1419

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1430

1431

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

1432

1433

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

1434

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

1435

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

1436

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

1437

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

1438

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

1439

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

1440

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

1441

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

1442

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

1443

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

1444

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

1445

"mileageEnabled": true,

1446

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1451

"id": null,

1452

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

1453

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

1454

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

1455

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

1456

},

1457

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

1458

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

1459

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

1460

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

1461

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

1462

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

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

1469

}

1470

1471

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

1472

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

1473

1474

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

1475

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

1476

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

1477

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

1478

1479

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

1480

1481

(% class="box infomessage" %)

1482

(((

1483

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

1484

)))

1485

1486

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

1487

1488

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

1489

1490

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

1491

1492

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

1493

1494

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

1495

1496

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

1497

1498

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

1499

1500

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

1501

1502

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

1503

1504

(% style="color:#000000" %)В заголовках запроса:

1505

1506

(% style="color:#000000" %)− Content-Type: __**application/json**__

1507

1508

(% style="color:#000000" %)− X-Auth: Токен авторизации

1509

1510

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

1511

1512

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

1513

1514

{

1515

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1516

"name": null, ~/~/ Имя ТС (string, опционально)

1517

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1518

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1519

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1520

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1521

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1522

"customFields": null ~/~/ значение любого из произвольных полей ТС

1523

}

1524

1525

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1526

1527

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

1528

1529

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

1530

1531

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1532

"name": "" ~/~/ наименование объекта

1533

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

1534

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1535

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

1536

"sim1": "" ~/~/ первый номер телефона

1537

"sim2": "" ~/~/ второй номер телефона

1538

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

1539

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

1540

"modelId": "" ~/~/ идентификатор модели объекта

1541

"modelName": "" ~/~/ наименование модели объекта

1542

"unitId": "" ~/~/ идентификатор подразделения

1543

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

1544

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1545

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1546

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1547

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1548

"customFields": [

1549

{

1550

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

1551

"name": "", ~/~/ имя произвольного поля

1552

"value": "", ~/~/ значение произвольного поля

1553

"forClient": true, ~/~/ право на отображение у клиента

1554

"forTooltip": false, ~/~/ право на отображение в подсказке

1555

"forReport": false ~/~/ право на отображение в отчетах

1556

}(%%)

1557

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

1558

1559

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1560

1561

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1562

1563

(% class="box successmessage" %)

1564

(((

1565

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

1566

)))

1567

1568

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

1569

1570

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

1571

1572

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

1573

1574

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1575

1576

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

1577

1578

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

1579

1580

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

1581

1582

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1583

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1584

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1585

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1586

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

1587

"data": "", ~/~/ Данные

1588

"overwrite": false, ~/~/ Флаг перезаписи

1589

"stage": "", ~/~/ Состояние, может быть null

1590

1591

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

1592

1593

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

1594

1595

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

1596

1597

"status": "", ~/~/ значение статуса

1598

"date": "", ~/~/ Дата смены статуса

1599

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

1600

"data": "", ~/~/ Данные

1601

"overwrite": false, ~/~/ Флаг перезаписи

1602

"stage": "", ~/~/ Состояние

1603

1604

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

1605

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

1606

1607

(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)

1608

**Отправить команду на терминал**

1609

1610

(% class="box successmessage" %)

1611

(((

1612

(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**

1613

)))

1614

1615

Команда для отправки на тс.

1616

1617

{

1618

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

1619

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

1620

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

1621

"idTemplate": "" ~/~/ ID шаблона команды

}

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1626

1627

(% class="box warningmessage" %)

1628

(((

1629

(% lang="en-US" %)**PUT /api/v3/vehicles**

1630

)))

1631

1632

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1633

1634

(% style="color:#000000" %)Метод запроса: **PUT**

1635

1636

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1637

1638

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1639

1640

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1641

1642

(% style="color:#000000" %){

1643

"vehicleId": , ~/~/ ID объекта

1644

"parentId": "" , ~/~/ ID клиента

1645

"name": "" , ~/~/ имя ТС

1646

"imei": "" , ~/~/ IMEI

1647

"deviceTypeId": "" , ~/~/ ID типа устройства

1648

"modelId": "" , ~/~/ ID модели

1649

"unitId": "" , ~/~/ ID подразделения

1650

"sim1": "" , ~/~/ Номер SIM 1

1651

"sim2": "" , ~/~/ Номер SIM2

1652

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1653

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1654

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1655

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1656

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1657

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1658

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1659

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1660

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1661

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1662

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1663

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1664

1665

"mileageCalcMethod": 0,

1666

"mileageCoeff": 0,

1667

"locationByCellId": true,

1668

"dottedLineTrackWhenNoCoords": true,

1669

"counters": ~/~/ счетчики

1670

{

1671

"mileage": "" , ~/~/ пробег

1672

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1673

"motohours": "" , ~/~/ моточасы

1674

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1675

},

1676

"cmsv6Parameters": { ~/~/ параметры CMSv6

1677

"enabled": true, ~/~/ флаг включения

1678

"id": "" , ~/~/ идентификатор

1679

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1680

"login": "" , ~/~/ имя учетной записи

1681

"password": "" ~/~/ пароль учетной записи

1682

},

1683

"inspectionTasks": ~/~/ задания на ТО

1684

{

1685

"enabled": "" , ~/~/ Признак включения

1686

"name": "" , ~/~/ Имя задания

1687

"description": "" , ~/~/ Описание задания

1688

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1689

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1690

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1691

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1692

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1693

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1694

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1695

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1696

}

1697

1698

"drivers": [ ~/~/ Водители

1699

{

1700

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1705

{

1706

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1714

{

1715

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1716

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1717

"type": 0, ~/~/ Тип датчика

1718

"name": "string", ~/~/ Имя датчика

1719

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1720

"inputNumber": 0, ~/~/ Номер входа

1721

"pseudonym": "string", ~/~/ Псевдоним

1722

"medianDegree": 0, ~/~/ Медианная фильтрация

1723

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1724

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1725

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1726

"gradesTables": [ ~/~/ Массив таблиц тарировки

1727

{

1728

"grades": [ ~/~/ Таблица тарировки 1

1729

{

1730

"input": 0, ~/~/ Входящее значение

1731

"output": 0 ~/~/ Выходящее значение

1732

}

1733

],

1734

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1735

}

1736

],

1737

"showInTooltip": true, ~/~/ Отображать в подсказке

1738

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1739

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1740

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1741

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1742

"expr": "string", ~/~/ Формула

1743

"children": [ ~/~/ массив дочерних датчиков

1744

"string"

1745

],

1746

"customParams": { ~/~/ прочие произвольные параметры

1747

"additionalProp1": "string",

1748

"additionalProp2": "string",

1749

"additionalProp3": "string"

1750

},

1751

1752

~/~/ Характерные для произвольного:

1753

1754

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1755

1756

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1757

1758

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1759

1760

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1761

1762

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1763

1764

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1765

1766

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1767

1768

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1769

1770

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1771

1772

~/~/ "ValueOn": "Вкл.",

1773

1774

~/~/ "ValueOff": "Выкл."

1775

"summaryMaxValue": 0 ~/~/ Макс. значение

1776

}

1777

],

1778

"customFields": [ ~/~/ Произвольные поля

1779

{

1780

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1791

1792

(% lang="en-US" style="text-align:left" %)

1793

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1794

1795

(% lang="en-US" style="text-align:left" %)

1796

"vehicleId": "", ~/~/ ID ТС

1797

"parentId": "", ~/~/ ID клиента

1798

"name": "", ~/~/ имя ТС

1799

"imei": "", ~/~/ IMEI

1800

"deviceTypeId": "", ~/~/ типа устройства

1801

"modelId": "", ~/~/ ID модели

1802

"unitId": "", ~/~/ ID подразделения

1803

"sim1": "", ~/~/ SIM 1

1804

"sim2": "", ~/~/ SIM2

1805

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1806

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1807

"counters":

1808

{

1809

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1810

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1811

"mileage": "", ~/~/ пробег

1812

"motohours": "", ~/~/ моточасы

1813

}

1814

"cmsv6Parameters": ~/~/ параметры CMSv6

1815

{

1816

"id": ~/~/ идентификатор

1817

"enabled": true, ~/~/ флаг включения

1818

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1819

"login": "", ~/~/ имя учетной записи

1820

"password": "", ~/~/ пароль учетной записи

1821

}

1822

"inspectionTasks": ~/~/ задания на ТО

1823

{

1824

"id": "", ~/~/ ID задания

1825

"enabled": false, ~/~/ Признак включения

1826

"name": "", ~/~/ Имя задания

1827

"description": "", ~/~/ Описание задания

1828

"mileageCondition": "", ~/~/ Условие по пробегу

1829

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1830

"motohoursCondition": "", ~/~/ Условие по моточасам

1831

"lastMotohours": "", ~/~/ Моточасы

1832

"periodicCondition": "", ~/~/ Условие периодичности по времени

1833

"kind": "", ~/~/ Вид периодичности по времени

1834

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1835

}

1836

1837

(% lang="en-US" style="text-align:left" %)

1838

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1839

1840

**Валидация:**

1841

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1842

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1843

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1844

1845

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1846

1847

(% class="box errormessage" %)

1848

(((

1849

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1850

)))

1851

1852

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1853

1854

(% style="color:#000000" %)Метод запроса: **DELETE**

1855

1856

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1857

1858

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1859

1860

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1861

1862

(% style="text-align:left" %)

1863

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1864

1865

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1866

1867

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1868

1869

(% class="box infomessage" %)

1870

(((

1871

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1872

)))

1873

1874

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1875

1876

(% style="color:#000000" %)Метод запроса: **GET**

1877

1878

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

1879

1880

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1881

1882

(% style="color:#000000" %)Ответ:

1883

1884

(% style="color:#000000" %){

1885

1886

"deviceTypeId" : "", ~/~/ ID типа устройства

1887

"deviceTypeName" : "" ~/~/ Название типа устройства

1888

1889

(% style="text-align:left" %)

1890

(% style="color:#000000" %)}

1891

1892

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1893

1894

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1895

1896

(% class="box infomessage" %)

1897

(((

1898

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1899

)))

1900

1901

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1902

1903

(% style="color:#000000" %)Метод запроса: **GET**

1904

1905

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1906

1907

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1908

1909

(% style="color:#000000" %)Ответ:

1910

1911

(% style="color:#000000" %){

1912

1913

"id": "", ~/~/ ID типа датчика

1914

"name": "", ~/~/ Название

1915

"description": "", ~/~/ Описание

1916

1917

(% style="text-align:left" %)

1918

(% style="color:#000000" %)}

1919

1920

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1921

1922

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1923

1924

(% class="box infomessage" style="text-align: left;" %)

1925

(((

1926

**POST /api/v3/terminalMessages/count**

1927

)))

1928

1929

(% style="text-align: left;" %)

1930

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1931

1932

(% style="text-align: left;" %)

1933

Метод запроса **POST**

1934

1935

(% style="text-align: left;" %)

1936

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1937

1938

(% style="text-align: left;" %)

1939

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1940

1941

(% style="text-align: left;" %)

1942

{

1943

"vehicleIds": [

1944

id ~/~/ здесь передается список идентификаторов объектов

1945

],

1946

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1947

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1948

}

1949

1950

(% style="text-align: left;" %)

1951

Ответ:

1952

1953

(% style="text-align: left;" %)

1954

[

1955

{

1956

"vehicleId": 0, ~/~/ идентификатор объекта

1957

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1962

1963

(% class="box infomessage" style="text-align: left;" %)

1964

(((

1965

**POST /api/v3/terminalMessages/mapping**

1966

)))

1967

1968

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

1969

1970

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

1971

1972

(% 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);" %)**Описание**

1980

|protocolType|ID типа протокола

1981

|params|(((

1982

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

2002

|protocolType|Тип протокола

2003

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2009

Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]

2010

2011

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2012

2013

(% class="box infomessage" %)

2014

(((

2015

**POST /api/v3/terminalMessages**

2016

)))

2017

2018

Метод возвращает список сообщений терминала объекта за выбранный период.

2019

2020

(% style="text-align: left;" %)

2021

Метод запроса **POST**

2022

2023

(% style="text-align: left;" %)

2024

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

2025

2026

(% style="text-align: left;" %)

2027

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2028

2029

{

2030

"vehicleId": 0, ~/~/ id объекта

2031

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2032

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2033

}

2034

2035

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2036

|vehicleId|ID объекта

2037

|from|Дата и время начала периода запроса

2038

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2047

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2057

"additionalProp2": "string",

2058

"additionalProp3": "string"

2059

},

2060

"photoCount": 0,

2061

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2069

|deviceTime|Время сообщения терминала

2070

|serverTime|Время когда сообщение поступило на сервер

2071

|speed|Скорость

2072

|altitude|Высота над уровнем моря

2073

|latitude|Широта

2074

|longitude|Долгота

2075

|satellites|Кол-во спутников

2076

|course|Курс

2077

|voltage|Бортовое напряжение

2078

|parameters|Список параметров и их значений

2079

|photoCount|Количество фото

2080

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2081

|protocolType|ID типа протокола

2082

2083

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2084

2085

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2086

2087

(% class="box infomessage" %)

2088

(((

2089

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2090

)))

2091

2092

(% style="color:#000000" %)Метод запроса: **POST**

2093

2094

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2095

2096

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2097

2098

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2103

"vehicleIds": [0], ~/~/ Список ID объектов

2104

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2105

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2106

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2114

"name": "string", ~/~/ Имя ТС

2115

"periods": [ ~/~/ Периоды

2116

{

2117

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2118

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2119

"mileageBegin": 0, ~/~/ Пробег на начало периода

2120

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2121

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2122

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2129

2130

(% class="box infomessage" %)

2131

(((

2132

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2133

)))

2134

2135

(% style="color:#000000" %)Метод запроса: **POST**

2136

2137

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2138

2139

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2140

2141

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2146

"vehicleIds": [0], ~/~/ Список ID объектов

2147

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2148

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2149

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2157

"name": "string", ~/~/ Имя ТС

2158

"periods": [ ~/~/ Периоды

2159

{

2160

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2161

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2162

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2163

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2164

"fuelConsumption": 0, ~/~/ Расход топлива

2165

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2172

2173

(% class="box infomessage" %)

2174

(((

2175

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2176

)))

2177

2178

(% style="color:#000000" %)Метод запроса: **POST**

2179

2180

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2181

2182

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2183

2184

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2189

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2190

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2191

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2199

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2200

"vehicleId": 0, ~/~/ ID объекта

2201

"name": "string", ~/~/ Имя объекта

2202

"model": "string", ~/~/ Модель объекта

2203

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2204

{

2205

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2206

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2207

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2208

"valueFuel": 0, ~/~/ Количество

2209

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2210

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2218

2219

(% class="box infomessage" %)

2220

(((

2221

**POST /api/v3/vehicles/moveStop**

2222

)))

2223

2224

Метод запроса: **POST**

2225

2226

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2227

2228

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2235

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2236

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2237

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2245

"vehicleName": "string", ~/~/ Имя объекта

2246

"moves": [ ~/~/ Событие движения

2247

{

2248

"mileage": 0, ~/~/ Пробег, км

2249

"eventId": 0, ~/~/ Идентификатор события

2250

"eventName": "string", ~/~/ Название события

2251

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2252

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2253

"duration": 0 ~/~/ Продолжительность события, секунд

2254

}

2255

],

2256

"stops": [ ~/~/ События стоянок

2257

{

2258

"address": "string", ~/~/ Адрес события

2259

"eventId": 0, ~/~/ Идентификатор события

2260

"eventName": "string", ~/~/ Название события

2261

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2262

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2263

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2271

2272

(% class="box infomessage" %)

2273

(((

2274

**POST /api/v3/vehicles/getlastdata**

2275

)))

2276

2277

Метод запроса: **POST**

2278

2279

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2280

2281

В заголовках запроса: X-Auth: Токен авторизации

2282

2283

2284

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2289

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2290

"vehicleNumber": "string",~/~/Номер объекта.

2291

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2292

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2293

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2294

"speed": 0,~/~/Скорость объекта.

2295

"course": 0,~/~/Курс движения [0;360]

2296

"latitude": 0,~/~/Широта [-90°;90°].

2297

"longitude": 0,~/~/Долгота [-180°;180°].

2298

"address": "string",~/~/Адрес.

2299

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2308

2309

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2310

2311

(% class="box infomessage" %)

2312

(((

2313

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2314

)))

2315

2316

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2317

2318

(% style="color:#000000" %)Метод запроса: **POST**

2319

2320

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2321

2322

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2323

2324

(% style="text-align:left" %)

2325

Тело запроса:

2326

2327

(% style="text-align:left" %)

2328

{

2329

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2330

}

2331

2332

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2338

"name": "string", ~/~/ Название объекта геозоны

2339

"type": 0, ~/~/ Тип объекта геозоны

2340

"fname": "string", ~/~/ Имя файла

2341

"parentId": "string", ~/~/ Идентификатор клиента

2342

"radius": 0, ~/~/ Радиус геообъекта

2343

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2344

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2345

"description": "string", ~/~/ Описание

2346

"area": 0, ~/~/ Площадь, м^^2^^

2347

"perimetr": 0, ~/~/ Периметр, м

2348

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2353

2354

(% class="box infomessage" %)

2355

(((

2356

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2357

)))

2358

2359

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2360

2361

(% style="color:#000000" %)Метод запроса: **POST**

2362

2363

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2364

2365

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2366

2367

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2372

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2373

"ids": [ ], ~/~/ Массив id объектов

2374

"byTime": 0, ~/~/ Объединение событий по времени

2375

"byDist": 0, ~/~/ Объединение событий по расстоянию

2376

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2377

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2384

"geozoneName": "string", ~/~/ Название геообъекта

2385

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2386

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2387

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2388

"vehicleId": 0, ~/~/ ID объекта

2389

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2394

2395

(% class="box infomessage" %)

2396

(((

2397

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2398

)))

2399

2400

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2401

2402

(% style="color:#000000" %)Метод запроса: **POST**

2403

2404

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2405

2406

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2407

2408

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2413

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2414

"ids": [ ], ~/~/ Массив id геообъектов

2415

"byTime": 0, ~/~/ Объединение событий по времени

2416

"byDist": 0, ~/~/ Объединение событий по расстоянию

2417

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2418

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2426

"geozoneName": "string", ~/~/ Название геообъекта

2427

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2428

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2429

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2430

"vehicleId": 0, ~/~/ ID объекта

2431

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2436

2437

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2438

2439

(% class="box infomessage" %)

2440

(((

2441

**POST /api/v3/notifications/find**

2442

)))

2443

2444

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2445

2446

(% style="text-align: left;" %)

2447

Метод запроса **POST**

2448

2449

(% style="text-align: left;" %)

2450

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2451

2452

(% style="text-align: left;" %)

2453

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2454

2455

{

2456

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2464

"name": "string", ~/~/ Название уведомления

2465

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2466

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2467

"userId": "", ~/~/ Пользователь, создавший уведомление

2468

"parentId": "", ~/~/ Идентификатор клиента

2469

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2474

2475

(% class="box infomessage" %)

2476

(((

2477

**GET /api/v3/notifications/{id}**

2478

)))

2479

2480

Метод возвращает данные правил формирования выбранного уведомления.

2481

2482

(% style="text-align: left;" %)

2483

Метод запроса **GET**

2484

2485

(% style="text-align: left;" %)

2486

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2487

2488

(% style="text-align: left;" %)

2489

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2490

2491

(% style="text-align: left;" %)

2492

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2493

2494

(% style="text-align: left;" %)

2495

(% style="color:#000000" %)Ответ:

2496

2497

(% style="text-align: left;" %)

2498

(% style="color:#000000" %){

2499

"id": 0, ~/~/ (%%)id уведомления

2500

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2501

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2502

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2503

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2504

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2505

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2506

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2507

(% style="color:#000000" %) 0

2508

],

2509

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2510

(% style="color:#000000" %) 0

2511

],

2512

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2513

(% style="color:#000000" %) 0

2514

],

2515

"settings": { ~/~/ Список параметров уведомления

2516

"additionalProp1": "string",

2517

"additionalProp2": "string",

2518

"additionalProp3": "string"

2519

},

2520

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2521

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2522

(% style="color:#000000" %) ""

2523

],

2524

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2525

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2526

(% style="color:#000000" %) "string"

2527

],

2528

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2529

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2530

(% style="color:#000000" %) {

2531

"id": 0, ~/~/ (%%)Идентификатор участника чата

2532

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2533

(% style="color:#000000" %) }

2534

],

2535

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2536

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2537

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2538

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2539

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2540

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2541

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2542

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2543

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2544

(% style="color:#000000" %)}

2545

2546

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2547

2548

(% class="box warningmessage" %)

2549

(((

2550

**PUT /api/v3/notifications/**

2551

)))

2552

2553

Метод позволяет отредактировать уведомление.

2554

2555

Метод запроса **PUT**

2556

2557

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2558

2559

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2564

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2565

"userId": "", ~/~/ Пользователь, создавший уведомление

2566

"parentId": "", ~/~/ Идентификатор клиента

2567

"parentName": "string", ~/~/ Имя клиента

2568

"name": "string", ~/~/ Название уведомления

2569

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2570

"vehicleIds": [ ~/~/ Список id объектов для анализа

2571

0

2572

],

2573

"geoids": [ ~/~/ Список id геообъектов для анализа

2574

0

2575

],

2576

"fieldids": [ ~/~/ Список id полей для анализа

2577

0

2578

],

2579

"settings": { ~/~/ Список параметров уведомления

2580

"additionalProp1": "string",

2581

"additionalProp2": "string",

2582

"additionalProp3": "string"

2583

},

2584

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2585

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2586

""

2587

],

2588

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2589

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2590

"string"

2591

],

2592

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2593

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2594

{

2595

"id": 0, ~/~/ Идентификатор участника чата

2596

"info": "string" ~/~/ Дополнительные сведения

2597

}

2598

],

2599

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2600

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2601

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2602

"kind": 0, ~/~/ Определяет вид уведомления

2603

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2604

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2605

"timezone": 0, ~/~/ Сдвиг часового пояса

2606

"validity": 0, ~/~/ Срок действия в днях (1-90)

2607

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2615

2616

(% class="box errormessage" %)

2617

(((

2618

**DELETE /api/v3/notifications/{id}**

2619

)))

2620

2621

Метод позволяет удалить выбранное уведомление.

2622

2623

Метод запроса **DELETE**

2624

2625

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2626

2627

Передаваемый параметр: {id} - id уведомления

2628

2629

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2637

2638

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2639

2640

(% class="box infomessage" %)

2641

(((

2642

**POST /api/v3/Drivers/find**

2643

)))

2644

2645

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2652

"description": "string", ~/~/ Определяет описание

2653

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2654

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2655

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2656

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2657

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2658

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2663

2664

(% class="box infomessage" %)

2665

(((

2666

**GET /api/v3/Drivers/{driverGuid}**

2667

)))

2668

2669

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2675

"description": "string", ~/~/ Определяет описание

2676

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2677

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2678

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2679

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2680

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2681

"deleted": true ~/~/ Признак удаления

2682

}

2683

2684

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2685

2686

(% class="box successmessage" %)

2687

(((

2688

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2696

"hiredate": "2023-06-30T12:50:54.020Z",

2697

"chopdate": "2023-06-30T12:50:54.020Z",

2698

"exclusive": true,

2699

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2700

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2709

"hiredate": "2023-06-30T12:50:54.051Z",

2710

"chopdate": "2023-06-30T12:50:54.051Z",

2711

"exclusive": true,

2712

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2713

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2719

2720

(% class="box warningmessage" %)

2721

(((

2722

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2730

"hiredate": "2023-06-30T12:50:27.910Z",

2731

"chopdate": "2023-06-30T12:50:27.910Z",

2732

"exclusive": true,

2733

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2734

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2743

"hiredate": "2023-06-30T12:50:27.929Z",

2744

"chopdate": "2023-06-30T12:50:27.929Z",

2745

"exclusive": true,

2746

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2747

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2753

2754

(% class="box errormessage" %)

2755

(((

2756

**DELETE /api/v3/Drivers/{driverGuid}**

2757

)))

2758

2759

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2767

2768

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2769

2770

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2771

2772

(% class="box infomessage" %)

2773

(((

2774

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2782

],

2783

"BeginTime": "2023-06-30T12:49:04.365Z",

2784

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2793

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2794

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2795

"BeginTime": "2023-06-30T09:52:31.240Z",

2796

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2802

2803

(% class="box infomessage" %)

2804

(((

2805

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2815

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2824

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2825

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2826

"BeginTime": "2023-06-30T09:54:01.631Z",

2827

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2833

2834

(% class="box successmessage" %)

2835

(((

2836

**POST /api/v3/DriversVehiclesAssignments**

2837

)))

2838

2839

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2846

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2847

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2848

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2849

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2859

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2860

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2861

"BeginTime": "2023-06-30T11:04:46.903Z",

2862

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2868

2869

(% class="box warningmessage" %)

2870

(((

2871

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2880

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2881

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2882

"BeginTime": "2023-06-30T11:14:08.117Z",

2883

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2893

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2894

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2895

"BeginTime": "2023-06-30T11:14:53.349Z",

2896

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2902

2903

(% class="box errormessage" %)

2904

(((

2905

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2920

2921

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2922

2923

(% class="box infomessage" %)

2924

(((

2925

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2933

],

2934

"BeginTime": "2023-06-30T12:47:12.162Z",

2935

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2943

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2944

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2945

"BeginTime": "2023-06-30T11:19:40.703Z",

2946

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2952

2953

(% class="box infomessage" %)

2954

(((

2955

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2963

],

2964

"BeginTime": "2023-06-30T12:47:12.162Z",

2965

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2973

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2974

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2975

"BeginTime": "2023-06-30T11:19:40.703Z",

2976

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2982

2983

(% class="box successmessage" %)

2984

(((

2985

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2993

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2994

"BeginTime": "2023-06-30T11:27:08.635Z",

2995

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3004

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3005

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3006

"BeginTime": "2023-06-30T11:27:08.677Z",

3007

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3013

3014

(% class="box warningmessage" %)

3015

(((

3016

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3024

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3025

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3026

"BeginTime": "2023-06-30T11:28:43.330Z",

3027

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3036

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3037

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3038

"BeginTime": "2023-06-30T11:28:43.331Z",

3039

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3045

3046

(% class="box errormessage" %)

3047

(((

3048

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3063

3064

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3065

3066

(% class="box infomessage" %)

3067

(((

3068

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3076

],

3077

"BeginTime": "2023-06-30T12:45:10.852Z",

3078

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3086

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3087

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3088

"BeginTime": "2023-06-30T11:58:04.695Z",

3089

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3095

3096

(% class="box infomessage" %)

3097

(((

3098

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3106

],

3107

"BeginTime": "2023-06-30T12:45:10.852Z",

3108

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3116

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3117

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3118

"BeginTime": "2023-06-30T11:58:04.695Z",

3119

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3125

3126

(% class="box successmessage" %)

3127

(((

3128

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3136

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3137

"BeginTime": "2023-06-30T12:09:53.175Z",

3138

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3147

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3148

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3149

"BeginTime": "2023-06-30T12:09:53.201Z",

3150

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3156

3157

(% class="box warningmessage" %)

3158

(((

3159

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3167

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3168

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3169

"BeginTime": "2023-06-30T12:09:53.201Z",

3170

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3179

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3180

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3181

"BeginTime": "2023-06-30T12:09:53.201Z",

3182

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3188

3189

(% class="box errormessage" %)

3190

(((

3191

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3206

3207

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3208

3209

(% class="box infomessage" %)

3210

(((

3211

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3218

"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);" %)**Описание**

3224

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3225

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3226

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3227

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3234

"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",

3244

"name": "string",

3245

"rid": "string",

3246

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3247

"trailer": {

3248

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3249

"Number": "string",

3250

"Description": "string",

3251

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3252

"ExternalID": "string",

3253

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3254

"CreateTime": "2023-11-14T10:48:03.717Z",

3255

"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);" %)**Описание**

3263

|SD|Дата и время начала события

3264

|ED|Дата и время окончания события

3265

|id|ID объекта

3266

|SLat|Широта начальной координаты

3267

|SLon|Долгота начальной координаты

3268

|ELat|Широта конечной координаты

3269

|ELon|Долгота конечной координаты

3270

|mileage|Пробег

3271

|Duration|Продолжительность

3272

|Address|Адрес начального местоположения

3273

|Address2|Адрес конечного местоположения

3274

|name|Имя радиометки

3275

|rid|Номер радиометки

3276

|rguid|ID радиометки

3277

|trailer|Информация об агрегате

3278

|ModelGuid|ID агрегата

3279

|Number|Название/номер агрегата

3280

|Description|Текст примечания агрегата

3281

3282

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3283

3284

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3285

3286

(% class="box infomessage" %)

3287

(((

3288

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3305

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3310

|parentId|ID клиента

3311

|name|Название карты-метки

3312

|number|Номер

3313

|period|Период запросов в секундах (работает только для агрегатов)

3314

|id|ID карты-метки

3315

3316

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3317

3318

(% class="box infomessage" %)

3319

(((

3320

**GET /api/v3/Rfids/{rfidGuid}**

3321

)))

3322

3323

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3333

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3338

|name|Название карты-метки

3339

|number|Номер

3340

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3345

3346

(% class="box successmessage" %)

3347

(((

3348

**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",

3367

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3368

}

3369

3370

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3371

|name|Название карты-метки

3372

|number|Номер

3373

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3378

3379

(% class="box warningmessage" %)

3380

(((

3381

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3391

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3401

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3402

}

3403

3404

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3405

|name|Название карты-метки

3406

|number|Номер

3407

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3412

3413

(% class="box errormessage" %)

3414

(((

3415

**DELETE /api/v3/Rfids/{rfidGuid}**

3416

)))

3417

3418

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3426

3427

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3428

3429

(% class="box infomessage" %)

3430

(((

3431

**GET /api/v3/Billing/client/balance/{clientId}**

3432

)))

3433

3434

Параметр запроса: **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);" %)**Описание**

3444

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3445

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3446

3447

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3448

3449

(% class="box infomessage" %)

3450

(((

3451

**GET /api/v3/Billing/client/constraint/{clientId}**

3452

)))

3453

3454

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3460

"CalculationType": 0,

3461

"PermissibleBalance": 0,

3462

"DefermentDays": 0,

3463

"SendUiNotifications": true,

3464

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3469

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3470

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3471

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3472

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3473

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3474

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3475

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3476

3477

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3478

3479

(% class="box infomessage" %)

3480

(((

3481

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3487

3488

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3494

"Plan": { **~/~/ Описание тарифного плана**

3495

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3496

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3501

"PermissibleBalance": 0,

3502

"DefermentDays": 0

3503

},

3504

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3516

"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);" %)**Описание**

3532

|ClientId|Идентификатор клиента

3533

|Id|Идентификатор тарифного плана

3534

|OwnerId|Идентификатор клиента-владельца

3535

|Name|Наименование тарифного плана

3536

|IsArchived|Признак, определяющий архивный тарифный план

3537

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3538

|PermissibleBalance|Допустимый баланс

3539

|DefermentDays|Отсрочка, количество дней

3540

|Feature|Код услуги

3541

|IsEnabled|Признак, определяющий активирована ли услуга

3542

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3543

|IsFactual|Признак, определяющий расчёт по факту

3544

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3545

|Price|Цена за единицу.

3546

|DebitDate|Следующий момент времени списания с баланса за услугу.

3547

|PeriodValue|Значение периода.

3548

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3549

3550

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3551

3552

(% class="box infomessage" %)

3553

(((

3554

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3555

)))

3556

3557

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3564

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3569

"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);" %)**Описание**

3586

|ClientId|Идентификатор клиента

3587

|Id|Идентификатор тарифного плана

3588

|OwnerId|Идентификатор клиента-владельца

3589

|Name|Наименование тарифного плана

3590

|IsArchived|Признак, определяющий архивный тарифный план

3591

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3592

|PermissibleBalance|Допустимый баланс

3593

|DefermentDays|Отсрочка, количество дней

3594

|Feature|Код услуги

3595

|IsFactual|Признак, определяющий расчёт по факту

3596

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3597

|Price|Цена за единицу.

3598

|PeriodValue|Значение периода.

3599

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3600

3601

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3602

3603

(% class="box infomessage" %)

3604

(((

3605

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3606

)))

3607

3608

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3615

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3620

"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);" %)**Описание**

3637

|ClientId|Идентификатор клиента

3638

|Id|Идентификатор тарифного плана

3639

|OwnerId|Идентификатор клиента-владельца

3640

|Name|Наименование тарифного плана

3641

|IsArchived|Признак, определяющий архивный тарифный план

3642

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3643

|PermissibleBalance|Допустимый баланс

3644

|DefermentDays|Отсрочка, количество дней

3645

|Feature|Код услуги

3646

|IsFactual|Признак, определяющий расчёт по факту

3647

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3648

|Price|Цена за единицу.

3649

|PeriodValue|Значение периода.

3650

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3651

3652

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3653

3654

(% class="box warningmessage" %)

3655

(((

3656

**PUT /api/v3/Billing/client/balance**

3657

)))

3658

3659

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3671

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3672

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3673

3674

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3675

3676

(% class="box warningmessage" %)

3677

(((

3678

**PUT /api/v3/billing/client/balance/deposit**

3679

)))

3680

3681

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3693

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3694

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3695

3696

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3697

3698

Создает операцию **Списание **с указанной суммой

3699

3700

(% class="box warningmessage" %)

3701

(((

3702

**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);" %)**Описание**

3715

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3716

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3717

3718

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3719

3720

(% class="box warningmessage" %)

3721

(((

3722

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3729

"CalculationType": 0,

3730

"PermissibleBalance": 0,

3731

"DefermentDays": 0,

3732

"SendUiNotifications": true,

3733

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3740

|ClientId|Идентификатор клиента

3741

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3742

|PermissibleBalance|Допустимый баланс

3743

|DefermentDays|(((

3744

Отсрочка, количество дней

3745

)))

3746

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3747

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3748

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3749

3750

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3751

3752

(% class="box warningmessage" %)

3753

(((

3754

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3761

"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);" %)**Описание**

3779

|ClientId|Идентификатор клиента

3780

|PlanId|Идентификатор тарифного плана

3781

|Feature|Код услуги

3782

|IsEnabled|Признак, определяющий активирована ли услуга

3783

|IsFactual|Признак, определяющий расчёт по факту

3784

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3785

|Price|Цена за единицу.

3786

|DebitDate|Следующий момент времени списания с баланса за услугу.

3787

|PeriodValue|Значение периода.

3788

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3789

3790

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3791

3792

(% class="box warningmessage" %)

3793

(((

3794

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3795

)))

3796

3797

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3798

3799

(% class="box infomessage" %)

3800

(((

3801

**POST /api/v3/vehicles/import/{agentId}**

3802

)))

3803

3804

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3805

3806

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3815

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3816

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3817

3818

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3823

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3824

|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);" %)**Описание**

3835

|vehicleId|ID созданного объекта

3836

|name|Имя созданного объекта

3837

|errors|Ошибки и их описание

3838

3839

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3840

3841

(% class="box infomessage" %)

3842

(((

3843

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3844

)))

3845

3846

(% class="wikigeneratedid" %)

3847

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3848

3849

(% class="wikigeneratedid" %)

3850

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3855

3856

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3861

|**history**|В значении передавать файл с историей

3862

3863

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3876

"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);" %)**Описание**

3884

|results|Результаты импорта в разрезе ТС

3885

|vehicleGuid|Guid ТС

3886

|vehicleId|ID ТС

3887

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3888

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3889

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3890

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3891

|msgCount|Кол-во обработанных сообщений всего

3892

3893

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3894

3895

(% class="box infomessage" %)

3896

(((

3897

**GET /api/v3/vehicles/import/history/status**

3898

)))

3899

3900

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3911

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3912

|progress|Guid ТС

3913

3914

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3915

3916

(% class="box infomessage" %)

3917

(((

3918

**POST /api/v3/vehicles/export**

3919

)))

3920

3921

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3930

3931

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3932

3933

(% class="box infomessage" %)

3934

(((

3935

**POST /api/v3/vehicles/export/history**

3936

)))

3937

3938

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3946

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3952

3953

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3954

|vehicleId|ID объекта

3955

|asArchive|true - Архивировать файл, False - не архивировать

3956

|from|Дата и время начала запроса

3957

|to|Дата и время окончания запроса

3958

3959

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3960

3961

(% class="box infomessage" %)

3962

(((

3963

**GET /api/v3/vehicles/export/history/status**

3964

)))

3965

3966

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3977

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3978

|progress|Прогресс экспорта, от 0 до 100%

3979

|message|Текст описывающий статус

3980

3981

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3982

3983

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

3984

3985

(% class="box infomessage" %)

3986

(((

3987

**POST /api/v3/EcoDriving/rating**

3988

)))

3989

3990

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3996

"from": "2023-11-22T09:29:48.051Z",

3997

"to": "2023-11-22T09:29:48.051Z"

3998

}

3999

4000

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4001

|vehicleIds|Массив ID объектов

4002

|from|Дата начала запроса

4003

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

4011

"to": "2023-11-22T09:29:48.052Z",

4012

"vehicleId": 0,

4013

"vehicleName": "string",

4014

"vehicleModel": "string",

4015

"penalty": 0,

4016

"score": 0,

4017

"totalViolations": 0,

4018

"violationsByType": {

4019

"overspeedingViolations": 0,

4020

"accelerationViolations": 0,

4021

"brakingViolations": 0,

4022

"turningViolations": 0,

4023

"dangerousDrivingViolations": 0,

4024

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

4034

"violationsByType": {

4035

"overspeedingViolations": 0,

4036

"accelerationViolations": 0,

4037

"brakingViolations": 0,

4038

"turningViolations": 0,

4039

"dangerousDrivingViolations": 0,

4040

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4047

"endAddress": "string",

4048

"drivers": [

4049

{

4050

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4051

"driverName": "string",

4052

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4062

|from|Дата начала запроса

4063

|to|Дата окончания

4064

|vehicleId|ID объекта

4065

|vehicleName|Имя объекта

4066

|vehicleModel|Модель объекта

4067

|penalty|Сумма штрафных баллов

4068

|score|Оценка

4069

|totalViolations|Суммарное количество нарушений

4070

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4071

|overspeedingViolations|Превышение скорости

4072

|accelerationViolations|Ускорение

4073

|brakingViolations|Торможение

4074

|turningViolations|Резкий поворот

4075

|dangerousDrivingViolations|Резкое вождение

4076

|sensorViolations|Нарушение по датчику

4077

|moveTime|Время в движении

4078

|mileage|Пробег

4079

|tripsCount|Количество рейсов

4080

|motohours|Моточасы

4081

|maxSpeed|Максимальная скорость

4082

|startAddress|Адрес начала рейса

4083

|endAddress|Адрес окончания рейса

4084

|drivers|Список водителей, которые были на объекте в течениии рейса

4085

|driverGuid|Guid водителя

4086

|driverName|Имя водителя

4087

|driverRfid|Номер Карты-метки

4088

4089

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4090

4091

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4092

4093

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4094

4095

(% class="box infomessage" %)

4096

(((

4097

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4103

\\В заголовках запроса: X-Auth: Токен авторизации

4104

4105

Параметры в теле запроса (JSON):

4106

4107

{

4108

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4109

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4110

"ids": [

4111

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4112

],

4113

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4120

"driver": "string", ~/~/Водители, привязанные к ТК

4121

"object": "string", ~/~/Наименование ТС

4122

"amount": 0, ~/~/Количество топлива

4123

"amountDut": 0, ~/~/Количество по ДУТ

4124

"amountDiff": 0, ~/~/Разница, л

4125

"amountDiffPerc": 0, ~/~/Разница, %

4126

"summa": 0, ~/~/Стоимость, руб

4127

"serviceName": "string", ~/~/Тип топлива

4128

"price": 0, ~/~/Цена за литр, руб

4129

"cardName": "string", ~/~/Наименование ТК

4130

"cardNum": "string", ~/~/Номер ТК

4131

"operator": "string", ~/~/Оператор ТК

4132

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4137

4138

4139

== **Получение полных данных о ретрансляторе** ==

4140

4141

(% class="box infomessage" %)

4142

(((

4143

**GET ** **/api/v3/retranslations/{id}**

4144

)))

4145

4146

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4153

"subscriberId": "", ~/~/ Подписчик

4154

"protocolType": 0, ~/~/ Тип протокола

4155

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4156

"address": "string", ~/~/ Адрес события

4157

"objects": [ ~/~/Объекты для ретрансляции

4158

{

4159

"id": "", ~/~/ Идентификатор объекта ретрансляции

4160

"name": "", ~/~/ Наименование объекта ретрансляции

4161

"imei": "", ~/~/ IMEI объекта

4162

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4163

}

4164

],

4165

"id": "", ~/~/ идентификатор пользователя

4166

"parentId": "", ~/~/Guid родителя

4167

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4172

4173

(% class="box infomessage" %)

4174

(((

4175

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4182

4183

(% class="box infomessage" %)

4184

(((

4185

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4192

"subscriberId": "", ~/~/ Подписчик

4193

"protocolType": 0, ~/~/ Тип протокола

4194

"address": "", ~/~/ Адрес ретрансляции

4195

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4196

"objects": [ ~/~/Объекты для ретрансляции

4197

{

4198

"id": "", ~/~/ идентификатор пользователя

4199

"imei": "", ~/~/IMEI объекта

4200

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4210

"subscriberId": "", ~/~/ идентификатор запроса

4211

"protocolType": 0, ~/~/ Тип протокола

4212

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4213

"address": "", ~/~/ Адрес события

4214

"objects": [ ~/~/Объекты для ретрансляции

4215

{

4216

"id": "", ~/~/ идентификатор пользователя

4217

"name": "string", ~/~/ Название уведомления

4218

"imei": "string", ~/~/IMEI объекта

4219

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4220

}

4221

],

4222

"id": "", ~/~/ идентификатор пользователя

4223

"parentId": "", ~/~/ Guid идентификатор родителя

4224

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4229

4230

(% class="box infomessage" %)

4231

(((

4232

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4239

"description": "string", ~/~/ Определяет описание

4240

"subscriberId": "", ~/~/ идентификатор запроса

4241

"protocolType": 0, ~/~/ Тип протокола

4242

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4243

"address": "string", ~/~/ Адрес события

4244

"objects": ~/~/Объекты для ретрансляции

4245

[

4246

{

4247

"id": "", ~/~/ идентификатор пользователя

4248

"imei": "", ~/~/IMEI объекта

4249

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4259

"subscriberId": "", ~/~/ идентификатор запроса

4260

"protocolType": 0, ~/~/ Тип протокола

4261

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4262

"address": "string", ~/~/ Адрес события

4263

"objects": [ ~/~/Объекты для ретрансляции

4264

{

4265

"id": "", ~/~/ идентификатор пользователя

4266

"name": "string", ~/~/ Название уведомления

4267

"imei": "", ~/~/IMEI объекта

4268

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4269

}

4270

],

4271

"id": "", ~/~/ идентификатор пользователя

4272

"parentId": "", ~/~/ Guid идентификатор родителя

4273

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4278

4279

(% class="box infomessage" %)

4280

(((

4281

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4288

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4289

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ

[

{

"description": "", ~/~/ Определяет описание

4297

"subscriberId": "", ~/~/ идентификатор запроса

4298

"protocolType": 0, ~/~/ Тип протокола

4299

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4300

"address": "string", ~/~/ Адрес события

4301

"id": "", ~/~/ идентификатор пользователя

4302

"parentId": "", ~/~/ Guid идентификатор родителя

4303

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =

4309

4310

== **API для отчета по выгрузке комбайнов** ==

4311

4312

(% class="box infomessage" %)

4313

(((

4314

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4321

"byDist": 0, ~/~/ Объединение событий по расстоянию

4322

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4323

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4324

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4325

"vehicleIds": [ ~/~/ Список id объектов для анализа

4326

0

4327

],

4328

"from": "", ~/~/ Дата и время начало запроса

4329

"to": "", ~/~/ Дата и время окончания запроса

4330

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4338

"harvesterId": 0, ~/~/Комбайн, id

4339

"harvesterModel": "", ~/~/ Модель комбайна

4340

"hopperCapacity": 0, ~/~/ Объем бункера м3

4341

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4342

"events": [ ~/~/Список событий в разрезе комбайна

4343

{

4344

"driverId": "", ~/~/Идентификатор водителя

4345

"driverName": "", ~/~/Водитель комбайна, ФИО

4346

"RFID": "", ~/~/ идентификатор карты-метки

4347

"rfidName": "", ~/~/Водитель комбайна, имя метки

4348

"vehicleId": 0, ~/~/идентификатор объекта

4349

"vehicleName": "string", ~/~/ Имя объекта

4350

"modelName": "string", ~/~/ Имя модели объекта

4351

"nearestVehicles": [ ~/~/Объекты рядом

4352

{

4353

"vehicleId": 0, ~/~/идентификатор объекта

4354

"vehicleName": "string" ~/~/ Имя объекта

4355

}

4356

],

4357

"fields": [ ~/~/Поля, где происходила выгрузка

4358

{

4359

"id": 0, ~/~/ идентификатор пользователя

4360

"name": "string" ~/~/ имя пользователя

4361

}

4362

],

4363

"event": "string", ~/~/Событие

4364

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4365

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4366

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4367

"cultureName": "string", ~/~/ название культуры

4368

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4369

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4370

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4371

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4372

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4373

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4374

"issued": 0, ~/~/Выдано, бункеров

4375

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4376

"latitude": 0, ~/~/Широта

4377

"longitude": 0, ~/~/ Долгота

4378

"litresAway": 0, ~/~/Отдано, л

4379

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4387

4388

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4389

4390

4391

(% class="box infomessage" %)

4392

(((

4393

GET api/v3/Vehicles/recyclebin/all

4394

)))

4395

4396

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4397

4398

Параметр запроса: {parentId} - идентификатор агента

4399

4400

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4407

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4408

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4409

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4410

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4411

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4412

"details": { ~/~/Список деталей объекта, помещённого в корзину

4413

"items": [ ~/~/

4414

nullable: true ~/~/Детали

4415

{

4416

"name": "string", ~/~/наименование столбца

4417

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4429

4430

(% class="box infomessage" %)

4431

(((

4432

POST/api/v3/Vehicles/recyclebin/erase

4433

)))

4434

4435

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4449

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4450

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4451

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4452

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4453

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4454

"details": { ~/~/Список деталей объекта, помещённого в корзину

4455

"items": [ ~/~/Детали

4456

{

4457

"name": "", ~/~/Имя свойства

4458

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4469

4470

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4471

4472

(% class="box infomessage" %)

4473

(((

4474

POST/api/v3/Vehicles/recyclebin/restore

4475

)))

4476

4477

В заголовках запроса: X-Auth: Токен авторизации

4478

4479

Параметры в теле запроса (JSON):

4480

4481

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4482

4483

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4506

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4507

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4508

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4509

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4510

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4511

"details": { ~/~/Список деталей объекта, помещённого в корзину

4512

"items": [ ~/~/Детали

4513

{

4514

"name": "string", ~/~/Имя свойства

4515

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4528

(((

4529

(% 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]] **

4530

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню