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

1

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

2

(((

3

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

)))

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

10

11

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

12

13

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

14

15

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

16

17

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

18

19

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

20

21

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

22

23

(% class="box successmessage" %)

24

(((

25

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

26

)))

27

28

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

29

30

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

31

32

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

33

34

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

35

36

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

37

38

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

39

"login": "testuser",

40

"password": "testuser"

41

}

42

43

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

44

45

(% lang="en-US" %)

46

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

47

48

(% lang="en-US" %)

49

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

50

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

(% lang="en-US" %)

}

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

56

57

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

58

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

59

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

60

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

61

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

62

63

(% class="wikigeneratedid" %)

64

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

65

66

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

67

68

(% class="box infomessage" %)

69

(((

70

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

71

)))

72

73

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

74

75

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

76

77

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

78

79

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

80

81

(% lang="en-US" %)

82

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

83

84

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

85

86

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

87

88

(% class="box infomessage" %)

89

(((

90

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

91

)))

92

93

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

94

95

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

96

97

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

98

99

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

100

101

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

102

103

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

108

"name": "string",

109

"fullName": "string",

110

"agentInfoType": 0,

111

"isForeign": true/false,

112

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

119

"email": "string",

120

"director": "string",

121

"bankName": "string",

"bankBIK": "string",

"bankRS": "string",

"bankKS": "string"

}

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

149

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

150

151

(% class="box infomessage" %)

152

(((

153

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

154

)))

155

156

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

157

158

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

159

160

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

161

162

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

163

164

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

165

166

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

167

168

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

169

170

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

"parentId": "string"

}

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

175

176

{

177

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

178

"parentId": "",

179

"name": "string",

180

"fullName": "string",

181

"agentInfoType": 0,

182

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

}

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

187

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

188

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

189

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

190

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

191

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

192

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

193

194

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

195

196

(% class="box successmessage" %)

197

(((

198

**POST /api/v3/agents **

199

)))

200

201

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

202

203

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

204

205

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

206

207

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

208

209

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

210

211

{

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

}

Ответ:

{

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

}

256

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

279

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

280

281

(% class="box warningmessage" %)

282

(((

283

**PUT /api/v3/agents**

284

)))

285

286

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

287

288

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

289

290

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

291

292

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

293

294

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

295

296

{

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

}

Ответ:

{

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

}

340

341

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

342

343

(% class="box errormessage" %)

344

(((

345

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

346

)))

347

348

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

349

350

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

351

352

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

353

354

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

355

356

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

357

358

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

359

360

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

361

362

(% class="box warningmessage" %)

363

(((

364

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

365

)))

366

367

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

368

369

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

370

371

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

Ответ: Code 204

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

376

377

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

378

379

(% class="box successmessage" %)

380

(((

381

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

382

)))

383

384

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

385

386

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

387

388

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

389

390

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

391

392

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

393

394

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

395

{

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

"doubleAuth":

412

{

413

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

414

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

},

"groups":

[

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

],

"customGroups":

[

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

423

],

424

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

}

{

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

429

"lastName": "string",

430

"firstName": "string",

431

"position": "string",

432

"phone": "string",

433

"organization": "string",

434

"login": "string",

435

"password": "string",

436

"email": "string",

437

438

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

439

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

440

441

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

442

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

443

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

463

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

464

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

465

466

467

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

468

469

(% class="box infomessage" %)

470

(((

471

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

472

)))

473

474

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

475

476

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

477

478

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

479

480

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

481

482

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

483

484

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

485

486

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

487

488

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

489

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

490

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

491

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

492

493

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

494

495

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

496

497

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

498

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

513

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

514

515

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

516

517

(% class="box infomessage" %)

518

(((

519

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

520

)))

521

522

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

523

524

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

525

526

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

527

528

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

529

530

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

(((

(((

{

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

"doubleAuth":

550

{

551

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

552

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

553

},

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

}

)))

)))

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

568

569

(% class="box warningmessage" %)

570

(((

571

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

572

)))

573

574

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

575

576

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

577

578

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

579

580

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

581

582

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

583

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

584

585

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

586

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

587

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

"doubleAuth":

606

{

607

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

608

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

609

},

610

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

611

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

612

613

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

614

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

615

616

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

617

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

618

619

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

620

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

621

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

"doubleAuth":

637

{

638

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

639

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

640

},

641

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

642

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

643

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

644

645

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

646

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

647

648

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

649

650

(% class="box warningmessage" %)

651

(((

652

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

653

)))

654

655

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

656

657

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

658

659

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

660

661

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

662

663

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

664

665

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

666

667

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

668

669

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

670

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

671

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

672

673

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

674

675

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

676

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

677

678

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

679

680

(% class="box warningmessage" %)

681

(((

682

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

683

)))

684

685

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

686

687

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

688

689

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

690

691

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

692

693

[

694

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

695

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

696

]

697

698

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

699

700

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

701

702

(% class="box warningmessage" %)

703

(((

704

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

705

)))

706

707

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

708

709

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

710

711

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

712

713

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

714

715

[

716

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

717

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

718

]

719

720

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

721

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

(((

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

{

"errorMessages": [

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

728

],

729

"users": [

730

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

731

]

732

}

733

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

734

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

735

)))

736

737

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

738

739

(% class="box errormessage" %)

740

(((

741

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

742

)))

743

744

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

745

746

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

747

748

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

749

750

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

751

752

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

753

754

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

755

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

756

757

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

758

759

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

760

761

(% class="box infomessage" %)

762

(((

763

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

764

)))

765

766

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

767

768

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

769

770

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

771

772

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

773

774

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

775

776

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

777

778

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

779

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

786

"hoppercapacity": 0,

787

"hopperdischargespeed": 0,

788

"modelType": 0,

789

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

790

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

"deleted": true

}

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

808

809

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

810

811

(% class="box successmessage" %)

812

(((

813

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

814

)))

815

816

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

817

818

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

819

820

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

821

822

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

823

824

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

825

826

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

827

}

828

829

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

830

831

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

832

{

833

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

834

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

835

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

842

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

843

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

844

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

845

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

846

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

847

848

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

849

850

(% class="box successmessage" %)

851

(((

852

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

853

)))

854

855

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

856

857

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

858

859

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

860

861

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

862

863

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

864

865

{

866

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

867

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

876

"fueloutlay": 0,

877

"hoppercapacity": 0,

878

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

886

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

895

"hoppercapacity": 0,

896

"hopperdischargespeed": 0,

"modelType": 0

}

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

914

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

915

916

(% class="box warningmessage" %)

917

(((

918

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

919

)))

920

921

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

922

923

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

924

925

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

926

927

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

928

929

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

930

931

{

932

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

933

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

942

"fueloutlay": 0,

943

"hoppercapacity": 0,

944

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

952

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

961

"fueloutlay": 0,

962

"hoppercapacity": 0,

963

"hopperdischargespeed": 0,

"modelType": 0

}

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

979

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

980

981

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

982

983

(% class="box errormessage" %)

984

(((

985

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

986

)))

987

988

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

989

990

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

991

992

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

993

994

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

995

996

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

997

998

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

999

1000

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

1001

1002

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

1003

1004

(% class="box infomessage" %)

1005

(((

1006

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

1007

)))

1008

1009

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

1010

1011

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

1012

1013

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

1014

1015

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

1016

1017

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

1018

1019

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

1020

1021

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

1022

1023

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

1024

1025

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

(((

{

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

1037

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

1038

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

1039

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

1040

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

1041

1042

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

1043

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

1044

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

1045

1046

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

1047

},

1048

1049

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

1050

{

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

}

1058

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

1072

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

},

1085

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

},

1093

1094

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

1095

{

1096

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

1097

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

1098

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

1099

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

}

],

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

1104

{

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

{

1118

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

1119

{

1120

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

1121

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

1122

}

1123

],

1124

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

1125

}

1126

],

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

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

1134

"string"

1135

],

1136

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

1137

"additionalProp1": "string",

1138

"additionalProp2": "string",

1139

"additionalProp3": "string"

1140

},

1141

1142

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

1143

1144

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

1145

1146

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

1147

1148

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

1149

1150

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

1151

1152

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

1153

1154

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

1155

1156

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

1157

1158

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

1159

1160

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

1161

1162

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

1163

1164

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

1165

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

1166

}

1167

1168

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

1169

{

1170

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

1171

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

1172

"description": "string",

1173

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

}

],

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

1178

{

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

}

],

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

1195

{

1196

"status": 0,

1197

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

1198

"description": "string",

1199

"additionalInfo": "string"

}

]

}

)))

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

1207

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

1208

1209

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

1210

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

1211

1212

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

1213

1214

(% class="box successmessage" %)

1215

(((

1216

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

1217

)))

1218

1219

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

1220

1221

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

1222

1223

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

1224

1225

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

1226

1227

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

1228

1229

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

1230

1231

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

1232

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

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

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

1250

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

1251

1252

"mileageCalcMethod": 0,

1253

"mileageCoeff": 0,

1254

"locationByCellId": true,

1255

"dottedLineTrackWhenNoCoords": true,

1256

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

1257

{

1258

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

1259

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

1260

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

1261

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

1262

},

1263

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

1264

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

1265

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

1266

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

1267

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

1268

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

1269

},

1270

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

1271

{

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

}

1284

1285

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

1286

{

1287

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

"isDefault": true

}

],

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

1292

{

1293

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1301

{

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

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

1312

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

1313

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

1314

{

1315

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

1316

{

1317

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

1318

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

1319

}

1320

],

1321

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

1322

}

1323

],

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

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

1331

"string"

1332

],

1333

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

1334

"additionalProp1": "string",

1335

"additionalProp2": "string",

1336

"additionalProp3": "string"

1337

},

1338

1339

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

1340

1341

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

1342

1343

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

1344

1345

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

1346

1347

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

1348

1349

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

1350

1351

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

1352

1353

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

1354

1355

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

1356

1357

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

1358

1359

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

1360

1361

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

1362

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

1363

}

1364

],

1365

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

1366

{

1367

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1378

1379

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

1380

1381

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

1382

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

1383

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

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

"mileageEnabled": true,

1394

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1399

"id": null,

1400

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

1401

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

1402

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

1403

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

1404

},

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

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

1415

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

1416

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

1417

}

1418

1419

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

1420

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

1421

1422

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

1423

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

1424

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

1425

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

1426

1427

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

1428

1429

(% class="box infomessage" %)

1430

(((

1431

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

1432

)))

1433

1434

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

1435

1436

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

1437

1438

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

1439

1440

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

1441

1442

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

1443

1444

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

1445

1446

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

1447

1448

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

1449

1450

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

1451

1452

(% style="color:#000000" %)В заголовках запроса:

1453

1454

(% style="color:#000000" %)− Content-Type: __**application/json**__

1455

1456

(% style="color:#000000" %)− X-Auth: Токен авторизации

1457

1458

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1459

1460

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1461

1462

{

1463

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1464

"name": null, ~/~/ Имя ТС (string, опционально)

1465

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1466

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1467

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1468

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1469

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1470

"customFields": null ~/~/ значение любого из произвольных полей ТС

1471

}

1472

1473

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1474

1475

(% style="color:#000000" %)Ответ:

1476

1477

(% style="color:#000000" %){

1478

1479

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1480

"name": "" ~/~/ наименование объекта

1481

"imei": "" ~/~/ IMEI объекта

1482

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1483

"deviceTypeName": "" ~/~/ наименование типа устройства

1484

"sim1": "" ~/~/ первый номер телефона

1485

"sim2": "" ~/~/ второй номер телефона

1486

"parentId": "" ~/~/ идентификатор клиента-родителя

1487

"parentName": "" ~/~/ наименование клиента-родителя

1488

"modelId": "" ~/~/ идентификатор модели объекта

1489

"modelName": "" ~/~/ наименование модели объекта

1490

"unitId": "" ~/~/ идентификатор подразделения

1491

"unitName": "" ~/~/ наименование подразделения

1492

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1493

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1494

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1495

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1496

"customFields": [

1497

{

1498

"id": "", ~/~/ идентификатор произвольного поля

1499

"name": "", ~/~/ имя произвольного поля

1500

"value": "", ~/~/ значение произвольного поля

1501

"forClient": true, ~/~/ право на отображение у клиента

1502

"forTooltip": false, ~/~/ право на отображение в подсказке

1503

"forReport": false ~/~/ право на отображение в отчетах

1504

}(%%)

1505

(% style="color:#000000" %)}

1506

1507

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1508

1509

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1510

1511

(% class="box successmessage" %)

1512

(((

1513

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1514

)))

1515

1516

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1517

1518

(% style="color:#000000" %)Метод запроса: **POST**

1519

1520

(% 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}

1521

1522

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1523

1524

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1525

1526

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1527

1528

(% style="color:#000000" %){

1529

1530

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1531

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1532

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1533

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1534

"description": "", ~/~/ Описание

1535

"data": "", ~/~/ Данные

1536

"overwrite": false, ~/~/ Флаг перезаписи

1537

"stage": "", ~/~/ Состояние, может быть null

1538

1539

(% style="color:#000000" %)}

1540

1541

(% style="color:#000000" %)Ответ:

1542

1543

(% style="color:#000000" %){

1544

1545

"status": "", ~/~/ значение статуса

1546

"date": "", ~/~/ Дата смены статуса

1547

"description": "", ~/~/ Описание

1548

"data": "", ~/~/ Данные

1549

"overwrite": false, ~/~/ Флаг перезаписи

1550

"stage": "", ~/~/ Состояние

1551

1552

(% style="text-align:left" %)

1553

(% style="color:#000000" %) }

1554

1555

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1556

1557

(% class="box warningmessage" %)

1558

(((

1559

(% lang="en-US" %)**PUT /api/v3/vehicles**

1560

)))

1561

1562

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1563

1564

(% style="color:#000000" %)Метод запроса: **PUT**

1565

1566

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1567

1568

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1569

1570

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1571

1572

(% style="color:#000000" %){

1573

"vehicleId": , ~/~/ ID объекта

1574

"parentId": "" , ~/~/ ID клиента

1575

"name": "" , ~/~/ имя ТС

1576

"imei": "" , ~/~/ IMEI

1577

"deviceTypeId": "" , ~/~/ ID типа устройства

1578

"modelId": "" , ~/~/ ID модели

1579

"unitId": "" , ~/~/ ID подразделения

1580

"sim1": "" , ~/~/ Номер SIM 1

1581

"sim2": "" , ~/~/ Номер SIM2

1582

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1583

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1584

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1585

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1586

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1587

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1588

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1589

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1590

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1591

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1592

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1593

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1594

1595

"mileageCalcMethod": 0,

1596

"mileageCoeff": 0,

1597

"locationByCellId": true,

1598

"dottedLineTrackWhenNoCoords": true,

1599

"counters": ~/~/ счетчики

1600

{

1601

"mileage": "" , ~/~/ пробег

1602

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1603

"motohours": "" , ~/~/ моточасы

1604

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1605

},

1606

"cmsv6Parameters": { ~/~/ параметры CMSv6

1607

"enabled": true, ~/~/ флаг включения

1608

"id": "" , ~/~/ идентификатор

1609

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1610

"login": "" , ~/~/ имя учетной записи

1611

"password": "" ~/~/ пароль учетной записи

1612

},

1613

"inspectionTasks": ~/~/ задания на ТО

1614

{

1615

"enabled": "" , ~/~/ Признак включения

1616

"name": "" , ~/~/ Имя задания

1617

"description": "" , ~/~/ Описание задания

1618

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1619

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1620

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1621

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1622

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1623

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1624

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1625

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1626

}

1627

1628

"drivers": [ ~/~/ Водители

1629

{

1630

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1635

{

1636

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1644

{

1645

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1646

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1647

"type": 0, ~/~/ Тип датчика

1648

"name": "string", ~/~/ Имя датчика

1649

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1650

"inputNumber": 0, ~/~/ Номер входа

1651

"pseudonym": "string", ~/~/ Псевдоним

1652

"medianDegree": 0, ~/~/ Медианная фильтрация

1653

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1654

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1655

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1656

"gradesTables": [ ~/~/ Массив таблиц тарировки

1657

{

1658

"grades": [ ~/~/ Таблица тарировки 1

1659

{

1660

"input": 0, ~/~/ Входящее значение

1661

"output": 0 ~/~/ Выходящее значение

1662

}

1663

],

1664

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1665

}

1666

],

1667

"showInTooltip": true, ~/~/ Отображать в подсказке

1668

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1669

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1670

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1671

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1672

"expr": "string", ~/~/ Формула

1673

"children": [ ~/~/ массив дочерних датчиков

1674

"string"

1675

],

1676

"customParams": { ~/~/ прочие произвольные параметры

1677

"additionalProp1": "string",

1678

"additionalProp2": "string",

1679

"additionalProp3": "string"

1680

},

1681

1682

~/~/ Характерные для произвольного:

1683

1684

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1685

1686

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1687

1688

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1689

1690

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1691

1692

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1693

1694

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1695

1696

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1697

1698

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1699

1700

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1701

1702

~/~/ "ValueOn": "Вкл.",

1703

1704

~/~/ "ValueOff": "Выкл."

1705

"summaryMaxValue": 0 ~/~/ Макс. значение

1706

}

1707

],

1708

"customFields": [ ~/~/ Произвольные поля

1709

{

1710

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1721

1722

(% lang="en-US" style="text-align:left" %)

1723

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1724

1725

(% lang="en-US" style="text-align:left" %)

1726

"vehicleId": "", ~/~/ ID ТС

1727

"parentId": "", ~/~/ ID клиента

1728

"name": "", ~/~/ имя ТС

1729

"imei": "", ~/~/ IMEI

1730

"deviceTypeId": "", ~/~/ типа устройства

1731

"modelId": "", ~/~/ ID модели

1732

"unitId": "", ~/~/ ID подразделения

1733

"sim1": "", ~/~/ SIM 1

1734

"sim2": "", ~/~/ SIM2

1735

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1736

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1737

"counters":

1738

{

1739

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1740

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1741

"mileage": "", ~/~/ пробег

1742

"motohours": "", ~/~/ моточасы

1743

}

1744

"cmsv6Parameters": ~/~/ параметры CMSv6

1745

{

1746

"id": ~/~/ идентификатор

1747

"enabled": true, ~/~/ флаг включения

1748

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1749

"login": "", ~/~/ имя учетной записи

1750

"password": "", ~/~/ пароль учетной записи

1751

}

1752

"inspectionTasks": ~/~/ задания на ТО

1753

{

1754

"id": "", ~/~/ ID задания

1755

"enabled": false, ~/~/ Признак включения

1756

"name": "", ~/~/ Имя задания

1757

"description": "", ~/~/ Описание задания

1758

"mileageCondition": "", ~/~/ Условие по пробегу

1759

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1760

"motohoursCondition": "", ~/~/ Условие по моточасам

1761

"lastMotohours": "", ~/~/ Моточасы

1762

"periodicCondition": "", ~/~/ Условие периодичности по времени

1763

"kind": "", ~/~/ Вид периодичности по времени

1764

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1765

}

1766

1767

(% lang="en-US" style="text-align:left" %)

1768

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1769

1770

**Валидация:**

1771

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1772

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1773

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1774

1775

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1776

1777

(% class="box errormessage" %)

1778

(((

1779

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1780

)))

1781

1782

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1783

1784

(% style="color:#000000" %)Метод запроса: **DELETE**

1785

1786

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1787

1788

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1789

1790

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1791

1792

(% style="text-align:left" %)

1793

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1794

1795

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1796

1797

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1798

1799

(% class="box infomessage" %)

1800

(((

1801

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1802

)))

1803

1804

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1805

1806

(% style="color:#000000" %)Метод запроса: **GET**

1807

1808

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

1809

1810

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1811

1812

(% style="color:#000000" %)Ответ:

1813

1814

(% style="color:#000000" %){

1815

1816

"deviceTypeId" : "", ~/~/ ID типа устройства

1817

"deviceTypeName" : "" ~/~/ Название типа устройства

1818

1819

(% style="text-align:left" %)

1820

(% style="color:#000000" %)}

1821

1822

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1823

1824

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1825

1826

(% class="box infomessage" %)

1827

(((

1828

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1829

)))

1830

1831

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1832

1833

(% style="color:#000000" %)Метод запроса: **GET**

1834

1835

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1836

1837

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1838

1839

(% style="color:#000000" %)Ответ:

1840

1841

(% style="color:#000000" %){

1842

1843

"id": "", ~/~/ ID типа датчика

1844

"name": "", ~/~/ Название

1845

"description": "", ~/~/ Описание

1846

1847

(% style="text-align:left" %)

1848

(% style="color:#000000" %)}

1849

1850

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1851

1852

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1853

1854

(% class="box infomessage" style="text-align: left;" %)

1855

(((

1856

**POST /api/v3/terminalMessages/count**

1857

)))

1858

1859

(% style="text-align: left;" %)

1860

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1861

1862

(% style="text-align: left;" %)

1863

Метод запроса **POST**

1864

1865

(% style="text-align: left;" %)

1866

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1867

1868

(% style="text-align: left;" %)

1869

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1870

1871

(% style="text-align: left;" %)

1872

{

1873

"vehicleIds": [

1874

id ~/~/ здесь передается список идентификаторов объектов

1875

],

1876

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1877

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1878

}

1879

1880

(% style="text-align: left;" %)

1881

Ответ:

1882

1883

(% style="text-align: left;" %)

1884

[

1885

{

1886

"vehicleId": 0, ~/~/ идентификатор объекта

1887

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1892

1893

(% class="box infomessage" style="text-align: left;" %)

1894

(((

1895

**POST /api/v3/terminalMessages/mapping**

1896

)))

1897

1898

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

1899

1900

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

1901

1902

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

{

"protocolType": 0,

"params": ["string"]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1910

|protocolType|ID типа протокола

1911

|params|(((

1912

Массив наименований параметров в сообщении

)))

Ответ:

{

"protocolType": 0,

"mapping": {

"additionalProp1": {

"inputType": 0,

"inputNumber": 0

},

"additionalProp2": {

"inputType": 0,

"inputNumber": 0

}

}

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1932

|protocolType|Тип протокола

1933

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

1939

Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]

1940

1941

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

1942

1943

(% class="box infomessage" %)

1944

(((

1945

**POST /api/v3/terminalMessages**

1946

)))

1947

1948

Метод возвращает список сообщений терминала объекта за выбранный период.

1949

1950

(% style="text-align: left;" %)

1951

Метод запроса **POST**

1952

1953

(% style="text-align: left;" %)

1954

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

1955

1956

(% style="text-align: left;" %)

1957

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1958

1959

{

1960

"vehicleId": 0, ~/~/ id объекта

1961

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

1962

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

1963

}

1964

1965

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1966

|vehicleId|ID объекта

1967

|from|Дата и время начала периода запроса

1968

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

1977

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

1987

"additionalProp2": "string",

1988

"additionalProp3": "string"

1989

},

1990

"photoCount": 0,

1991

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1999

|deviceTime|Время сообщения терминала

2000

|serverTime|Время когда сообщение поступило на сервер

2001

|speed|Скорость

2002

|altitude|Высота над уровнем моря

2003

|latitude|Широта

2004

|longitude|Долгота

2005

|satellites|Кол-во спутников

2006

|course|Курс

2007

|voltage|Бортовое напряжение

2008

|parameters|Список параметров и их значений

2009

|photoCount|Количество фото

2010

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2011

|protocolType|ID типа протокола

2012

2013

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2014

2015

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2016

2017

(% class="box infomessage" %)

2018

(((

2019

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2020

)))

2021

2022

(% style="color:#000000" %)Метод запроса: **POST**

2023

2024

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2025

2026

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2027

2028

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2033

"vehicleIds": [0], ~/~/ Список ID объектов

2034

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2035

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2036

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2044

"name": "string", ~/~/ Имя ТС

2045

"periods": [ ~/~/ Периоды

2046

{

2047

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2048

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2049

"mileageBegin": 0, ~/~/ Пробег на начало периода

2050

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2051

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2052

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2059

2060

(% class="box infomessage" %)

2061

(((

2062

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2063

)))

2064

2065

(% style="color:#000000" %)Метод запроса: **POST**

2066

2067

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2068

2069

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2070

2071

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2076

"vehicleIds": [0], ~/~/ Список ID объектов

2077

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2078

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2079

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2087

"name": "string", ~/~/ Имя ТС

2088

"periods": [ ~/~/ Периоды

2089

{

2090

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2091

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2092

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2093

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2094

"fuelConsumption": 0, ~/~/ Расход топлива

2095

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2102

2103

(% class="box infomessage" %)

2104

(((

2105

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2106

)))

2107

2108

(% style="color:#000000" %)Метод запроса: **POST**

2109

2110

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2111

2112

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2113

2114

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2119

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2120

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2121

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2129

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2130

"vehicleId": 0, ~/~/ ID объекта

2131

"name": "string", ~/~/ Имя объекта

2132

"model": "string", ~/~/ Модель объекта

2133

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2134

{

2135

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2136

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2137

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2138

"valueFuel": 0, ~/~/ Количество

2139

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2140

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2148

2149

(% class="box infomessage" %)

2150

(((

2151

**POST /api/v3/vehicles/moveStop**

2152

)))

2153

2154

Метод запроса: **POST**

2155

2156

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2157

2158

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2166

2167

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2168

2169

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2170

2171

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2182

2183

"vehicleName": "string", ~/~/ Имя объекта

2184

2185

"moves": [ ~/~/ Событие движения

{

"mileage": 0, ~/~/ Пробег, км

2190

2191

"eventId": 0, ~/~/ Идентификатор события

2192

2193

"eventName": "string", ~/~/ Название события

2194

2195

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2196

2197

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2198

2199

"duration": 0 ~/~/ Продолжительность события, секунд

}

],

"stops": [ ~/~/ События стоянок

{

"address": "string", ~/~/ Адрес события

2210

2211

"eventId": 0, ~/~/ Идентификатор события

2212

2213

"eventName": "string", ~/~/ Название события

2214

2215

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2216

2217

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2218

2219

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2233

2234

(% class="box infomessage" %)

2235

(((

2236

**POST /api/v3/vehicles/getlastdata**

2237

)))

2238

2239

Метод запроса: **POST**

2240

2241

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2242

2243

В заголовках запроса: X-Auth: Токен авторизации

2244

2245

2246

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2251

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2252

"vehicleNumber": "string",~/~/Номер объекта.

2253

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2254

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2255

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2256

"speed": 0,~/~/Скорость объекта.

2257

"course": 0,~/~/Курс движения [0;360]

2258

"latitude": 0,~/~/Широта [-90°;90°].

2259

"longitude": 0,~/~/Долгота [-180°;180°].

2260

"address": "string",~/~/Адрес.

2261

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2270

2271

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2272

2273

(% class="box infomessage" %)

2274

(((

2275

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2276

)))

2277

2278

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2279

2280

(% style="color:#000000" %)Метод запроса: **POST**

2281

2282

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2283

2284

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2285

2286

(% style="text-align:left" %)

2287

Тело запроса:

2288

2289

(% style="text-align:left" %)

2290

{

2291

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2292

}

2293

2294

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2300

"name": "string", ~/~/ Название объекта геозоны

2301

"type": 0, ~/~/ Тип объекта геозоны

2302

"fname": "string", ~/~/ Имя файла

2303

"parentId": "string", ~/~/ Идентификатор клиента

2304

"radius": 0, ~/~/ Радиус геообъекта

2305

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2306

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2307

"description": "string", ~/~/ Описание

2308

"area": 0, ~/~/ Площадь, м^^2^^

2309

"perimetr": 0, ~/~/ Периметр, м

2310

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2315

2316

(% class="box infomessage" %)

2317

(((

2318

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2319

)))

2320

2321

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2322

2323

(% style="color:#000000" %)Метод запроса: **POST**

2324

2325

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2326

2327

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2328

2329

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2334

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2335

"ids": [ ], ~/~/ Массив id объектов

2336

"byTime": 0, ~/~/ Объединение событий по времени

2337

"byDist": 0, ~/~/ Объединение событий по расстоянию

2338

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2339

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2346

"geozoneName": "string", ~/~/ Название геообъекта

2347

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2348

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2349

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2350

"vehicleId": 0, ~/~/ ID объекта

2351

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2356

2357

(% class="box infomessage" %)

2358

(((

2359

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2360

)))

2361

2362

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2363

2364

(% style="color:#000000" %)Метод запроса: **POST**

2365

2366

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2367

2368

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2369

2370

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2375

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2376

"ids": [ ], ~/~/ Массив id геообъектов

2377

"byTime": 0, ~/~/ Объединение событий по времени

2378

"byDist": 0, ~/~/ Объединение событий по расстоянию

2379

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2380

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2388

"geozoneName": "string", ~/~/ Название геообъекта

2389

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2390

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2391

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2392

"vehicleId": 0, ~/~/ ID объекта

2393

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2398

2399

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2400

2401

(% class="box infomessage" %)

2402

(((

2403

**POST /api/v3/notifications/find**

2404

)))

2405

2406

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2407

2408

(% style="text-align: left;" %)

2409

Метод запроса **POST**

2410

2411

(% style="text-align: left;" %)

2412

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2413

2414

(% style="text-align: left;" %)

2415

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2416

2417

{

2418

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2426

"name": "string", ~/~/ Название уведомления

2427

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2428

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2429

"userId": "", ~/~/ Пользователь, создавший уведомление

2430

"parentId": "", ~/~/ Идентификатор клиента

2431

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2436

2437

(% class="box infomessage" %)

2438

(((

2439

**GET /api/v3/notifications/{id}**

2440

)))

2441

2442

Метод возвращает данные правил формирования выбранного уведомления.

2443

2444

(% style="text-align: left;" %)

2445

Метод запроса **GET**

2446

2447

(% style="text-align: left;" %)

2448

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2449

2450

(% style="text-align: left;" %)

2451

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2452

2453

(% style="text-align: left;" %)

2454

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2455

2456

(% style="text-align: left;" %)

2457

(% style="color:#000000" %)Ответ:

2458

2459

(% style="text-align: left;" %)

2460

(% style="color:#000000" %){

2461

"id": 0, ~/~/ (%%)id уведомления

2462

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2463

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2464

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2465

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2466

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2467

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2468

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2469

(% style="color:#000000" %) 0

2470

],

2471

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2472

(% style="color:#000000" %) 0

2473

],

2474

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2475

(% style="color:#000000" %) 0

2476

],

2477

"settings": { ~/~/ Список параметров уведомления

2478

"additionalProp1": "string",

2479

"additionalProp2": "string",

2480

"additionalProp3": "string"

2481

},

2482

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2483

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2484

(% style="color:#000000" %) ""

2485

],

2486

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2487

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2488

(% style="color:#000000" %) "string"

2489

],

2490

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2491

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2492

(% style="color:#000000" %) {

2493

"id": 0, ~/~/ (%%)Идентификатор участника чата

2494

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2495

(% style="color:#000000" %) }

2496

],

2497

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2498

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2499

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2500

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2501

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2502

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2503

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2504

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2505

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2506

(% style="color:#000000" %)}

2507

2508

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2509

2510

(% class="box warningmessage" %)

2511

(((

2512

**PUT /api/v3/notifications/**

2513

)))

2514

2515

Метод позволяет отредактировать уведомление.

2516

2517

Метод запроса **PUT**

2518

2519

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2520

2521

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2526

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2527

"userId": "", ~/~/ Пользователь, создавший уведомление

2528

"parentId": "", ~/~/ Идентификатор клиента

2529

"parentName": "string", ~/~/ Имя клиента

2530

"name": "string", ~/~/ Название уведомления

2531

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2532

"vehicleIds": [ ~/~/ Список id объектов для анализа

2533

0

2534

],

2535

"geoids": [ ~/~/ Список id геообъектов для анализа

2536

0

2537

],

2538

"fieldids": [ ~/~/ Список id полей для анализа

2539

0

2540

],

2541

"settings": { ~/~/ Список параметров уведомления

2542

"additionalProp1": "string",

2543

"additionalProp2": "string",

2544

"additionalProp3": "string"

2545

},

2546

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2547

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2548

""

2549

],

2550

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2551

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2552

"string"

2553

],

2554

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2555

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2556

{

2557

"id": 0, ~/~/ Идентификатор участника чата

2558

"info": "string" ~/~/ Дополнительные сведения

2559

}

2560

],

2561

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2562

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2563

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2564

"kind": 0, ~/~/ Определяет вид уведомления

2565

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2566

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2567

"timezone": 0, ~/~/ Сдвиг часового пояса

2568

"validity": 0, ~/~/ Срок действия в днях (1-90)

2569

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2577

2578

(% class="box errormessage" %)

2579

(((

2580

**DELETE /api/v3/notifications/{id}**

2581

)))

2582

2583

Метод позволяет удалить выбранное уведомление.

2584

2585

Метод запроса **DELETE**

2586

2587

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2588

2589

Передаваемый параметр: {id} - id уведомления

2590

2591

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2599

2600

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2601

2602

(% class="box infomessage" %)

2603

(((

2604

**POST /api/v3/Drivers/find**

2605

)))

2606

2607

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2614

"description": "string", ~/~/ Определяет описание

2615

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2616

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2617

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2618

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2619

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2620

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2625

2626

(% class="box infomessage" %)

2627

(((

2628

**GET /api/v3/Drivers/{driverGuid}**

2629

)))

2630

2631

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2637

"description": "string", ~/~/ Определяет описание

2638

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2639

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2640

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2641

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2642

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2643

"deleted": true ~/~/ Признак удаления

2644

}

2645

2646

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2647

2648

(% class="box successmessage" %)

2649

(((

2650

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2658

"hiredate": "2023-06-30T12:50:54.020Z",

2659

"chopdate": "2023-06-30T12:50:54.020Z",

2660

"exclusive": true,

2661

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2662

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2671

"hiredate": "2023-06-30T12:50:54.051Z",

2672

"chopdate": "2023-06-30T12:50:54.051Z",

2673

"exclusive": true,

2674

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2675

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2681

2682

(% class="box warningmessage" %)

2683

(((

2684

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2692

"hiredate": "2023-06-30T12:50:27.910Z",

2693

"chopdate": "2023-06-30T12:50:27.910Z",

2694

"exclusive": true,

2695

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2696

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2705

"hiredate": "2023-06-30T12:50:27.929Z",

2706

"chopdate": "2023-06-30T12:50:27.929Z",

2707

"exclusive": true,

2708

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2709

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2715

2716

(% class="box errormessage" %)

2717

(((

2718

**DELETE /api/v3/Drivers/{driverGuid}**

2719

)))

2720

2721

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2729

2730

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2731

2732

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2733

2734

(% class="box infomessage" %)

2735

(((

2736

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2744

],

2745

"BeginTime": "2023-06-30T12:49:04.365Z",

2746

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2755

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2756

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2757

"BeginTime": "2023-06-30T09:52:31.240Z",

2758

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2764

2765

(% class="box infomessage" %)

2766

(((

2767

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2777

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2786

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2787

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2788

"BeginTime": "2023-06-30T09:54:01.631Z",

2789

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2795

2796

(% class="box successmessage" %)

2797

(((

2798

**POST /api/v3/DriversVehiclesAssignments**

2799

)))

2800

2801

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2808

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2809

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2810

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2811

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2821

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2822

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2823

"BeginTime": "2023-06-30T11:04:46.903Z",

2824

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2830

2831

(% class="box warningmessage" %)

2832

(((

2833

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2842

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2843

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2844

"BeginTime": "2023-06-30T11:14:08.117Z",

2845

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2855

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2856

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2857

"BeginTime": "2023-06-30T11:14:53.349Z",

2858

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2864

2865

(% class="box errormessage" %)

2866

(((

2867

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2882

2883

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2884

2885

(% class="box infomessage" %)

2886

(((

2887

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2895

],

2896

"BeginTime": "2023-06-30T12:47:12.162Z",

2897

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2905

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2906

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2907

"BeginTime": "2023-06-30T11:19:40.703Z",

2908

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2914

2915

(% class="box infomessage" %)

2916

(((

2917

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2925

],

2926

"BeginTime": "2023-06-30T12:47:12.162Z",

2927

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2935

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2936

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2937

"BeginTime": "2023-06-30T11:19:40.703Z",

2938

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2944

2945

(% class="box successmessage" %)

2946

(((

2947

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2955

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2956

"BeginTime": "2023-06-30T11:27:08.635Z",

2957

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2966

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2967

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2968

"BeginTime": "2023-06-30T11:27:08.677Z",

2969

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

2975

2976

(% class="box warningmessage" %)

2977

(((

2978

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2986

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2987

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2988

"BeginTime": "2023-06-30T11:28:43.330Z",

2989

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2998

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2999

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3000

"BeginTime": "2023-06-30T11:28:43.331Z",

3001

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3007

3008

(% class="box errormessage" %)

3009

(((

3010

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3025

3026

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3027

3028

(% class="box infomessage" %)

3029

(((

3030

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3038

],

3039

"BeginTime": "2023-06-30T12:45:10.852Z",

3040

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3048

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3049

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3050

"BeginTime": "2023-06-30T11:58:04.695Z",

3051

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3057

3058

(% class="box infomessage" %)

3059

(((

3060

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3068

],

3069

"BeginTime": "2023-06-30T12:45:10.852Z",

3070

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3078

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3079

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3080

"BeginTime": "2023-06-30T11:58:04.695Z",

3081

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3087

3088

(% class="box successmessage" %)

3089

(((

3090

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3098

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3099

"BeginTime": "2023-06-30T12:09:53.175Z",

3100

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3109

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3110

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3111

"BeginTime": "2023-06-30T12:09:53.201Z",

3112

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3118

3119

(% class="box warningmessage" %)

3120

(((

3121

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3129

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3130

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3131

"BeginTime": "2023-06-30T12:09:53.201Z",

3132

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3141

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3142

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3143

"BeginTime": "2023-06-30T12:09:53.201Z",

3144

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3150

3151

(% class="box errormessage" %)

3152

(((

3153

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3168

3169

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3170

3171

(% class="box infomessage" %)

3172

(((

3173

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3180

"endDate": "2023-11-14T10:48:03.671Z",

"ids": [ 0 ],

"timezone": 0

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3186

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3187

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3188

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3189

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3196

"ED": "2023-11-14T10:48:03.717Z",

"id": 0,

"SLat": 0,

"SLon": 0,

"ELat": 0,

"ELon": 0,

"mileage": 0

"Duration": 0

"Address": "string",

"Address2": "string",

3206

"name": "string",

3207

"rid": "string",

3208

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3209

"trailer": {

3210

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3211

"Number": "string",

3212

"Description": "string",

3213

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3214

"ExternalID": "string",

3215

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3216

"CreateTime": "2023-11-14T10:48:03.717Z",

3217

"UpdateTime": "2023-11-14T10:48:03.717Z",

"IsDeleted": true

},

"filesCount": 0,

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3225

|SD|Дата и время начала события

3226

|ED|Дата и время окончания события

3227

|id|ID объекта

3228

|SLat|Широта начальной координаты

3229

|SLon|Долгота начальной координаты

3230

|ELat|Широта конечной координаты

3231

|ELon|Долгота конечной координаты

3232

|mileage|Пробег

3233

|Duration|Продолжительность

3234

|Address|Адрес начального местоположения

3235

|Address2|Адрес конечного местоположения

3236

|name|Имя радиометки

3237

|rid|Номер радиометки

3238

|rguid|ID радиометки

3239

|trailer|Информация об агрегате

3240

|ModelGuid|ID агрегата

3241

|Number|Название/номер агрегата

3242

|Description|Текст примечания агрегата

3243

3244

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3245

3246

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3247

3248

(% class="box infomessage" %)

3249

(((

3250

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3267

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3272

|parentId|ID клиента

3273

|name|Название карты-метки

3274

|number|Номер

3275

|period|Период запросов в секундах (работает только для агрегатов)

3276

|id|ID карты-метки

3277

3278

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3279

3280

(% class="box infomessage" %)

3281

(((

3282

**GET /api/v3/Rfids/{rfidGuid}**

3283

)))

3284

3285

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3295

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3300

|name|Название карты-метки

3301

|number|Номер

3302

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3307

3308

(% class="box successmessage" %)

3309

(((

3310

**POST /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3329

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3330

}

3331

3332

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3333

|name|Название карты-метки

3334

|number|Номер

3335

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3340

3341

(% class="box warningmessage" %)

3342

(((

3343

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3353

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3363

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3364

}

3365

3366

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3367

|name|Название карты-метки

3368

|number|Номер

3369

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3374

3375

(% class="box errormessage" %)

3376

(((

3377

**DELETE /api/v3/Rfids/{rfidGuid}**

3378

)))

3379

3380

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3388

3389

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3390

3391

(% class="box infomessage" %)

3392

(((

3393

**GET /api/v3/Billing/client/balance/{clientId}**

3394

)))

3395

3396

Параметр запроса: **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);" %)**Описание**

3406

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3407

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3408

3409

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3410

3411

(% class="box infomessage" %)

3412

(((

3413

**GET /api/v3/Billing/client/constraint/{clientId}**

3414

)))

3415

3416

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3422

"CalculationType": 0,

3423

"PermissibleBalance": 0,

3424

"DefermentDays": 0,

3425

"SendUiNotifications": true,

3426

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3431

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3432

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3433

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3434

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3435

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3436

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3437

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3438

3439

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3440

3441

(% class="box infomessage" %)

3442

(((

3443

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3449

3450

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3456

"Plan": { **~/~/ Описание тарифного плана**

3457

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3458

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3463

"PermissibleBalance": 0,

3464

"DefermentDays": 0

3465

},

3466

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3478

"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);" %)**Описание**

3494

|ClientId|Идентификатор клиента

3495

|Id|Идентификатор тарифного плана

3496

|OwnerId|Идентификатор клиента-владельца

3497

|Name|Наименование тарифного плана

3498

|IsArchived|Признак, определяющий архивный тарифный план

3499

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3500

|PermissibleBalance|Допустимый баланс

3501

|DefermentDays|Отсрочка, количество дней

3502

|Feature|Код услуги

3503

|IsEnabled|Признак, определяющий активирована ли услуга

3504

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3505

|IsFactual|Признак, определяющий расчёт по факту

3506

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3507

|Price|Цена за единицу.

3508

|DebitDate|Следующий момент времени списания с баланса за услугу.

3509

|PeriodValue|Значение периода.

3510

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3511

3512

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3513

3514

(% class="box infomessage" %)

3515

(((

3516

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3517

)))

3518

3519

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3526

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3531

"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);" %)**Описание**

3548

|ClientId|Идентификатор клиента

3549

|Id|Идентификатор тарифного плана

3550

|OwnerId|Идентификатор клиента-владельца

3551

|Name|Наименование тарифного плана

3552

|IsArchived|Признак, определяющий архивный тарифный план

3553

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3554

|PermissibleBalance|Допустимый баланс

3555

|DefermentDays|Отсрочка, количество дней

3556

|Feature|Код услуги

3557

|IsFactual|Признак, определяющий расчёт по факту

3558

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3559

|Price|Цена за единицу.

3560

|PeriodValue|Значение периода.

3561

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3562

3563

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3564

3565

(% class="box infomessage" %)

3566

(((

3567

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3568

)))

3569

3570

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3577

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3582

"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);" %)**Описание**

3599

|ClientId|Идентификатор клиента

3600

|Id|Идентификатор тарифного плана

3601

|OwnerId|Идентификатор клиента-владельца

3602

|Name|Наименование тарифного плана

3603

|IsArchived|Признак, определяющий архивный тарифный план

3604

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3605

|PermissibleBalance|Допустимый баланс

3606

|DefermentDays|Отсрочка, количество дней

3607

|Feature|Код услуги

3608

|IsFactual|Признак, определяющий расчёт по факту

3609

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3610

|Price|Цена за единицу.

3611

|PeriodValue|Значение периода.

3612

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3613

3614

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3615

3616

(% class="box warningmessage" %)

3617

(((

3618

**PUT /api/v3/Billing/client/balance**

3619

)))

3620

3621

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3633

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3634

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3635

3636

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3637

3638

(% class="box warningmessage" %)

3639

(((

3640

**PUT /api/v3/billing/client/balance/deposit**

3641

)))

3642

3643

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3655

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3656

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3657

3658

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3659

3660

Создает операцию **Списание **с указанной суммой

3661

3662

(% class="box warningmessage" %)

3663

(((

3664

**PUT /api/v3/billing/client/balance/withdraw**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Balance": 0

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3677

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3678

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3679

3680

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3681

3682

(% class="box warningmessage" %)

3683

(((

3684

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3691

"CalculationType": 0,

3692

"PermissibleBalance": 0,

3693

"DefermentDays": 0,

3694

"SendUiNotifications": true,

3695

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3702

|ClientId|Идентификатор клиента

3703

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3704

|PermissibleBalance|Допустимый баланс

3705

|DefermentDays|(((

3706

Отсрочка, количество дней

3707

)))

3708

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3709

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3710

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3711

3712

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3713

3714

(% class="box warningmessage" %)

3715

(((

3716

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3723

"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);" %)**Описание**

3741

|ClientId|Идентификатор клиента

3742

|PlanId|Идентификатор тарифного плана

3743

|Feature|Код услуги

3744

|IsEnabled|Признак, определяющий активирована ли услуга

3745

|IsFactual|Признак, определяющий расчёт по факту

3746

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3747

|Price|Цена за единицу.

3748

|DebitDate|Следующий момент времени списания с баланса за услугу.

3749

|PeriodValue|Значение периода.

3750

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3751

3752

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3753

3754

(% class="box warningmessage" %)

3755

(((

3756

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3757

)))

3758

3759

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3760

3761

(% class="box infomessage" %)

3762

(((

3763

**POST /api/v3/vehicles/import/{agentId}**

3764

)))

3765

3766

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3767

3768

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3777

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3778

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3779

3780

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3785

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3786

|csv|В значении передаем файл датчиков, формат **csv**

Ответ:

{

"vehicleId": 0,

"name": "string",

"errors": ["string"]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3797

|vehicleId|ID созданного объекта

3798

|name|Имя созданного объекта

3799

|errors|Ошибки и их описание

3800

3801

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3802

3803

(% class="box infomessage" %)

3804

(((

3805

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3806

)))

3807

3808

(% class="wikigeneratedid" %)

3809

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3810

3811

(% class="wikigeneratedid" %)

3812

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3817

3818

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3823

|**history**|В значении передавать файл с историей

3824

3825

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3838

"lastMessageDate": "2023-11-28T09:27:58.949Z",

"producedCount": 0,

"msgCount": 0

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3846

|results|Результаты импорта в разрезе ТС

3847

|vehicleGuid|Guid ТС

3848

|vehicleId|ID ТС

3849

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3850

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3851

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3852

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3853

|msgCount|Кол-во обработанных сообщений всего

3854

3855

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3856

3857

(% class="box infomessage" %)

3858

(((

3859

**GET /api/v3/vehicles/import/history/status**

3860

)))

3861

3862

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3873

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3874

|progress|Guid ТС

3875

3876

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3877

3878

(% class="box infomessage" %)

3879

(((

3880

**POST /api/v3/vehicles/export**

3881

)))

3882

3883

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3892

3893

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3894

3895

(% class="box infomessage" %)

3896

(((

3897

**POST /api/v3/vehicles/export/history**

3898

)))

3899

3900

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3908

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3914

3915

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3916

|vehicleId|ID объекта

3917

|asArchive|true - Архивировать файл, False - не архивировать

3918

|from|Дата и время начала запроса

3919

|to|Дата и время окончания запроса

3920

3921

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3922

3923

(% class="box infomessage" %)

3924

(((

3925

**GET /api/v3/vehicles/export/history/status**

3926

)))

3927

3928

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3939

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3940

|progress|Прогресс экспорта, от 0 до 100%

3941

|message|Текст описывающий статус

3942

3943

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3944

3945

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

3946

3947

(% class="box infomessage" %)

3948

(((

3949

**POST /api/v3/EcoDriving/rating**

3950

)))

3951

3952

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3958

"from": "2023-11-22T09:29:48.051Z",

3959

"to": "2023-11-22T09:29:48.051Z"

3960

}

3961

3962

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3963

|vehicleIds|Массив ID объектов

3964

|from|Дата начала запроса

3965

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

3973

"to": "2023-11-22T09:29:48.052Z",

3974

"vehicleId": 0,

3975

"vehicleName": "string",

3976

"vehicleModel": "string",

3977

"penalty": 0,

3978

"score": 0,

3979

"totalViolations": 0,

3980

"violationsByType": {

3981

"overspeedingViolations": 0,

3982

"accelerationViolations": 0,

3983

"brakingViolations": 0,

3984

"turningViolations": 0,

3985

"dangerousDrivingViolations": 0,

3986

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

3996

"violationsByType": {

3997

"overspeedingViolations": 0,

3998

"accelerationViolations": 0,

3999

"brakingViolations": 0,

4000

"turningViolations": 0,

4001

"dangerousDrivingViolations": 0,

4002

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4009

"endAddress": "string",

4010

"drivers": [

4011

{

4012

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4013

"driverName": "string",

4014

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4024

|from|Дата начала запроса

4025

|to|Дата окончания

4026

|vehicleId|ID объекта

4027

|vehicleName|Имя объекта

4028

|vehicleModel|Модель объекта

4029

|penalty|Сумма штрафных баллов

4030

|score|Оценка

4031

|totalViolations|Суммарное количество нарушений

4032

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4033

|overspeedingViolations|Превышение скорости

4034

|accelerationViolations|Ускорение

4035

|brakingViolations|Торможение

4036

|turningViolations|Резкий поворот

4037

|dangerousDrivingViolations|Резкое вождение

4038

|sensorViolations|Нарушение по датчику

4039

|moveTime|Время в движении

4040

|mileage|Пробег

4041

|tripsCount|Количество рейсов

4042

|motohours|Моточасы

4043

|maxSpeed|Максимальная скорость

4044

|startAddress|Адрес начала рейса

4045

|endAddress|Адрес окончания рейса

4046

|drivers|Список водителей, которые были на объекте в течениии рейса

4047

|driverGuid|Guid водителя

4048

|driverName|Имя водителя

4049

|driverRfid|Номер Карты-метки

4050

4051

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4052

4053

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4054

4055

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4056

4057

(% class="box infomessage" %)

4058

(((

4059

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4065

\\В заголовках запроса: X-Auth: Токен авторизации

4066

4067

Параметры в теле запроса (JSON):

{

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4072

4073

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

"ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

],

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4090

4091

"driver": "string", ~/~/Водители, привязанные к ТК

4092

4093

"object": "string", ~/~/Наименование ТС

4094

4095

"amount": 0, ~/~/Количество топлива

4096

4097

"amountDut": 0, ~/~/Количество по ДУТ

4098

4099

"amountDiff": 0, ~/~/Разница, л

4100

4101

"amountDiffPerc": 0, ~/~/Разница, %

4102

4103

"summa": 0, ~/~/Стоимость, руб

4104

4105

"serviceName": "string", ~/~/Тип топлива

4106

4107

"price": 0, ~/~/Цена за литр, руб

4108

4109

"cardName": "string", ~/~/Наименование ТК

4110

4111

"cardNum": "string", ~/~/Номер ТК

4112

4113

"operator": "string", ~/~/Оператор ТК

4114

4115

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4120

4121

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4122

4123

4124

(% class="box infomessage" %)

4125

(((

4126

GET api/v3/Vehicles/recyclebin/all

4127

)))

4128

4129

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4130

4131

Параметр запроса: {parentId} - идентификатор агента

4132

4133

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC

4138

"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект

4139

"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента

4140

"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта

4141

"objectType": "Vehicle", - Тип объекта

4142

"details": {

4143

"items": [ {

4144

"name": "ObjectName", - наименование столбца

4145

"value": "01" - содержание столбца

},

{

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

4156

"hoppercapacity": 0,

4157

"hopperdischargespeed": 0,

4158

"modelType": 0,

4159

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4160

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4165

4166

(% class="box infomessage" %)

4167

(((

4168

POST/api/v3/Vehicles/recyclebin/erase

4169

)))

4170

4171

В заголовках запроса: X-Auth: Токен авторизации

4172

4173

Параметры в теле запроса (JSON):

4174

[

4175

"eb737fdf-c422-4df7-8727-bd61439b8460",

4176

"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"

4177

]

4178

4179

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4180

4181

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4182

4183

(% class="box infomessage" %)

4184

(((

4185

POST/api/v3/Vehicles/recyclebin/restore

4186

)))

4187

4188

В заголовках запроса: X-Auth: Токен авторизации

4189

4190

Параметры в теле запроса (JSON):

4191

[

4192

"eb737fdf-c422-4df7-8727-bd61439b8460",

4193

"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"

4194

]

4195

4196

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

(% class="box" lang="en-US" style="text-align: center;" %)

4201

(((

4202

(% 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]] **

4203

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню