Методы 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 infomessage" %)

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"

}

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

45

46

(% lang="en-US" %)

47

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

48

49

(% lang="en-US" %)

50

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

51

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

(% lang="en-US" %)

}

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

57

58

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

59

60

(% class="box infomessage" %)

61

(((

62

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

63

)))

64

65

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

66

67

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

68

69

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

70

71

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

72

73

(% lang="en-US" %)

74

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

75

76

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

77

78

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

79

80

(% class="box infomessage" %)

81

(((

82

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

83

)))

84

85

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

86

87

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

88

89

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

90

91

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

92

93

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

94

95

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

96

А

97

{

98

"agentId": "", ~/~/ идентификатор клиента (%%)

99

"parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)

100

"parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)

101

"name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)

102

"fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)

103

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

104

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

105

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

106

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

107

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

108

"inn": "string", ~/~/ ИНН клиента

109

"kpp": "string", ~/~/ КПП клиента

110

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

111

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

112

"email": "string", ~/~/ почта

113

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

114

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

115

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

116

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

117

"bankKS": "string" ~/~/ Корр. счет

118

}

119

120

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

121

122

(% class="box infomessage" %)

123

(((

124

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

125

)))

126

127

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

128

129

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

130

131

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

132

133

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

134

135

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

136

137

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

138

139

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

140

141

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

"parentId": "string"

}

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

146

147

{

148

"agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%)

149

"parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)

150

"parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)

151

"name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)

152

"fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)

153

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

154

"status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)

155

}

156

157

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

158

159

(% class="box successmessage" %)

160

(((

161

**POST /api/v3/agents **

162

)))

163

164

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

165

166

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

167

168

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

169

170

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

171

172

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

173

174

{

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

}

Ответ:

{

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

}

219

220

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

221

222

(% class="box warningmessage" %)

223

(((

224

**PUT /api/v3/agents**

225

)))

226

227

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

228

229

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

230

231

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

232

233

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

234

235

236

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

237

238

{

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

}

Ответ:

{

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

}

283

284

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

285

286

(% class="box errormessage" %)

287

(((

288

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

289

)))

290

291

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

292

293

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

294

295

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

296

297

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

298

299

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

300

301

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

302

303

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

304

305

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

306

307

(% class="box successmessage" %)

308

(((

309

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

310

)))

311

312

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

313

314

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

315

316

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

317

318

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

319

320

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

321

322

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

323

{

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

"doubleAuth":

340

{

341

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

342

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

},

"groups":

[

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

],

"customGroups":

[

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

351

],

352

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

}

{

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

357

"lastName": "string",

358

"firstName": "string",

359

"position": "string",

360

"phone": "string",

361

"organization": "string",

362

"login": "string",

363

"password": "string",

"email": "string",

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

368

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

369

370

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

371

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

372

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

392

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

393

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

394

395

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

396

397

(% class="box infomessage" %)

398

(((

399

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

400

)))

401

402

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

403

404

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

405

406

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

407

408

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

409

410

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

411

412

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

413

414

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

415

416

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

417

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

418

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

419

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

420

421

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

422

423

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

424

425

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

426

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

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

440

441

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

442

443

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

444

445

(% class="box infomessage" %)

446

(((

447

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

448

)))

449

450

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

451

452

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

453

454

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

455

456

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

457

458

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

(((

(((

{

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

"doubleAuth":

478

{

479

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

480

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

481

},

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

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

}

)))

)))

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

496

497

(% class="box warningmessage" %)

498

(((

499

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

500

)))

501

502

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

503

504

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

505

506

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

507

508

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

509

510

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

511

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

512

513

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

514

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

515

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

"doubleAuth":

534

{

535

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

536

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

537

},

538

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

539

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

540

541

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

542

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

543

544

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

545

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

546

547

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

548

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

549

550

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

551

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

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

"doubleAuth":

565

{

566

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

567

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

568

},

569

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

570

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

571

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

572

573

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

574

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

575

576

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

577

578

(% class="box warningmessage" %)

579

(((

580

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

581

)))

582

583

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

584

585

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

586

587

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

588

589

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

590

591

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

592

593

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

594

595

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

596

597

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

598

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

599

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

600

601

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

602

603

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

604

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

605

606

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

607

608

(% class="box warningmessage" %)

609

(((

610

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

611

)))

612

613

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

614

615

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

616

617

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

618

619

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

620

621

[

622

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

623

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

624

]

625

626

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

627

628

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

629

630

(% class="box warningmessage" %)

631

(((

632

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

633

)))

634

635

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

636

637

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

638

639

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

640

641

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

642

643

[

644

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

645

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

646

]

647

648

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

649

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

(((

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

{

"errorMessages": [

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

656

],

657

"users": [

658

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

659

]

660

}

661

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

662

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

663

)))

664

665

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

666

667

(% class="box errormessage" %)

668

(((

669

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

670

)))

671

672

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

673

674

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

675

676

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

677

678

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

679

680

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

681

682

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

683

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

684

685

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

686

687

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

688

689

(% class="box infomessage" %)

690

(((

691

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

692

)))

693

694

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

695

696

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

697

698

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

699

700

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

701

702

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

703

704

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

705

706

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

707

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

714

"fueloutlay": 0,

715

"hoppercapacity": 0,

716

"hopperdischargespeed": 0,

717

"modelType": 0,

718

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

719

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

724

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

725

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

726

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

727

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

728

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

729

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

730

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

731

|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-

732

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

733

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

734

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

735

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

736

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

737

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

738

739

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

740

741

(% class="box successmessage" %)

742

(((

743

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

744

)))

745

746

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

747

748

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

749

750

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

751

752

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

753

754

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

755

756

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

757

}

758

759

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

760

761

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

762

{

763

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

764

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

765

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

772

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

773

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

774

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

775

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

776

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

777

778

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

779

780

(% class="box successmessage" %)

781

(((

782

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

783

)))

784

785

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

786

787

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

788

789

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

790

791

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

792

793

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

794

795

{

796

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

797

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

806

"fueloutlay": 0,

807

"hoppercapacity": 0,

808

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

816

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

825

"fueloutlay": 0,

826

"hoppercapacity": 0,

827

"hopperdischargespeed": 0,

"modelType": 0

}

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

833

834

(% class="box warningmessage" %)

835

(((

836

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

837

)))

838

839

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

840

841

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

842

843

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

844

845

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

846

847

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

848

849

{

850

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

851

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

860

"fueloutlay": 0,

861

"hoppercapacity": 0,

862

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

870

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

879

"fueloutlay": 0,

880

"hoppercapacity": 0,

881

"hopperdischargespeed": 0,

"modelType": 0

}

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

886

887

(% class="box errormessage" %)

888

(((

889

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

890

)))

891

892

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

893

894

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

895

896

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

897

898

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

899

900

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

901

902

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

903

904

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

905

906

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

907

908

(% class="box infomessage" %)

909

(((

910

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

911

)))

912

913

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

914

915

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

916

917

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

918

919

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

920

921

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

922

923

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

924

925

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

926

927

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

928

929

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

(((

{

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

934

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

935

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

936

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

937

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

938

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

939

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

940

941

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

942

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

943

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

944

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

945

946

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

947

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

948

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

949

950

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

951

},

952

953

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

954

{

955

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

956

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

957

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

958

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

959

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

960

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

961

}

962

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

977

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

978

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

979

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

980

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

981

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

982

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

983

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

984

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

985

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

986

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

987

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

988

},

989

990

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

991

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

992

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

993

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

994

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

995

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

996

},

997

998

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

999

{

1000

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

1001

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

1002

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

1003

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

}

],

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

1008

{

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

{

1022

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

1023

{

1024

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

1025

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

1026

}

1027

],

1028

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

1029

}

1030

],

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

"string"

1039

],

1040

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

1041

"additionalProp1": "string",

1042

"additionalProp2": "string",

1043

"additionalProp3": "string"

1044

},

1045

1046

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

1047

1048

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

1049

1050

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

1051

1052

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

1053

1054

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

1055

1056

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

1057

1058

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

1059

1060

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

1061

1062

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

1063

1064

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

1065

1066

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

1067

1068

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

1069

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

1070

}

1071

1072

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

1073

{

1074

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

1075

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

1076

"description": "string",

1077

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

}

],

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

1082

{

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

1094

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

}

],

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

1099

{

1100

"status": 0,

1101

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

1102

"description": "string",

1103

"additionalInfo": "string"

}

]

}

)))

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

1111

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

1112

1113

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

1114

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

1115

1116

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

1117

1118

(% class="box successmessage" %)

1119

(((

1120

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

1121

)))

1122

1123

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

1124

1125

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

1126

1127

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

1128

1129

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

1130

1131

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

1132

1133

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

1134

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

1155

1156

"mileageCalcMethod": 0,

1157

"mileageCoeff": 0,

1158

"locationByCellId": true,

1159

"dottedLineTrackWhenNoCoords": true,

1160

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

1161

{

1162

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

1163

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

1164

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

1165

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

1166

},

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

},

1174

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

1175

{

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

}

1188

1189

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

1190

{

1191

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

"isDefault": true

}

],

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

1196

{

1197

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1205

{

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

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

1213

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

1214

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

1215

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

1216

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

1217

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

1218

{

1219

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

1220

{

1221

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

1222

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

1223

}

1224

],

1225

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

1226

}

1227

],

1228

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

1229

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

1230

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

1231

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

1232

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

1233

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

1234

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

1235

"string"

1236

],

1237

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

1238

"additionalProp1": "string",

1239

"additionalProp2": "string",

1240

"additionalProp3": "string"

1241

},

1242

1243

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

1244

1245

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

1246

1247

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

1248

1249

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

1250

1251

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

1252

1253

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

1254

1255

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

1256

1257

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

1258

1259

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

1260

1261

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

1262

1263

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

1264

1265

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

1266

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

1267

}

1268

],

1269

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

1270

{

1271

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1282

1283

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

1284

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

1291

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

1292

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

1293

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

1294

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

1295

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

1296

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

1297

"mileageEnabled": true,

1298

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1303

"id": null,

1304

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

1305

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

1306

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

1307

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

1308

},

1309

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

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

}

1322

1323

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

1324

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

1325

1326

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

1327

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

1328

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

1329

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

1330

1331

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

1332

1333

(% class="box infomessage" %)

1334

(((

1335

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

1336

)))

1337

1338

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

1339

1340

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

1341

1342

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

1343

1344

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

1345

1346

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

1347

1348

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

1349

1350

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

1351

1352

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

1353

1354

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

1355

1356

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

1357

1358

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

1359

1360

(% style="color:#000000" %)− X-Auth: Токен авторизации

1361

1362

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

1363

1364

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

1365

1366

{

1367

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1368

"name": null, ~/~/ Имя ТС (string, опционально)

1369

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1370

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1371

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1372

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1373

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1374

"customFields": null ~/~/ значение любого из произвольных полей ТС

1375

}

1376

1377

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1378

1379

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

1380

1381

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

1382

1383

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1384

"name": "" ~/~/ наименование объекта

1385

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

1386

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1387

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

1388

"sim1": "" ~/~/ первый номер телефона

1389

"sim2": "" ~/~/ второй номер телефона

1390

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

1391

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

1392

"modelId": "" ~/~/ идентификатор модели объекта

1393

"modelName": "" ~/~/ наименование модели объекта

1394

"unitId": "" ~/~/ идентификатор подразделения

1395

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

1396

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1397

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1398

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1399

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1400

"customFields": [

1401

{

1402

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

1403

"name": "", ~/~/ имя произвольного поля

1404

"value": "", ~/~/ значение произвольного поля

1405

"forClient": true, ~/~/ право на отображение у клиента

1406

"forTooltip": false, ~/~/ право на отображение в подсказке

1407

"forReport": false ~/~/ право на отображение в отчетах

1408

}(%%)

1409

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

1410

1411

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1412

1413

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1414

1415

(% class="box successmessage" %)

1416

(((

1417

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

1418

)))

1419

1420

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

1421

1422

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

1423

1424

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

1425

1426

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1427

1428

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

1429

1430

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

1431

1432

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

1433

1434

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1435

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1436

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1437

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1438

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

1439

"data": "", ~/~/ Данные

1440

"overwrite": false, ~/~/ Флаг перезаписи

1441

"stage": "", ~/~/ Состояние, может быть null

1442

1443

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

1444

1445

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

1446

1447

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

1448

1449

"status": "", ~/~/ значение статуса

1450

"date": "", ~/~/ Дата смены статуса

1451

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

1452

"data": "", ~/~/ Данные

1453

"overwrite": false, ~/~/ Флаг перезаписи

1454

"stage": "", ~/~/ Состояние

1455

1456

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

1457

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

1458

1459

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

1460

1461

(% class="box warningmessage" %)

1462

(((

1463

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

1464

)))

1465

1466

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

1467

1468

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

1469

1470

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

1471

1472

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

1473

1474

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

1475

1476

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

1477

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

1478

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

1479

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

1480

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

1481

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

1482

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

1483

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

1484

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

1485

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

1486

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

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

1495

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

1496

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

1497

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

1498

1499

"mileageCalcMethod": 0,

1500

"mileageCoeff": 0,

1501

"locationByCellId": true,

1502

"dottedLineTrackWhenNoCoords": true,

1503

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

1504

{

1505

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

1506

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

1507

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

1508

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

1509

},

1510

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

1511

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

1512

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

1513

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

1514

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

1515

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

1516

},

1517

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

1518

{

1519

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

1520

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

1521

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

1522

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

1523

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

1524

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

1525

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

1526

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

1527

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

1528

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

1529

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

1530

}

1531

1532

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

1533

{

1534

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

"isDefault": true

}

],

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

1539

{

1540

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1548

{

1549

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

1550

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

1551

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

1552

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

1553

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

1554

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

1555

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

1556

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

1557

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

1558

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

1559

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1560

"gradesTables": [ ~/~/ Массив таблиц тарировки

1561

{

1562

"grades": [ ~/~/ Таблица тарировки 1

1563

{

1564

"input": 0, ~/~/ Входящее значение

1565

"output": 0 ~/~/ Выходящее значение

1566

}

1567

],

1568

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1569

}

1570

],

1571

"showInTooltip": true, ~/~/ Отображать в подсказке

1572

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1573

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1574

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1575

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1576

"expr": "string", ~/~/ Формула

1577

"children": [ ~/~/ массив дочерних датчиков

1578

"string"

1579

],

1580

"customParams": { ~/~/ прочие произвольные параметры

1581

"additionalProp1": "string",

1582

"additionalProp2": "string",

1583

"additionalProp3": "string"

1584

},

1585

1586

~/~/ Характерные для произвольного:

1587

1588

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1589

1590

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1591

1592

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1593

1594

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1595

1596

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1597

1598

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1599

1600

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1601

1602

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1603

1604

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1605

1606

~/~/ "ValueOn": "Вкл.",

1607

1608

~/~/ "ValueOff": "Выкл."

1609

"summaryMaxValue": 0 ~/~/ Макс. значение

1610

}

1611

],

1612

"customFields": [ ~/~/ Произвольные поля

1613

{

1614

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1625

1626

(% lang="en-US" style="text-align:left" %)

1627

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1628

1629

(% lang="en-US" style="text-align:left" %)

1630

"vehicleId": "", ~/~/ ID ТС

1631

"parentId": "", ~/~/ ID клиента

1632

"name": "", ~/~/ имя ТС

1633

"imei": "", ~/~/ IMEI

1634

"deviceTypeId": "", ~/~/ типа устройства

1635

"modelId": "", ~/~/ ID модели

1636

"unitId": "", ~/~/ ID подразделения

1637

"sim1": "", ~/~/ SIM 1

1638

"sim2": "", ~/~/ SIM2

1639

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1640

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1641

"counters":

1642

{

1643

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1644

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1645

"mileage": "", ~/~/ пробег

1646

"motohours": "", ~/~/ моточасы

1647

}

1648

"cmsv6Parameters": ~/~/ параметры CMSv6

1649

{

1650

"id": ~/~/ идентификатор

1651

"enabled": true, ~/~/ флаг включения

1652

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1653

"login": "", ~/~/ имя учетной записи

1654

"password": "", ~/~/ пароль учетной записи

1655

}

1656

"inspectionTasks": ~/~/ задания на ТО

1657

{

1658

"id": "", ~/~/ ID задания

1659

"enabled": false, ~/~/ Признак включения

1660

"name": "", ~/~/ Имя задания

1661

"description": "", ~/~/ Описание задания

1662

"mileageCondition": "", ~/~/ Условие по пробегу

1663

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1664

"motohoursCondition": "", ~/~/ Условие по моточасам

1665

"lastMotohours": "", ~/~/ Моточасы

1666

"periodicCondition": "", ~/~/ Условие периодичности по времени

1667

"kind": "", ~/~/ Вид периодичности по времени

1668

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1669

}

1670

1671

(% lang="en-US" style="text-align:left" %)

1672

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1673

1674

**Валидация:**

1675

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1676

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1677

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1678

1679

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1680

1681

(% class="box errormessage" %)

1682

(((

1683

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1684

)))

1685

1686

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1687

1688

(% style="color:#000000" %)Метод запроса: **DELETE**

1689

1690

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1691

1692

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1693

1694

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1695

1696

(% style="text-align:left" %)

1697

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1698

1699

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1700

1701

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1702

1703

(% class="box infomessage" %)

1704

(((

1705

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1706

)))

1707

1708

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1709

1710

(% style="color:#000000" %)Метод запроса: **GET**

1711

1712

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]

1713

1714

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1715

1716

(% style="color:#000000" %)Ответ:

1717

1718

(% style="color:#000000" %){

1719

1720

"deviceTypeId" : "", ~/~/ ID типа устройства

1721

"deviceTypeName" : "" ~/~/ Название типа устройства

1722

1723

(% style="text-align:left" %)

1724

(% style="color:#000000" %)}

1725

1726

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1727

1728

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1729

1730

(% class="box infomessage" %)

1731

(((

1732

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1733

)))

1734

1735

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1736

1737

(% style="color:#000000" %)Метод запроса: **GET**

1738

1739

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1740

1741

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1742

1743

(% style="color:#000000" %)Ответ:

1744

1745

(% style="color:#000000" %){

1746

1747

"id": "", ~/~/ ID типа датчика

1748

"name": "", ~/~/ Название

1749

"description": "", ~/~/ Описание

1750

1751

(% style="text-align:left" %)

1752

(% style="color:#000000" %)}

1753

1754

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1755

1756

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1757

1758

(% class="box infomessage" style="text-align: left;" %)

1759

(((

1760

**POST /api/v3/terminalMessages/count**

1761

)))

1762

1763

(% style="text-align: left;" %)

1764

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1765

1766

(% style="text-align: left;" %)

1767

Метод запроса **POST**

1768

1769

(% style="text-align: left;" %)

1770

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1771

1772

(% style="text-align: left;" %)

1773

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1774

1775

(% style="text-align: left;" %)

1776

{

1777

"vehicleIds": [

1778

id ~/~/ здесь передается список идентификаторов объектов

1779

],

1780

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1781

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1782

}

1783

1784

(% style="text-align: left;" %)

1785

Ответ:

1786

1787

(% style="text-align: left;" %)

1788

[

1789

{

1790

"vehicleId": 0, ~/~/ идентификатор объекта

1791

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

1796

1797

(% class="box infomessage" %)

1798

(((

1799

**POST /api/v3/terminalMessages**

1800

)))

1801

1802

Метод возвращает список сообщений терминала объекта за выбранный период.

1803

1804

(% style="text-align: left;" %)

1805

Метод запроса **POST**

1806

1807

(% style="text-align: left;" %)

1808

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

1809

1810

(% style="text-align: left;" %)

1811

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1812

1813

{

1814

"vehicleId": 0, ~/~/ id объекта

1815

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

1816

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

}

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства

1826

"serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера

1827

"speed": 0, ~/~/ Скорость, км/ч

1828

"altitude": 0, ~/~/ Высота, м

1829

"latitude": 0, ~/~/ Широта [-90°;90°]

1830

"longitude": 0, ~/~/ Долгота [-180°;180°]

1831

"satellites": 0, ~/~/ Кол-во спутников

1832

"voltage": 0, ~/~/ Напряжение

1833

"parameters": { ~/~/ список параметров датчиков передаваемых терминалом

1834

"additionalProp1": "string",

1835

"additionalProp2": "string",

1836

"additionalProp3": "string"

1837

},

1838

"photoCount": 0 ~/~/ Кол-во фото

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

1845

1846

(% class="box infomessage" %)

1847

(((

1848

**POST /api/v3/vehicles/export/history**

1849

)))

1850

1851

Метод возвращает список сообщений терминала объекта за выбранный период.

1852

1853

(% style="text-align: left;" %)

1854

Метод запроса **POST**

1855

1856

(% style="text-align: left;" %)

1857

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history

1858

1859

(% style="text-align: left;" %)

1860

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1861

1862

{

1863

"vehicleId": 0, ~/~/ ID объекта

1864

"asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать

1865

"from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса

1866

"to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

1872

1873

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

1874

1875

(% class="box infomessage" %)

1876

(((

1877

**GET /api/v3/vehicles/export/history/status**

1878

)))

1879

1880

Метод возвращает список сообщений терминала объекта за выбранный период.

1881

1882

(% style="text-align: left;" %)

1883

Метод запроса **GET**

1884

1885

(% style="text-align: left;" %)

1886

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status

1887

1888

(% style="text-align: left;" %)

1889

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

Ответ:

{

"activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

1895

"progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.

1896

"message": "string" ~/~/ текст описывающий статус.

1897

}

1898

1899

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

1900

1901

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

1902

1903

(% class="box infomessage" %)

1904

(((

1905

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

1906

)))

1907

1908

(% style="color:#000000" %)Метод запроса: **POST**

1909

1910

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

1911

1912

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1913

1914

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

1919

"vehicleIds": [0], ~/~/ Список ID объектов

1920

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

1921

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

1922

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

1930

"name": "string", ~/~/ Имя ТС

1931

"periods": [ ~/~/ Периоды

1932

{

1933

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

1934

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

1935

"mileageBegin": 0, ~/~/ Пробег на начало периода

1936

"mileageEnd": 0, ~/~/ Пробег на окончание периода

1937

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

1938

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

1945

1946

(% class="box infomessage" %)

1947

(((

1948

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

1949

)))

1950

1951

(% style="color:#000000" %)Метод запроса: **POST**

1952

1953

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

1954

1955

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1956

1957

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

1962

"vehicleIds": [0], ~/~/ Список ID объектов

1963

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

1964

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

1965

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

1973

"name": "string", ~/~/ Имя ТС

1974

"periods": [ ~/~/ Периоды

1975

{

1976

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

1977

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

1978

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

1979

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

1980

"fuelConsumption": 0, ~/~/ Расход топлива

1981

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

1988

1989

(% class="box infomessage" %)

1990

(((

1991

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

1992

)))

1993

1994

(% style="color:#000000" %)Метод запроса: **POST**

1995

1996

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

1997

1998

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1999

2000

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2005

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2006

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2007

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2015

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2016

"vehicleId": 0, ~/~/ ID объекта

2017

"name": "string", ~/~/ Имя объекта

2018

"model": "string", ~/~/ Модель объекта

2019

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2020

{

2021

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2022

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2023

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2024

"valueFuel": 0, ~/~/ Количество

2025

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2026

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2033

2034

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2035

2036

(% class="box infomessage" %)

2037

(((

2038

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2039

)))

2040

2041

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2042

2043

(% style="color:#000000" %)Метод запроса: **POST**

2044

2045

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2046

2047

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2048

2049

(% style="text-align:left" %)

2050

Тело запроса:

2051

2052

(% style="text-align:left" %)

2053

{

2054

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2055

}

2056

2057

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2063

"name": "string", ~/~/ Название объекта геозоны

2064

"type": 0, ~/~/ Тип объекта геозоны

2065

"fname": "string", ~/~/ Имя файла

2066

"parentId": "string", ~/~/ Идентификатор клиента

2067

"radius": 0, ~/~/ Радиус геообъекта

2068

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2069

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2070

"description": "string", ~/~/ Описание

2071

"area": 0, ~/~/ Площадь, м^^2^^

2072

"perimetr": 0, ~/~/ Периметр, м

2073

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2078

2079

(% class="box infomessage" %)

2080

(((

2081

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2082

)))

2083

2084

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2085

2086

(% style="color:#000000" %)Метод запроса: **POST**

2087

2088

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2089

2090

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2091

2092

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2097

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2098

"ids": [ ], ~/~/ Массив id объектов

2099

"byTime": 0, ~/~/ Объединение событий по времени

2100

"byDist": 0, ~/~/ Объединение событий по расстоянию

2101

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2102

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2109

"geozoneName": "string", ~/~/ Название геообъекта

2110

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2111

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2112

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2113

"vehicleId": 0, ~/~/ ID объекта

2114

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2119

2120

(% class="box infomessage" %)

2121

(((

2122

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2123

)))

2124

2125

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2126

2127

(% style="color:#000000" %)Метод запроса: **POST**

2128

2129

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2130

2131

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2132

2133

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2138

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2139

"ids": [ ], ~/~/ Массив id геообъектов

2140

"byTime": 0, ~/~/ Объединение событий по времени

2141

"byDist": 0, ~/~/ Объединение событий по расстоянию

2142

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2143

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2151

"geozoneName": "string", ~/~/ Название геообъекта

2152

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2153

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2154

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2155

"vehicleId": 0, ~/~/ ID объекта

2156

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2161

2162

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2163

2164

(% class="box infomessage" %)

2165

(((

2166

**POST /api/v3/notifications/find**

2167

)))

2168

2169

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2170

2171

(% style="text-align: left;" %)

2172

Метод запроса **POST**

2173

2174

(% style="text-align: left;" %)

2175

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2176

2177

(% style="text-align: left;" %)

2178

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2179

2180

{

2181

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2189

"name": "string", ~/~/ Название уведомления

2190

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2191

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2192

"userId": "", ~/~/ Пользователь, создавший уведомление

2193

"parentId": "", ~/~/ Идентификатор клиента

2194

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2199

2200

(% class="box infomessage" %)

2201

(((

2202

**GET /api/v3/notifications/{id}**

2203

)))

2204

2205

Метод возвращает данные правил формирования выбранного уведомления.

2206

2207

(% style="text-align: left;" %)

2208

Метод запроса **GET**

2209

2210

(% style="text-align: left;" %)

2211

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2212

2213

(% style="text-align: left;" %)

2214

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2215

2216

(% style="text-align: left;" %)

2217

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2218

2219

(% style="text-align: left;" %)

2220

(% style="color:#000000" %)Ответ:

2221

2222

(% style="text-align: left;" %)

2223

(% style="color:#000000" %){

2224

"id": 0, ~/~/ (%%)id уведомления

2225

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2226

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2227

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2228

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2229

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2230

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2231

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2232

(% style="color:#000000" %) 0

2233

],

2234

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2235

(% style="color:#000000" %) 0

2236

],

2237

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2238

(% style="color:#000000" %) 0

2239

],

2240

"settings": { ~/~/ Список параметров уведомления

2241

"additionalProp1": "string",

2242

"additionalProp2": "string",

2243

"additionalProp3": "string"

2244

},

2245

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2246

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2247

(% style="color:#000000" %) ""

2248

],

2249

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2250

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2251

(% style="color:#000000" %) "string"

2252

],

2253

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2254

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2255

(% style="color:#000000" %) {

2256

"id": 0, ~/~/ (%%)Идентификатор участника чата

2257

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2258

(% style="color:#000000" %) }

2259

],

2260

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2261

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2262

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2263

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2264

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2265

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2266

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2267

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2268

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2269

(% style="color:#000000" %)}

2270

2271

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2272

2273

(% class="box warningmessage" %)

2274

(((

2275

**PUT /api/v3/notifications/**

2276

)))

2277

2278

Метод позволяет отредактировать уведомление.

2279

2280

Метод запроса **PUT**

2281

2282

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2283

2284

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2289

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2290

"userId": "", ~/~/ Пользователь, создавший уведомление

2291

"parentId": "", ~/~/ Идентификатор клиента

2292

"parentName": "string", ~/~/ Имя клиента

2293

"name": "string", ~/~/ Название уведомления

2294

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2295

"vehicleIds": [ ~/~/ Список id объектов для анализа

2296

0

2297

],

2298

"geoids": [ ~/~/ Список id геообъектов для анализа

2299

0

2300

],

2301

"fieldids": [ ~/~/ Список id полей для анализа

2302

0

2303

],

2304

"settings": { ~/~/ Список параметров уведомления

2305

"additionalProp1": "string",

2306

"additionalProp2": "string",

2307

"additionalProp3": "string"

2308

},

2309

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2310

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2311

""

2312

],

2313

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2314

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2315

"string"

2316

],

2317

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2318

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2319

{

2320

"id": 0, ~/~/ Идентификатор участника чата

2321

"info": "string" ~/~/ Дополнительные сведения

2322

}

2323

],

2324

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2325

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2326

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2327

"kind": 0, ~/~/ Определяет вид уведомления

2328

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2329

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2330

"timezone": 0, ~/~/ Сдвиг часового пояса

2331

"validity": 0, ~/~/ Срок действия в днях (1-90)

2332

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2340

2341

(% class="box errormessage" %)

2342

(((

2343

**DELETE /api/v3/notifications/{id}**

2344

)))

2345

2346

Метод позволяет удалить выбранное уведомление.

2347

2348

Метод запроса **DELETE**

2349

2350

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2351

2352

Передаваемый параметр: {id} - id уведомления

2353

2354

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2362

2363

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2364

2365

(% class="box infomessage" %)

2366

(((

2367

**POST /api/v3/Drivers/find**

2368

)))

2369

2370

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2377

"description": "string", ~/~/ Определяет описание

2378

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2379

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2380

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2381

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2382

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2383

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2388

2389

(% class="box infomessage" %)

2390

(((

2391

**GET /api/v3/Drivers/{driverGuid}**

2392

)))

2393

2394

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2400

"description": "string", ~/~/ Определяет описание

2401

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2402

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2403

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2404

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2405

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2406

"deleted": true ~/~/ Признак удаления

2407

}

2408

2409

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2410

2411

(% class="box successmessage" %)

2412

(((

2413

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2421

"hiredate": "2023-06-30T12:50:54.020Z",

2422

"chopdate": "2023-06-30T12:50:54.020Z",

2423

"exclusive": true,

2424

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2425

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2434

"hiredate": "2023-06-30T12:50:54.051Z",

2435

"chopdate": "2023-06-30T12:50:54.051Z",

2436

"exclusive": true,

2437

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2438

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2444

2445

(% class="box warningmessage" %)

2446

(((

2447

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2455

"hiredate": "2023-06-30T12:50:27.910Z",

2456

"chopdate": "2023-06-30T12:50:27.910Z",

2457

"exclusive": true,

2458

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2459

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2468

"hiredate": "2023-06-30T12:50:27.929Z",

2469

"chopdate": "2023-06-30T12:50:27.929Z",

2470

"exclusive": true,

2471

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2472

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2478

2479

(% class="box errormessage" %)

2480

(((

2481

**DELETE /api/v3/Drivers/{driverGuid}**

2482

)))

2483

2484

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2492

2493

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2494

2495

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2496

2497

(% class="box infomessage" %)

2498

(((

2499

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2507

],

2508

"BeginTime": "2023-06-30T12:49:04.365Z",

2509

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2518

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2519

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2520

"BeginTime": "2023-06-30T09:52:31.240Z",

2521

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2527

2528

(% class="box infomessage" %)

2529

(((

2530

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2540

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2549

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2550

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2551

"BeginTime": "2023-06-30T09:54:01.631Z",

2552

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2558

2559

(% class="box successmessage" %)

2560

(((

2561

**POST /api/v3/DriversVehiclesAssignments**

2562

)))

2563

2564

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2571

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2572

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2573

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2574

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2584

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2585

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2586

"BeginTime": "2023-06-30T11:04:46.903Z",

2587

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2593

2594

(% class="box warningmessage" %)

2595

(((

2596

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2605

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2606

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2607

"BeginTime": "2023-06-30T11:14:08.117Z",

2608

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2618

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2619

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2620

"BeginTime": "2023-06-30T11:14:53.349Z",

2621

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2627

2628

(% class="box errormessage" %)

2629

(((

2630

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2645

2646

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2647

2648

(% class="box infomessage" %)

2649

(((

2650

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2658

],

2659

"BeginTime": "2023-06-30T12:47:12.162Z",

2660

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2668

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2669

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2670

"BeginTime": "2023-06-30T11:19:40.703Z",

2671

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2677

2678

(% class="box infomessage" %)

2679

(((

2680

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2688

],

2689

"BeginTime": "2023-06-30T12:47:12.162Z",

2690

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2698

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2699

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2700

"BeginTime": "2023-06-30T11:19:40.703Z",

2701

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2707

2708

(% class="box successmessage" %)

2709

(((

2710

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2718

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2719

"BeginTime": "2023-06-30T11:27:08.635Z",

2720

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2729

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2730

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2731

"BeginTime": "2023-06-30T11:27:08.677Z",

2732

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

2738

2739

(% class="box warningmessage" %)

2740

(((

2741

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2749

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2750

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2751

"BeginTime": "2023-06-30T11:28:43.330Z",

2752

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2761

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2762

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2763

"BeginTime": "2023-06-30T11:28:43.331Z",

2764

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

2770

2771

(% class="box errormessage" %)

2772

(((

2773

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

2788

2789

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

2790

2791

(% class="box infomessage" %)

2792

(((

2793

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2801

],

2802

"BeginTime": "2023-06-30T12:45:10.852Z",

2803

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2811

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2812

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2813

"BeginTime": "2023-06-30T11:58:04.695Z",

2814

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

2820

2821

(% class="box infomessage" %)

2822

(((

2823

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2831

],

2832

"BeginTime": "2023-06-30T12:45:10.852Z",

2833

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2841

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2842

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2843

"BeginTime": "2023-06-30T11:58:04.695Z",

2844

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

2850

2851

(% class="box successmessage" %)

2852

(((

2853

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2861

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2862

"BeginTime": "2023-06-30T12:09:53.175Z",

2863

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2872

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2873

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2874

"BeginTime": "2023-06-30T12:09:53.201Z",

2875

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

2881

2882

(% class="box warningmessage" %)

2883

(((

2884

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2892

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2893

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2894

"BeginTime": "2023-06-30T12:09:53.201Z",

2895

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2904

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2905

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2906

"BeginTime": "2023-06-30T12:09:53.201Z",

2907

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

2913

2914

(% class="box errormessage" %)

2915

(((

2916

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

2931

2932

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

2933

2934

(% class="box infomessage" %)

2935

(((

2936

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0, ~/~/ Частота трансляции радиометки

2952

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2953

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

2959

2960

(% class="box infomessage" %)

2961

(((

2962

**GET /api/v3/Rfids/{rfidGuid}**

2963

)))

2964

2965

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0, ~/~/ Частота трансляции радиометки

2974

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2975

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

]

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

2982

2983

(% class="box successmessage" %)

2984

(((

2985

**POST /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3005

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3010

3011

(% class="box warningmessage" %)

3012

(((

3013

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3023

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3034

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3039

3040

(% class="box errormessage" %)

3041

(((

3042

**DELETE /api/v3/Rfids/{rfidGuid}**

3043

)))

3044

3045

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3053

3054

(% class="wikigeneratedid" %)

3055

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3056

3057

(% class="box infomessage" %)

3058

(((

3059

**GET /api/v3/Billing/client/balance/{clientId}**

3060

)))

3061

3062

Параметр запроса: **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);" %)**Описание**

3072

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3073

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3074

3075

(% class="wikigeneratedid" %)

3076

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3077

3078

(% class="box infomessage" %)

3079

(((

3080

**GET /api/v3/Billing/client/constraint/{clientId}**

3081

)))

3082

3083

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3089

"CalculationType": 0,

3090

"PermissibleBalance": 0,

3091

"DefermentDays": 0,

3092

"SendUiNotifications": true,

3093

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3098

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3099

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3100

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3101

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3102

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3103

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3104

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3105

3106

(% class="wikigeneratedid" %)

3107

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3108

3109

(% class="box infomessage" %)

3110

(((

3111

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3117

3118

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3124

"Plan": { **~/~/ Описание тарифного плана**

3125

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3126

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3131

"PermissibleBalance": 0,

3132

"DefermentDays": 0

3133

},

3134

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3146

"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);" %)**Описание**

3162

|ClientId|Идентификатор клиента

3163

|Id|Идентификатор тарифного плана

3164

|OwnerId|Идентификатор клиента-владельца

3165

|Name|Наименование тарифного плана

3166

|IsArchived|Признак, определяющий архивный тарифный план

3167

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3168

|PermissibleBalance|Допустимый баланс

3169

|DefermentDays|Отсрочка, количество дней

3170

|Feature|Код услуги

3171

|IsEnabled|Признак, определяющий активирована ли услуга

3172

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3173

|IsFactual|Признак, определяющий расчёт по факту

3174

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3175

|Price|Цена за единицу.

3176

|DebitDate|Следующий момент времени списания с баланса за услугу.

3177

|PeriodValue|Значение периода.

3178

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3179

3180

(% class="wikigeneratedid" %)

3181

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3182

3183

(% class="box infomessage" %)

3184

(((

3185

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3186

)))

3187

3188

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3195

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3200

"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);" %)**Описание**

3217

|ClientId|Идентификатор клиента

3218

|Id|Идентификатор тарифного плана

3219

|OwnerId|Идентификатор клиента-владельца

3220

|Name|Наименование тарифного плана

3221

|IsArchived|Признак, определяющий архивный тарифный план

3222

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3223

|PermissibleBalance|Допустимый баланс

3224

|DefermentDays|Отсрочка, количество дней

3225

|Feature|Код услуги

3226

|IsFactual|Признак, определяющий расчёт по факту

3227

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3228

|Price|Цена за единицу.

3229

|PeriodValue|Значение периода.

3230

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3231

3232

(% class="wikigeneratedid" %)

3233

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3234

3235

(% class="box infomessage" %)

3236

(((

3237

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3238

)))

3239

3240

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3247

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3252

"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);" %)**Описание**

3269

|ClientId|Идентификатор клиента

3270

|Id|Идентификатор тарифного плана

3271

|OwnerId|Идентификатор клиента-владельца

3272

|Name|Наименование тарифного плана

3273

|IsArchived|Признак, определяющий архивный тарифный план

3274

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3275

|PermissibleBalance|Допустимый баланс

3276

|DefermentDays|Отсрочка, количество дней

3277

|Feature|Код услуги

3278

|IsFactual|Признак, определяющий расчёт по факту

3279

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3280

|Price|Цена за единицу.

3281

|PeriodValue|Значение периода.

3282

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3283

3284

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3285

3286

(% class="box warningmessage" %)

3287

(((

3288

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3295

"CalculationType": 0,

3296

"PermissibleBalance": 0,

3297

"DefermentDays": 0,

3298

"SendUiNotifications": true,

3299

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3306

|ClientId|Идентификатор клиента

3307

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3308

|PermissibleBalance|Допустимый баланс

3309

|DefermentDays|(((

3310

Отсрочка, количество дней

3311

)))

3312

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3313

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3314

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3315

3316

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3317

3318

(% class="box warningmessage" %)

3319

(((

3320

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3327

"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);" %)**Описание**

3345

|ClientId|Идентификатор клиента

3346

|Feature|Код услуги

3347

|IsEnabled|Признак, определяющий активирована ли услуга

3348

|IsFactual|Признак, определяющий расчёт по факту

3349

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3350

|Price|Цена за единицу.

3351

|DebitDate|Следующий момент времени списания с баланса за услугу.

3352

|PeriodValue|Значение периода.

3353

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3354

3355

3356

(% class="box" lang="en-US" style="text-align: center;" %)

3357

(((

3358

(% 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]] **

3359

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню