Методы 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 - «Не эксплуатируется».

===== =====

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

1215

1216

(% class="box infomessage" %)

1217

(((

1218

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

1219

)))

1220

1221

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

1222

1223

1224

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

1225

1226

1227

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

1228

1229

1230

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

1231

1232

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

1233

1234

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

1235

1236

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

1237

1238

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

1239

1240

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

1241

1242

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

1243

1244

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

(((

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

1250

1251

(% class="box infomessage" %)

1252

(((

1253

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

1254

)))

1255

1256

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

1257

1258

1259

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

1260

1261

1262

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

[

{

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

1270

1271

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

1272

1273

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

1274

1275

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

1276

1277

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

1278

1279

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

1280

1281

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

}

]

)))

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

1291

1292

(% class="box successmessage" %)

1293

(((

1294

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

1295

)))

1296

1297

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

1298

1299

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

1300

1301

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

1302

1303

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

1304

1305

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

1306

1307

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

1308

1309

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

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

1330

"mileageCalcMethod": 0,

1331

"mileageCoeff": 0,

1332

"locationByCellId": true,

1333

"dottedLineTrackWhenNoCoords": true,

1334

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

1335

{

1336

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

1337

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

1338

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

1339

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

1340

},

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

},

1348

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

1349

{

1350

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

1351

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

1352

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

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

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

1361

}

1362

1363

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

1364

{

1365

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

"isDefault": true

}

],

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

1370

{

1371

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1379

{

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1390

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

1391

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

1392

{

1393

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

1394

{

1395

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

1396

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

1397

}

1398

],

1399

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

1400

}

1401

],

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

"string"

1410

],

1411

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

1412

"additionalProp1": "string",

1413

"additionalProp2": "string",

1414

"additionalProp3": "string"

1415

},

1416

1417

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

1418

1419

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

1420

1421

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

1422

1423

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

1424

1425

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

1426

1427

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

1428

1429

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

1430

1431

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

1432

1433

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

1434

1435

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

1436

1437

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

1438

1439

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

1440

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

1441

}

1442

],

1443

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

1444

{

1445

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1456

1457

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

1458

1459

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

1460

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

1461

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

1462

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

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

1469

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

1470

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

1471

"mileageEnabled": true,

1472

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1477

"id": null,

1478

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

1479

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

1480

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

1481

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

1482

},

1483

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

1484

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

1485

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

1486

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

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

1495

}

1496

1497

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

1498

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

1499

1500

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

1501

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

1502

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

1503

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

1504

1505

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

1506

1507

(% class="box infomessage" %)

1508

(((

1509

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

1510

)))

1511

1512

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

1513

1514

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

1515

1516

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

1517

1518

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

1519

1520

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

1521

1522

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

1523

1524

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

1525

1526

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

1527

1528

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

1529

1530

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

1531

1532

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

1533

1534

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

1535

1536

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

1537

1538

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

1539

1540

{

1541

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

1542

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

1543

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

1544

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

1545

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

1546

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

1547

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

1548

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

1549

}

1550

1551

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

1552

1553

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

1554

1555

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

1556

1557

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

1558

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

1559

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

1560

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

1561

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

1562

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

1563

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

1564

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

1565

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

1566

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

1567

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

1568

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

1569

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

1570

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

1571

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

1572

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

1573

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

1574

"customFields": [

1575

{

1576

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

1577

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

1578

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

1579

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

1580

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

1581

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

1582

}(%%)

1583

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

1584

1585

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

1586

1587

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

1588

1589

(% class="box successmessage" %)

1590

(((

1591

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

1592

)))

1593

1594

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

1595

1596

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

1597

1598

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

1599

1600

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

1601

1602

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

1603

1604

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

1605

1606

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

1607

1608

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

1609

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

1610

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

1611

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

1612

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

1613

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

1614

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

1615

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

1616

1617

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

1618

1619

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

1620

1621

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

1622

1623

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

1624

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

1625

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

1626

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

1627

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

1628

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

1629

1630

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

1631

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

1632

1633

(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)

1634

**Отправить команду на терминал**

1635

1636

(% class="box successmessage" %)

1637

(((

1638

(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**

1639

)))

1640

1641

Команда для отправки на тс.

{

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

1647

1648

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

1649

1650

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

1651

1652

"idTemplate": "" ~/~/ ID шаблона команды

}

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

1658

1659

(% class="box warningmessage" %)

1660

(((

1661

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

1662

)))

1663

1664

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

1665

1666

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

1667

1668

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

1669

1670

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

1671

1672

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

1673

1674

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

1675

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

1676

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

1677

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

1678

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

1679

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

1680

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

1681

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

1682

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

1683

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

1684

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

1685

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

1686

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

1687

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

1688

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

1689

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

1690

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

1691

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

1692

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

1693

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

1694

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

1695

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

1696

1697

"mileageCalcMethod": 0,

1698

"mileageCoeff": 0,

1699

"locationByCellId": true,

1700

"dottedLineTrackWhenNoCoords": true,

1701

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

1702

{

1703

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

1704

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

1705

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

1706

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

1707

},

1708

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

1709

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

1710

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

1711

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

1712

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

1713

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

1714

},

1715

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

1716

{

1717

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

1718

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

1719

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

1720

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

1721

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

1722

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

1723

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

1724

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

1725

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

1726

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

1727

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

1728

}

1729

1730

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

1731

{

1732

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

"isDefault": true

}

],

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

1737

{

1738

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1746

{

1747

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

1748

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

1749

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

1750

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

1751

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

1752

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

1753

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

1754

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

1755

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

1756

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

1757

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

1758

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

1759

{

1760

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

1761

{

1762

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

1763

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

1764

}

1765

],

1766

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

1767

}

1768

],

1769

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

1770

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

1771

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

1772

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

1773

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

1774

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

1775

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

1776

"string"

1777

],

1778

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

1779

"additionalProp1": "string",

1780

"additionalProp2": "string",

1781

"additionalProp3": "string"

1782

},

1783

1784

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

1785

1786

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

1787

1788

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

1789

1790

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

1791

1792

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

1793

1794

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

1795

1796

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

1797

1798

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

1799

1800

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

1801

1802

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

1803

1804

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

1805

1806

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

1807

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

1808

}

1809

],

1810

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

1811

{

1812

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1823

1824

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

1825

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

1826

1827

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

1828

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

1829

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

1830

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

1831

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

1832

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

1833

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

1834

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

1835

"sim1": "", ~/~/ SIM 1

1836

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

1837

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

1838

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

1839

"counters":

1840

{

1841

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

1842

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

1843

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

1844

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

1845

}

1846

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

1847

{

1848

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

1849

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

1850

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

1851

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

1852

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

1853

}

1854

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

1855

{

1856

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

1857

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

1858

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

1859

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

1860

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

1861

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

1862

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

1863

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

1864

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

1865

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

1866

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

1867

}

1868

1869

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

1870

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

1871

1872

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

1873

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

1874

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

1875

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

1876

1877

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

1878

1879

(% class="box errormessage" %)

1880

(((

1881

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

1882

)))

1883

1884

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

1885

1886

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

1887

1888

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

1889

1890

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

1891

1892

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

1893

1894

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

1895

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

1896

1897

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

1898

1899

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

1900

1901

(% class="box infomessage" %)

1902

(((

1903

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1904

)))

1905

1906

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

1907

1908

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

1909

1910

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

1911

1912

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

1913

1914

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

1915

1916

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

1917

1918

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

1919

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

1920

1921

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

1922

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

1923

1924

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

1925

1926

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

1927

1928

(% class="box infomessage" %)

1929

(((

1930

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1931

)))

1932

1933

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

1934

1935

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

1936

1937

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

1938

1939

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

1940

1941

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

1942

1943

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

1944

1945

"id": "", ~/~/ ID типа датчика

1946

"name": "", ~/~/ Название

1947

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

1948

1949

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

1950

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

1951

1952

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1953

1954

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

1955

1956

(% class="box infomessage" style="text-align: left;" %)

1957

(((

1958

**POST /api/v3/terminalMessages/count**

1959

)))

1960

1961

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

1962

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1963

1964

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

1965

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

1966

1967

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

1968

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

1969

1970

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

1971

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

1972

1973

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

1974

{

1975

"vehicleIds": [

1976

id ~/~/ здесь передается список идентификаторов объектов

1977

],

1978

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1979

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1980

}

1981

1982

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

1983

Ответ:

1984

1985

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

1986

[

1987

{

1988

"vehicleId": 0, ~/~/ идентификатор объекта

1989

"count": 0 ~/~/ количество сообщений за период

}

]

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

1994

1995

(% class="box infomessage" style="text-align: left;" %)

1996

(((

1997

**POST /api/v3/terminalMessages/mapping**

1998

)))

1999

2000

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

2001

2002

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

2003

2004

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

2012

|protocolType|ID типа протокола

2013

|params|(((

2014

Массив наименований параметров в сообщении

)))

Ответ:

{

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

2034

|protocolType|Тип протокола

2035

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2041

Перечень 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/]]

2042

2043

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2044

2045

(% class="box infomessage" %)

2046

(((

2047

**POST /api/v3/terminalMessages**

2048

)))

2049

2050

Метод возвращает список сообщений терминала объекта за выбранный период.

2051

2052

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

2053

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

2054

2055

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

2056

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

2057

2058

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

2059

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

2060

2061

{

2062

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

2063

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2064

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2065

}

2066

2067

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

2068

|vehicleId|ID объекта

2069

|from|Дата и время начала периода запроса

2070

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2079

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2089

"additionalProp2": "string",

2090

"additionalProp3": "string"

2091

},

2092

"photoCount": 0,

2093

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

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

2101

|deviceTime|Время сообщения терминала

2102

|serverTime|Время когда сообщение поступило на сервер

2103

|speed|Скорость

2104

|altitude|Высота над уровнем моря

2105

|latitude|Широта

2106

|longitude|Долгота

2107

|satellites|Кол-во спутников

2108

|course|Курс

2109

|voltage|Бортовое напряжение

2110

|parameters|Список параметров и их значений

2111

|photoCount|Количество фото

2112

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2113

|protocolType|ID типа протокола

2114

2115

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2116

2117

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

2118

2119

(% class="box infomessage" %)

2120

(((

2121

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2122

)))

2123

2124

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

2125

2126

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

2127

2128

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

2129

2130

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

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2135

"vehicleIds": [0], ~/~/ Список ID объектов

2136

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2137

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2138

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

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

2146

"name": "string", ~/~/ Имя ТС

2147

"periods": [ ~/~/ Периоды

2148

{

2149

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2150

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2151

"mileageBegin": 0, ~/~/ Пробег на начало периода

2152

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2153

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2154

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

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

2161

2162

(% class="box infomessage" %)

2163

(((

2164

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2165

)))

2166

2167

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

2168

2169

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

2170

2171

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

2172

2173

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

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2178

"vehicleIds": [0], ~/~/ Список ID объектов

2179

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2180

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2181

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

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

2189

"name": "string", ~/~/ Имя ТС

2190

"periods": [ ~/~/ Периоды

2191

{

2192

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2193

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2194

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2195

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2196

"fuelConsumption": 0, ~/~/ Расход топлива

2197

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

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

2204

2205

(% class="box infomessage" %)

2206

(((

2207

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2208

)))

2209

2210

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

2211

2212

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

2213

2214

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

2215

2216

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

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2221

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2222

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2223

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2231

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2232

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

2233

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

2234

"model": "string", ~/~/ Модель объекта

2235

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2236

{

2237

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2238

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2239

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2240

"valueFuel": 0, ~/~/ Количество

2241

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2242

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

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

2250

2251

(% class="box infomessage" %)

2252

(((

2253

**POST /api/v3/vehicles/moveStop**

2254

)))

2255

2256

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

2257

2258

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2259

2260

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

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2268

2269

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2270

2271

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2272

2273

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

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

2284

2285

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

2286

2287

"moves": [ ~/~/ Событие движения

{

"mileage": 0, ~/~/ Пробег, км

2292

2293

"eventId": 0, ~/~/ Идентификатор события

2294

2295

"eventName": "string", ~/~/ Название события

2296

2297

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2298

2299

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2300

2301

"duration": 0 ~/~/ Продолжительность события, секунд

}

],

"stops": [ ~/~/ События стоянок

{

"address": "string", ~/~/ Адрес события

2312

2313

"eventId": 0, ~/~/ Идентификатор события

2314

2315

"eventName": "string", ~/~/ Название события

2316

2317

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2318

2319

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2320

2321

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

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

2335

2336

(% class="box infomessage" %)

2337

(((

2338

**POST /api/v3/vehicles/getlastdata**

2339

)))

2340

2341

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

2342

2343

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2344

2345

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

2346

2347

2348

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2353

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2354

"vehicleNumber": "string",~/~/Номер объекта.

2355

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2356

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2357

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2358

"speed": 0,~/~/Скорость объекта.

2359

"course": 0,~/~/Курс движения [0;360]

2360

"latitude": 0,~/~/Широта [-90°;90°].

2361

"longitude": 0,~/~/Долгота [-180°;180°].

2362

"address": "string",~/~/Адрес.

2363

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2372

2373

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

2374

2375

(% class="box infomessage" %)

2376

(((

2377

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2378

)))

2379

2380

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

2381

2382

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

2383

2384

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

2385

2386

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

2387

2388

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

2389

Тело запроса:

2390

2391

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

2392

{

2393

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

2394

}

2395

2396

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

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2402

"name": "string", ~/~/ Название объекта геозоны

2403

"type": 0, ~/~/ Тип объекта геозоны

2404

"fname": "string", ~/~/ Имя файла

2405

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

2406

"radius": 0, ~/~/ Радиус геообъекта

2407

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2408

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2409

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

2410

"area": 0, ~/~/ Площадь, м^^2^^

2411

"perimetr": 0, ~/~/ Периметр, м

2412

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

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

2417

2418

(% class="box infomessage" %)

2419

(((

2420

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2421

)))

2422

2423

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

2424

2425

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

2426

2427

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

2428

2429

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

2430

2431

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

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2436

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2437

"ids": [ ], ~/~/ Массив id объектов

2438

"byTime": 0, ~/~/ Объединение событий по времени

2439

"byDist": 0, ~/~/ Объединение событий по расстоянию

2440

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2441

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2448

"geozoneName": "string", ~/~/ Название геообъекта

2449

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2450

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2451

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2452

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

2453

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2458

2459

(% class="box infomessage" %)

2460

(((

2461

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2462

)))

2463

2464

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

2465

2466

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

2467

2468

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

2469

2470

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

2471

2472

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

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2477

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2478

"ids": [ ], ~/~/ Массив id геообъектов

2479

"byTime": 0, ~/~/ Объединение событий по времени

2480

"byDist": 0, ~/~/ Объединение событий по расстоянию

2481

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2482

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2490

"geozoneName": "string", ~/~/ Название геообъекта

2491

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2492

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2493

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2494

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

2495

"vehicleName": "string" ~/~/ Имя объекта

}

]

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

2500

2501

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

2502

2503

(% class="box infomessage" %)

2504

(((

2505

**POST /api/v3/notifications/find**

2506

)))

2507

2508

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

2509

2510

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

2511

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

2512

2513

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

2514

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

2515

2516

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

2517

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

2518

2519

{

2520

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

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2528

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

2529

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2530

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2531

"userId": "", ~/~/ Пользователь, создавший уведомление

2532

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

2533

"parentName": "string" ~/~/ Имя клиента

}

]

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

2538

2539

(% class="box infomessage" %)

2540

(((

2541

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

2542

)))

2543

2544

Метод возвращает данные правил формирования выбранного уведомления.

2545

2546

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

2547

Метод запроса **GET**

2548

2549

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

2550

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

2551

2552

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

2553

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

2554

2555

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

2556

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

2557

2558

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

2559

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

2560

2561

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

2562

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

2563

"id": 0, ~/~/ (%%)id уведомления

2564

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2565

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2566

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

2567

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

2568

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2569

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2570

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2571

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

2572

],

2573

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2574

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

2575

],

2576

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2577

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

2578

],

2579

"settings": { ~/~/ Список параметров уведомления

2580

"additionalProp1": "string",

2581

"additionalProp2": "string",

2582

"additionalProp3": "string"

2583

},

2584

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2585

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2586

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

2587

],

2588

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2589

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2590

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

2591

],

2592

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2593

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2594

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

2595

"id": 0, ~/~/ (%%)Идентификатор участника чата

2596

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2597

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

2598

],

2599

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2600

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2601

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2602

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2603

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2604

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2605

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2606

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2607

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2608

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

2609

2610

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

2611

2612

(% class="box warningmessage" %)

2613

(((

2614

**PUT /api/v3/notifications/**

2615

)))

2616

2617

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

2618

2619

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

2620

2621

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2622

2623

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

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2628

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2629

"userId": "", ~/~/ Пользователь, создавший уведомление

2630

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

2631

"parentName": "string", ~/~/ Имя клиента

2632

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

2633

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2634

"vehicleIds": [ ~/~/ Список id объектов для анализа

2635

0

2636

],

2637

"geoids": [ ~/~/ Список id геообъектов для анализа

2638

0

2639

],

2640

"fieldids": [ ~/~/ Список id полей для анализа

2641

0

2642

],

2643

"settings": { ~/~/ Список параметров уведомления

2644

"additionalProp1": "string",

2645

"additionalProp2": "string",

2646

"additionalProp3": "string"

2647

},

2648

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2649

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2650

""

2651

],

2652

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2653

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

2654

"string"

2655

],

2656

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2657

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2658

{

2659

"id": 0, ~/~/ Идентификатор участника чата

2660

"info": "string" ~/~/ Дополнительные сведения

2661

}

2662

],

2663

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2664

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2665

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2666

"kind": 0, ~/~/ Определяет вид уведомления

2667

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2668

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2669

"timezone": 0, ~/~/ Сдвиг часового пояса

2670

"validity": 0, ~/~/ Срок действия в днях (1-90)

2671

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

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

2679

2680

(% class="box errormessage" %)

2681

(((

2682

**DELETE /api/v3/notifications/{id}**

2683

)))

2684

2685

Метод позволяет удалить выбранное уведомление.

2686

2687

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

2688

2689

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2690

2691

Передаваемый параметр: {id} - id уведомления

2692

2693

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

Ответ:

Success

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

2701

2702

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

2703

2704

(% class="box infomessage" %)

2705

(((

2706

**POST /api/v3/Drivers/find**

2707

)))

2708

2709

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2716

"description": "string", ~/~/ Определяет описание

2717

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2718

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2719

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2720

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2721

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2722

"deleted": true ~/~/ Признак удаления

}

]

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

2727

2728

(% class="box infomessage" %)

2729

(((

2730

**GET /api/v3/Drivers/{driverGuid}**

2731

)))

2732

2733

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2739

"description": "string", ~/~/ Определяет описание

2740

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2741

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2742

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2743

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2744

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2745

"deleted": true ~/~/ Признак удаления

2746

}

2747

2748

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

2749

2750

(% class="box successmessage" %)

2751

(((

2752

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2760

"hiredate": "2023-06-30T12:50:54.020Z",

2761

"chopdate": "2023-06-30T12:50:54.020Z",

2762

"exclusive": true,

2763

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

2764

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2773

"hiredate": "2023-06-30T12:50:54.051Z",

2774

"chopdate": "2023-06-30T12:50:54.051Z",

2775

"exclusive": true,

2776

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

2777

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

"deleted": true

}

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

2783

2784

(% class="box warningmessage" %)

2785

(((

2786

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2794

"hiredate": "2023-06-30T12:50:27.910Z",

2795

"chopdate": "2023-06-30T12:50:27.910Z",

2796

"exclusive": true,

2797

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

2798

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2807

"hiredate": "2023-06-30T12:50:27.929Z",

2808

"chopdate": "2023-06-30T12:50:27.929Z",

2809

"exclusive": true,

2810

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

2811

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

"deleted": true

}

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

2817

2818

(% class="box errormessage" %)

2819

(((

2820

**DELETE /api/v3/Drivers/{driverGuid}**

2821

)))

2822

2823

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2831

2832

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2833

2834

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

2835

2836

(% class="box infomessage" %)

2837

(((

2838

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2846

],

2847

"BeginTime": "2023-06-30T12:49:04.365Z",

2848

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2857

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

2858

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

2859

"BeginTime": "2023-06-30T09:52:31.240Z",

2860

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

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

2866

2867

(% class="box infomessage" %)

2868

(((

2869

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2879

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2888

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

2889

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

2890

"BeginTime": "2023-06-30T09:54:01.631Z",

2891

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

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

2897

2898

(% class="box successmessage" %)

2899

(((

2900

**POST /api/v3/DriversVehiclesAssignments**

2901

)))

2902

2903

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2910

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2911

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2912

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2913

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2923

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

2924

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

2925

"BeginTime": "2023-06-30T11:04:46.903Z",

2926

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2932

2933

(% class="box warningmessage" %)

2934

(((

2935

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2944

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2945

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

2946

"BeginTime": "2023-06-30T11:14:08.117Z",

2947

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2957

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

2958

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

2959

"BeginTime": "2023-06-30T11:14:53.349Z",

2960

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

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

2966

2967

(% class="box errormessage" %)

2968

(((

2969

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

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

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2984

2985

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

2986

2987

(% class="box infomessage" %)

2988

(((

2989

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2997

],

2998

"BeginTime": "2023-06-30T12:47:12.162Z",

2999

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3007

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3008

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3009

"BeginTime": "2023-06-30T11:19:40.703Z",

3010

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

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

3016

3017

(% class="box infomessage" %)

3018

(((

3019

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3027

],

3028

"BeginTime": "2023-06-30T12:47:12.162Z",

3029

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3037

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3038

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3039

"BeginTime": "2023-06-30T11:19:40.703Z",

3040

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

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

3046

3047

(% class="box successmessage" %)

3048

(((

3049

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

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

3057

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

3058

"BeginTime": "2023-06-30T11:27:08.635Z",

3059

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

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

3068

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

3069

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

3070

"BeginTime": "2023-06-30T11:27:08.677Z",

3071

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

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

3077

3078

(% class="box warningmessage" %)

3079

(((

3080

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

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

3088

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

3089

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

3090

"BeginTime": "2023-06-30T11:28:43.330Z",

3091

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

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

3100

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

3101

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

3102

"BeginTime": "2023-06-30T11:28:43.331Z",

3103

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

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

3109

3110

(% class="box errormessage" %)

3111

(((

3112

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3127

3128

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

3129

3130

(% class="box infomessage" %)

3131

(((

3132

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3140

],

3141

"BeginTime": "2023-06-30T12:45:10.852Z",

3142

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

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

3150

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

3151

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

3152

"BeginTime": "2023-06-30T11:58:04.695Z",

3153

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

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

3159

3160

(% class="box infomessage" %)

3161

(((

3162

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3170

],

3171

"BeginTime": "2023-06-30T12:45:10.852Z",

3172

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

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

3180

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

3181

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

3182

"BeginTime": "2023-06-30T11:58:04.695Z",

3183

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

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

3189

3190

(% class="box successmessage" %)

3191

(((

3192

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

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

3200

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

3201

"BeginTime": "2023-06-30T12:09:53.175Z",

3202

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

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

3211

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

3212

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

3213

"BeginTime": "2023-06-30T12:09:53.201Z",

3214

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

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

3220

3221

(% class="box warningmessage" %)

3222

(((

3223

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

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

3231

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

3232

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

3233

"BeginTime": "2023-06-30T12:09:53.201Z",

3234

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

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

3243

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

3244

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

3245

"BeginTime": "2023-06-30T12:09:53.201Z",

3246

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

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

3252

3253

(% class="box errormessage" %)

3254

(((

3255

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

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

3270

3271

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

3272

3273

(% class="box infomessage" %)

3274

(((

3275

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3282

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

3288

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3289

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3290

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3291

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

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

[

{

"SD": "2023-11-14T10:48:03.717Z",

3298

"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",

3308

"name": "string",

3309

"rid": "string",

3310

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

3311

"trailer": {

3312

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

3313

"Number": "string",

3314

"Description": "string",

3315

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

3316

"ExternalID": "string",

3317

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

3318

"CreateTime": "2023-11-14T10:48:03.717Z",

3319

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

3327

|SD|Дата и время начала события

3328

|ED|Дата и время окончания события

3329

|id|ID объекта

3330

|SLat|Широта начальной координаты

3331

|SLon|Долгота начальной координаты

3332

|ELat|Широта конечной координаты

3333

|ELon|Долгота конечной координаты

3334

|mileage|Пробег

3335

|Duration|Продолжительность

3336

|Address|Адрес начального местоположения

3337

|Address2|Адрес конечного местоположения

3338

|name|Имя радиометки

3339

|rid|Номер радиометки

3340

|rguid|ID радиометки

3341

|trailer|Информация об агрегате

3342

|ModelGuid|ID агрегата

3343

|Number|Название/номер агрегата

3344

|Description|Текст примечания агрегата

3345

3346

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

3347

3348

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

3349

3350

(% class="box infomessage" %)

3351

(((

3352

**POST /api/v3/Rfids/find**

)))

Запрос:

{

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

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

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

3369

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

}

]

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

3374

|parentId|ID клиента

3375

|name|Название карты-метки

3376

|number|Номер

3377

|period|Период запросов в секундах (работает только для агрегатов)

3378

|id|ID карты-метки

3379

3380

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

3381

3382

(% class="box infomessage" %)

3383

(((

3384

**GET /api/v3/Rfids/{rfidGuid}**

3385

)))

3386

3387

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

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

3397

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

}

]

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

3402

|name|Название карты-метки

3403

|number|Номер

3404

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

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

3409

3410

(% class="box successmessage" %)

3411

(((

3412

**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",

3431

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

3432

}

3433

3434

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

3435

|name|Название карты-метки

3436

|number|Номер

3437

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

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

3442

3443

(% class="box warningmessage" %)

3444

(((

3445

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

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

3455

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

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

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

3465

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

3466

}

3467

3468

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

3469

|name|Название карты-метки

3470

|number|Номер

3471

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

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

3476

3477

(% class="box errormessage" %)

3478

(((

3479

**DELETE /api/v3/Rfids/{rfidGuid}**

3480

)))

3481

3482

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

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

3490

3491

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

3492

3493

(% class="box infomessage" %)

3494

(((

3495

**GET /api/v3/Billing/client/balance/{clientId}**

3496

)))

3497

3498

Параметр запроса: **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);" %)**Описание**

3508

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

3509

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3510

3511

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

3512

3513

(% class="box infomessage" %)

3514

(((

3515

**GET /api/v3/Billing/client/constraint/{clientId}**

3516

)))

3517

3518

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

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

3524

"CalculationType": 0,

3525

"PermissibleBalance": 0,

3526

"DefermentDays": 0,

3527

"SendUiNotifications": true,

3528

"SendEmailNotifications": true,

"IsPrivate": true,

}

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

3533

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

3534

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3535

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3536

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3537

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3538

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3539

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3540

3541

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

3542

3543

(% class="box infomessage" %)

3544

(((

3545

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3551

3552

**planId **- идентификатор тарифного плана.

Ответ:

{

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

3558

"Plan": { **~/~/ Описание тарифного плана**

3559

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

3560

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

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3565

"PermissibleBalance": 0,

3566

"DefermentDays": 0

3567

},

3568

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3580

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

3596

|ClientId|Идентификатор клиента

3597

|Id|Идентификатор тарифного плана

3598

|OwnerId|Идентификатор клиента-владельца

3599

|Name|Наименование тарифного плана

3600

|IsArchived|Признак, определяющий архивный тарифный план

3601

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3602

|PermissibleBalance|Допустимый баланс

3603

|DefermentDays|Отсрочка, количество дней

3604

|Feature|Код услуги

3605

|IsEnabled|Признак, определяющий активирована ли услуга

3606

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3607

|IsFactual|Признак, определяющий расчёт по факту

3608

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3609

|Price|Цена за единицу.

3610

|DebitDate|Следующий момент времени списания с баланса за услугу.

3611

|PeriodValue|Значение периода.

3612

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3613

3614

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3615

3616

(% class="box infomessage" %)

3617

(((

3618

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3619

)))

3620

3621

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

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

3628

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

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3633

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

3650

|ClientId|Идентификатор клиента

3651

|Id|Идентификатор тарифного плана

3652

|OwnerId|Идентификатор клиента-владельца

3653

|Name|Наименование тарифного плана

3654

|IsArchived|Признак, определяющий архивный тарифный план

3655

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3656

|PermissibleBalance|Допустимый баланс

3657

|DefermentDays|Отсрочка, количество дней

3658

|Feature|Код услуги

3659

|IsFactual|Признак, определяющий расчёт по факту

3660

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3661

|Price|Цена за единицу.

3662

|PeriodValue|Значение периода.

3663

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3664

3665

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

3666

3667

(% class="box infomessage" %)

3668

(((

3669

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3670

)))

3671

3672

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

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

3679

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

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3684

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

3701

|ClientId|Идентификатор клиента

3702

|Id|Идентификатор тарифного плана

3703

|OwnerId|Идентификатор клиента-владельца

3704

|Name|Наименование тарифного плана

3705

|IsArchived|Признак, определяющий архивный тарифный план

3706

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3707

|PermissibleBalance|Допустимый баланс

3708

|DefermentDays|Отсрочка, количество дней

3709

|Feature|Код услуги

3710

|IsFactual|Признак, определяющий расчёт по факту

3711

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3712

|Price|Цена за единицу.

3713

|PeriodValue|Значение периода.

3714

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3715

3716

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

3717

3718

(% class="box warningmessage" %)

3719

(((

3720

**PUT /api/v3/Billing/client/balance**

3721

)))

3722

3723

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

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

3735

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

3736

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3737

3738

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3739

3740

(% class="box warningmessage" %)

3741

(((

3742

**PUT /api/v3/billing/client/balance/deposit**

3743

)))

3744

3745

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

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

3757

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

3758

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3759

3760

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3761

3762

Создает операцию **Списание **с указанной суммой

3763

3764

(% class="box warningmessage" %)

3765

(((

3766

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

3779

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

3780

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3781

3782

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3783

3784

(% class="box warningmessage" %)

3785

(((

3786

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

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

3793

"CalculationType": 0,

3794

"PermissibleBalance": 0,

3795

"DefermentDays": 0,

3796

"SendUiNotifications": true,

3797

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

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

3804

|ClientId|Идентификатор клиента

3805

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3806

|PermissibleBalance|Допустимый баланс

3807

|DefermentDays|(((

3808

Отсрочка, количество дней

3809

)))

3810

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3811

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3812

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3813

3814

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3815

3816

(% class="box warningmessage" %)

3817

(((

3818

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

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

3825

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

3843

|ClientId|Идентификатор клиента

3844

|PlanId|Идентификатор тарифного плана

3845

|Feature|Код услуги

3846

|IsEnabled|Признак, определяющий активирована ли услуга

3847

|IsFactual|Признак, определяющий расчёт по факту

3848

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3849

|Price|Цена за единицу.

3850

|DebitDate|Следующий момент времени списания с баланса за услугу.

3851

|PeriodValue|Значение периода.

3852

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3853

3854

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3855

3856

(% class="box warningmessage" %)

3857

(((

3858

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3859

)))

3860

3861

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3862

3863

(% class="box infomessage" %)

3864

(((

3865

**POST /api/v3/vehicles/import/{agentId}**

3866

)))

3867

3868

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3869

3870

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

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

3879

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3880

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3881

3882

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

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

3887

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3888

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

3899

|vehicleId|ID созданного объекта

3900

|name|Имя созданного объекта

3901

|errors|Ошибки и их описание

3902

3903

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3904

3905

(% class="box infomessage" %)

3906

(((

3907

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3908

)))

3909

3910

(% class="wikigeneratedid" %)

3911

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3912

3913

(% class="wikigeneratedid" %)

3914

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3919

3920

В теле использовать тип **form-data.**

Ключи:

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

3925

|**history**|В значении передавать файл с историей

3926

3927

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

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

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3940

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

3948

|results|Результаты импорта в разрезе ТС

3949

|vehicleGuid|Guid ТС

3950

|vehicleId|ID ТС

3951

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3952

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3953

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3954

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3955

|msgCount|Кол-во обработанных сообщений всего

3956

3957

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3958

3959

(% class="box infomessage" %)

3960

(((

3961

**GET /api/v3/vehicles/import/history/status**

3962

)))

3963

3964

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

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

3975

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3976

|progress|Guid ТС

3977

3978

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3979

3980

(% class="box infomessage" %)

3981

(((

3982

**POST /api/v3/vehicles/export**

3983

)))

3984

3985

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3994

3995

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3996

3997

(% class="box infomessage" %)

3998

(((

3999

**POST /api/v3/vehicles/export/history**

4000

)))

4001

4002

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4010

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4016

4017

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

4018

|vehicleId|ID объекта

4019

|asArchive|true - Архивировать файл, False - не архивировать

4020

|from|Дата и время начала запроса

4021

|to|Дата и время окончания запроса

4022

4023

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4024

4025

(% class="box infomessage" %)

4026

(((

4027

**GET /api/v3/vehicles/export/history/status**

4028

)))

4029

4030

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

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

4041

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4042

|progress|Прогресс экспорта, от 0 до 100%

4043

|message|Текст описывающий статус

4044

4045

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4046

4047

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4048

4049

(% class="box infomessage" %)

4050

(((

4051

**POST /api/v3/EcoDriving/rating**

4052

)))

4053

4054

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

4060

"from": "2023-11-22T09:29:48.051Z",

4061

"to": "2023-11-22T09:29:48.051Z"

4062

}

4063

4064

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

4065

|vehicleIds|Массив ID объектов

4066

|from|Дата начала запроса

4067

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

4075

"to": "2023-11-22T09:29:48.052Z",

4076

"vehicleId": 0,

4077

"vehicleName": "string",

4078

"vehicleModel": "string",

4079

"penalty": 0,

4080

"score": 0,

4081

"totalViolations": 0,

4082

"violationsByType": {

4083

"overspeedingViolations": 0,

4084

"accelerationViolations": 0,

4085

"brakingViolations": 0,

4086

"turningViolations": 0,

4087

"dangerousDrivingViolations": 0,

4088

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

4098

"violationsByType": {

4099

"overspeedingViolations": 0,

4100

"accelerationViolations": 0,

4101

"brakingViolations": 0,

4102

"turningViolations": 0,

4103

"dangerousDrivingViolations": 0,

4104

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4111

"endAddress": "string",

4112

"drivers": [

4113

{

4114

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

4115

"driverName": "string",

4116

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

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

4126

|from|Дата начала запроса

4127

|to|Дата окончания

4128

|vehicleId|ID объекта

4129

|vehicleName|Имя объекта

4130

|vehicleModel|Модель объекта

4131

|penalty|Сумма штрафных баллов

4132

|score|Оценка

4133

|totalViolations|Суммарное количество нарушений

4134

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4135

|overspeedingViolations|Превышение скорости

4136

|accelerationViolations|Ускорение

4137

|brakingViolations|Торможение

4138

|turningViolations|Резкий поворот

4139

|dangerousDrivingViolations|Резкое вождение

4140

|sensorViolations|Нарушение по датчику

4141

|moveTime|Время в движении

4142

|mileage|Пробег

4143

|tripsCount|Количество рейсов

4144

|motohours|Моточасы

4145

|maxSpeed|Максимальная скорость

4146

|startAddress|Адрес начала рейса

4147

|endAddress|Адрес окончания рейса

4148

|drivers|Список водителей, которые были на объекте в течениии рейса

4149

|driverGuid|Guid водителя

4150

|driverName|Имя водителя

4151

|driverRfid|Номер Карты-метки

4152

4153

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

4154

4155

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4156

4157

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4158

4159

(% class="box infomessage" %)

4160

(((

4161

POST /api/v3/fuelcards/transactions

)))

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

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4167

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

4168

4169

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

{

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4174

4175

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

"ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

],

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4192

4193

"driver": "string", ~/~/Водители, привязанные к ТК

4194

4195

"object": "string", ~/~/Наименование ТС

4196

4197

"amount": 0, ~/~/Количество топлива

4198

4199

"amountDut": 0, ~/~/Количество по ДУТ

4200

4201

"amountDiff": 0, ~/~/Разница, л

4202

4203

"amountDiffPerc": 0, ~/~/Разница, %

4204

4205

"summa": 0, ~/~/Стоимость, руб

4206

4207

"serviceName": "string", ~/~/Тип топлива

4208

4209

"price": 0, ~/~/Цена за литр, руб

4210

4211

"cardName": "string", ~/~/Наименование ТК

4212

4213

"cardNum": "string", ~/~/Номер ТК

4214

4215

"operator": "string", ~/~/Оператор ТК

4216

4217

"address": "string" ~/~/Адрес АЗС

}

==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====

4223

4224

4225

==== **Получение полных данных о ретрансляторе** ====

4226

4227

(% class="box infomessage" %)

4228

(((

4229

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

4230

)))

4231

4232

Идентификатор запроса: ID

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

{

"description": "", ~/~/ Определяет описание

4240

4241

"subscriberId": "", ~/~/ Подписчик

4242

4243

"protocolType": 0, ~/~/ Тип протокола

4244

4245

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4246

4247

"address": "string", ~/~/ Адрес события

4248

4249

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ Идентификатор объекта ретрансляции

4254

4255

"name": "", ~/~/ Наименование объекта ретрансляции

4256

4257

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

4258

4259

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

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

4266

4267

"parentId": "", ~/~/Guid родителя

4268

4269

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

==== **Удаление данных ретранслятора** ====

4275

4276

(% class="box infomessage" %)

4277

(((

4278

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

==== **Создание ретранслятора** ====

4285

4286

(% class="box infomessage" %)

4287

(((

4288

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

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

4297

4298

"subscriberId": "", ~/~/ Подписчик

4299

4300

"protocolType": 0, ~/~/ Тип протокола

4301

4302

"address": "", ~/~/ Адрес ретрансляции

4303

4304

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4305

4306

"objects": [ ~/~/Объекты для ретрансляции

{

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

4311

4312

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

4313

4314

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ

{

"description": "string", ~/~/ Определяет описание

4329

4330

"subscriberId": "", ~/~/ идентификатор запроса

4331

4332

"protocolType": 0, ~/~/ Тип протокола

4333

4334

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4335

4336

"address": "", ~/~/ Адрес события

4337

4338

"objects": [ ~/~/Объекты для ретрансляции

{

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

4343

4344

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

4345

4346

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

4347

4348

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

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

4355

4356

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

4357

4358

"deleted": true ~/~/ Признак удаления

}

==== **Редактирование ретранслятора** ====

4364

4365

(% class="box infomessage" %)

4366

(((

4367

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

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

4375

4376

"description": "string", ~/~/ Определяет описание

4377

4378

"subscriberId": "", ~/~/ идентификатор запроса

4379

4380

"protocolType": 0, ~/~/ Тип протокола

4381

4382

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4383

4384

"address": "string", ~/~/ Адрес события

4385

4386

"objects": ~/~/Объекты для ретрансляции

[

{

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

4393

4394

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

4395

4396

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

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

{

"description": "", ~/~/ Определяет описание

4410

4411

"subscriberId": "", ~/~/ идентификатор запроса

4412

4413

"protocolType": 0, ~/~/ Тип протокола

4414

4415

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4416

4417

"address": "string", ~/~/ Адрес события

4418

4419

"objects": [ ~/~/Объекты для ретрансляции

{

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

4424

4425

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

4426

4427

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

4428

4429

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

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

4436

4437

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

4438

4439

"deleted": true ~/~/ Признак удаления

}

==== **Получение списка ретранслятора клиента** ====

4446

4447

(% class="box infomessage" %)

4448

(((

4449

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

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

4458

4459

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4460

4461

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ

[

{

"description": "", ~/~/ Определяет описание

4475

4476

"subscriberId": "", ~/~/ идентификатор запроса

4477

4478

"protocolType": 0, ~/~/ Тип протокола

4479

4480

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4481

4482

"address": "string", ~/~/ Адрес события

4483

4484

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

4485

4486

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

4487

4488

"deleted": true ~/~/ Признак удаления

}

]

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

4496

4497

4498

==== **API для отчета по выгрузке комбайнов** ====

4499

4500

4501

(% class="box infomessage" %)

4502

(((

4503

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4512

4513

"byDist": 0, ~/~/ Объединение событий по расстоянию

4514

4515

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4516

4517

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4518

4519

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4520

4521

"vehicleIds": [ ~/~/ Список id объектов для анализа

0

],

"from": "", ~/~/ Дата и время начало запроса

4528

4529

"to": "", ~/~/ Дата и время окончания запроса

4530

4531

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

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

[

{

"harvesterName": "", ~/~/Комбайн, номер

4545

4546

"harvesterId": 0, ~/~/Комбайн, id

4547

4548

"harvesterModel": "", ~/~/ Модель комбайна

4549

4550

"hopperCapacity": 0, ~/~/ Объем бункера м3

4551

4552

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4553

4554

"events": [ ~/~/Список событий в разрезе комбайна

{

"driverId": "", ~/~/Идентификатор водителя

4559

4560

"driverName": "", ~/~/Водитель комбайна, ФИО

4561

4562

"RFID": "", ~/~/ идентификатор карты-метки

4563

4564

"rfidName": "", ~/~/Водитель комбайна, имя метки

4565

4566

"vehicleId": 0, ~/~/идентификатор объекта

4567

4568

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

4569

4570

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

4571

4572

"nearestVehicles": [ ~/~/Объекты рядом

{

"vehicleId": 0, ~/~/идентификатор объекта

4577

4578

"vehicleName": "string" ~/~/ Имя объекта

}

],

"fields": [ ~/~/Поля, где происходила выгрузка

{

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

4589

4590

"name": "string" ~/~/ имя пользователя

}

],

"event": "string", ~/~/Событие

4597

4598

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4599

4600

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4601

4602

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4603

4604

"cultureName": "string", ~/~/ название культуры

4605

4606

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4607

4608

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4609

4610

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4611

4612

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4613

4614

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4615

4616

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4617

4618

"issued": 0, ~/~/Выдано, бункеров

4619

4620

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4621

4622

"latitude": 0, ~/~/Широта

4623

4624

"longitude": 0, ~/~/ Долгота

4625

4626

"litresAway": 0, ~/~/Отдано, л

4627

4628

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

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

4640

4641

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

4642

4643

4644

(% class="box infomessage" %)

4645

(((

4646

GET api/v3/Vehicles/recyclebin/all

4647

)))

4648

4649

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4650

4651

Параметр запроса: {parentId} - идентификатор агента

4652

4653

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

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4662

4663

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4664

4665

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4666

4667

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4668

4669

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4670

4671

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4672

4673

"details": { ~/~/Список деталей объекта, помещённого в корзину

"items": [ ~/~/ [

nullable: true ~/~/Детали

{

"name": "string", ~/~/наименование столбца

4682

4683

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4703

4704

(% class="box infomessage" %)

4705

(((

4706

POST/api/v3/Vehicles/recyclebin/erase

4707

)))

4708

4709

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

Пример запроса:

[

0

]

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

[

{

"recordTime": "", ~/~/Время записи

4728

4729

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4730

4731

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4732

4733

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4734

4735

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4736

4737

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4738

4739

"details": { ~/~/Список деталей объекта, помещённого в корзину

4740

4741

"items": [ ~/~/Детали

{

"name": "", ~/~/Имя свойства

4746

4747

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

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

4766

4767

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

4768

4769

(% class="box infomessage" %)

4770

(((

4771

POST/api/v3/Vehicles/recyclebin/restore

4772

)))

4773

4774

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

4775

4776

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

4777

4778

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4779

4780

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

Пример запроса:

[

0

]

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

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4799

4800

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4801

4802

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4803

4804

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4805

4806

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4807

4808

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4809

4810

"details": { ~/~/Список деталей объекта, помещённого в корзину

4811

4812

"items": [ ~/~/Детали

{

"name": "string", ~/~/Имя свойства

4817

4818

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4839

(((

4840

(% 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]] **

4841

)))

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

Меню