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

1

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

2

(((

3

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

)))

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

10

11

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

12

13

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

14

15

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

16

17

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

18

19

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

20

21

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

22

23

(% class="box successmessage" %)

24

(((

25

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

26

)))

27

28

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

29

30

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

31

32

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

33

34

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

35

36

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

37

38

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

39

"login": "testuser",

40

"password": "testuser"

41

}

42

43

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

44

45

(% lang="en-US" %)

46

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

47

48

(% lang="en-US" %)

49

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

50

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

(% lang="en-US" %)

}

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

56

57

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

58

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

59

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

60

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

61

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

62

63

(% class="wikigeneratedid" %)

64

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

65

66

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

67

68

(% class="box infomessage" %)

69

(((

70

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

71

)))

72

73

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

74

75

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

76

77

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

78

79

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

80

81

(% lang="en-US" %)

82

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

83

84

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

85

86

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

87

88

(% class="box infomessage" %)

89

(((

90

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

91

)))

92

93

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

94

95

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

96

97

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

98

99

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

100

101

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

102

103

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

108

"name": "string",

109

"fullName": "string",

110

"agentInfoType": 0,

111

"isForeign": true/false,

112

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

119

"email": "string",

120

"director": "string",

121

"bankName": "string",

"bankBIK": "string",

"bankRS": "string",

"bankKS": "string"

}

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

149

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

150

151

(% class="box infomessage" %)

152

(((

153

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

154

)))

155

156

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

157

158

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

159

160

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

161

162

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

163

164

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

165

166

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

167

168

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

169

170

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

"parentId": "string"

}

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

175

176

{

177

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

178

"parentId": "",

179

"name": "string",

180

"fullName": "string",

181

"agentInfoType": 0,

182

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

}

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

187

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

188

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

189

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

190

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

191

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

192

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

193

194

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

195

196

(% class="box successmessage" %)

197

(((

198

**POST /api/v3/agents **

199

)))

200

201

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

202

203

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

204

205

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

206

207

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

208

209

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

210

211

{

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

}

Ответ:

{

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

}

256

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

279

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

280

281

(% class="box warningmessage" %)

282

(((

283

**PUT /api/v3/agents**

284

)))

285

286

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

287

288

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

289

290

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

291

292

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

293

294

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

295

296

{

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

}

Ответ:

{

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

}

340

341

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

342

343

(% class="box errormessage" %)

344

(((

345

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

346

)))

347

348

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

349

350

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

351

352

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

353

354

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

355

356

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

357

358

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

359

360

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

361

362

(% class="box warningmessage" %)

363

(((

364

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

365

)))

366

367

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

368

369

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

370

371

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

Ответ: Code 204

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

376

377

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

378

379

(% class="box successmessage" %)

380

(((

381

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

382

)))

383

384

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

385

386

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

387

388

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

389

390

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

391

392

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

393

394

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

395

{

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

"doubleAuth":

412

{

413

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

414

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

},

"groups":

[

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

],

"customGroups":

[

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

423

],

424

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

}

{

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

429

"lastName": "string",

430

"firstName": "string",

431

"position": "string",

432

"phone": "string",

433

"organization": "string",

434

"login": "string",

435

"password": "string",

436

"email": "string",

437

438

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

439

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

440

441

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

442

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

443

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

463

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

464

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

465

466

467

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

468

469

(% class="box infomessage" %)

470

(((

471

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

472

)))

473

474

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

475

476

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

477

478

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

479

480

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

481

482

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

483

484

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

485

486

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

487

488

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

489

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

490

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

491

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

492

493

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

494

495

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

496

497

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

498

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

513

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

514

515

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

516

517

(% class="box infomessage" %)

518

(((

519

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

520

)))

521

522

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

523

524

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

525

526

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

527

528

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

529

530

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

(((

(((

{

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

"doubleAuth":

550

{

551

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

552

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

553

},

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

}

)))

)))

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

568

569

(% class="box warningmessage" %)

570

(((

571

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

572

)))

573

574

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

575

576

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

577

578

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

579

580

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

581

582

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

583

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

584

585

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

586

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

587

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

"doubleAuth":

606

{

607

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

608

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

609

},

610

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

611

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

612

613

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

614

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

615

616

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

617

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

618

619

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

620

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

621

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

"doubleAuth":

637

{

638

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

639

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

640

},

641

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

642

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

643

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

644

645

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

646

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

647

648

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

649

650

(% class="box warningmessage" %)

651

(((

652

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

653

)))

654

655

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

656

657

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

658

659

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

660

661

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

662

663

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

664

665

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

666

667

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

668

669

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

670

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

671

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

672

673

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

674

675

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

676

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

677

678

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

679

680

(% class="box warningmessage" %)

681

(((

682

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

683

)))

684

685

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

686

687

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

688

689

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

690

691

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

692

693

[

694

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

695

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

696

]

697

698

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

699

700

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

701

702

(% class="box warningmessage" %)

703

(((

704

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

705

)))

706

707

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

708

709

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

710

711

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

712

713

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

714

715

[

716

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

717

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

718

]

719

720

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

721

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

(((

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

{

"errorMessages": [

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

728

],

729

"users": [

730

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

731

]

732

}

733

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

734

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

735

)))

736

737

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

738

739

(% class="box errormessage" %)

740

(((

741

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

742

)))

743

744

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

745

746

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

747

748

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

749

750

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

751

752

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

753

754

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

755

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

756

757

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

758

759

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

760

761

(% class="box infomessage" %)

762

(((

763

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

764

)))

765

766

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

767

768

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

769

770

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

771

772

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

773

774

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

775

776

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

777

778

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

779

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

786

"hoppercapacity": 0,

787

"hopperdischargespeed": 0,

788

"modelType": 0,

789

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

790

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

"deleted": true

}

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

808

809

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

810

811

(% class="box successmessage" %)

812

(((

813

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

814

)))

815

816

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

817

818

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

819

820

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

821

822

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

823

824

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

825

826

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

827

}

828

829

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

830

831

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

832

{

833

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

834

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

835

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

842

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

843

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

844

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

845

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

846

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

847

848

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

849

850

(% class="box successmessage" %)

851

(((

852

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

853

)))

854

855

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

856

857

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

858

859

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

860

861

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

862

863

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

864

865

{

866

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

867

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

876

"fueloutlay": 0,

877

"hoppercapacity": 0,

878

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

886

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

895

"hoppercapacity": 0,

896

"hopperdischargespeed": 0,

"modelType": 0

}

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

914

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

915

916

(% class="box warningmessage" %)

917

(((

918

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

919

)))

920

921

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

922

923

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

924

925

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

926

927

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

928

929

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

930

931

{

932

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

933

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

942

"fueloutlay": 0,

943

"hoppercapacity": 0,

944

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

952

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

961

"fueloutlay": 0,

962

"hoppercapacity": 0,

963

"hopperdischargespeed": 0,

"modelType": 0

}

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

979

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

980

981

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

982

983

(% class="box errormessage" %)

984

(((

985

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

986

)))

987

988

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

989

990

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

991

992

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

993

994

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

995

996

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

997

998

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

999

1000

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

1001

1002

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

1003

1004

(% class="box infomessage" %)

1005

(((

1006

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

1007

)))

1008

1009

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

1010

1011

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

1012

1013

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

1014

1015

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

1016

1017

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

1018

1019

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

1020

1021

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

1022

1023

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

1024

1025

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

(((

{

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

1037

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

1038

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

1039

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

1040

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

1041

1042

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

1043

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

1044

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

1045

1046

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

1047

},

1048

1049

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

1050

{

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

}

1058

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

1072

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

},

1085

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

},

1093

1094

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

1095

{

1096

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

1097

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

1098

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

1099

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

}

],

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

1104

{

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

{

1118

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

1119

{

1120

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

1121

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

1122

}

1123

],

1124

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

1125

}

1126

],

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

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

1134

"string"

1135

],

1136

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

1137

"additionalProp1": "string",

1138

"additionalProp2": "string",

1139

"additionalProp3": "string"

1140

},

1141

1142

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

1143

1144

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

1145

1146

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

1147

1148

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

1149

1150

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

1151

1152

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

1153

1154

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

1155

1156

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

1157

1158

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

1159

1160

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

1161

1162

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

1163

1164

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

1165

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

1166

}

1167

1168

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

1169

{

1170

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

1171

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

1172

"description": "string",

1173

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

}

],

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

1178

{

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

}

],

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

1195

{

1196

"status": 0,

1197

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

1198

"description": "string",

1199

"additionalInfo": "string"

}

]

}

)))

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

1207

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

1208

1209

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

1210

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

1211

1212

1213

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

1214

1215

(% class="box infomessage" %)

1216

(((

1217

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

1218

)))

1219

1220

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

1221

1222

1223

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

1224

1225

1226

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

1227

1228

1229

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

1230

1231

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

1232

1233

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

1234

1235

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

1236

1237

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

1238

1239

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

1240

1241

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

1242

1243

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

(((

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

1249

1250

(% class="box infomessage" %)

1251

(((

1252

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

1253

)))

1254

1255

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

1256

1257

1258

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

1259

1260

1261

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

[

{

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

1269

1270

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

1271

1272

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

1273

1274

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

1275

1276

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

1277

1278

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

1279

1280

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

}

]

)))

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

1290

1291

(% class="box successmessage" %)

1292

(((

1293

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

1294

)))

1295

1296

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

1297

1298

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

1299

1300

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

1301

1302

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

1303

1304

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

1305

1306

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

1307

1308

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

1309

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

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

1329

"mileageCalcMethod": 0,

1330

"mileageCoeff": 0,

1331

"locationByCellId": true,

1332

"dottedLineTrackWhenNoCoords": true,

1333

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

1334

{

1335

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

1336

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

1337

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

1338

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

1339

},

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

},

1347

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

1348

{

1349

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

1350

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

1351

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

1352

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

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

}

1361

1362

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

1363

{

1364

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

"isDefault": true

}

],

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

1369

{

1370

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1378

{

1379

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

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1390

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

1391

{

1392

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

1393

{

1394

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

1395

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

1396

}

1397

],

1398

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

1399

}

1400

],

1401

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

"string"

1409

],

1410

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

1411

"additionalProp1": "string",

1412

"additionalProp2": "string",

1413

"additionalProp3": "string"

1414

},

1415

1416

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

1417

1418

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

1419

1420

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

1421

1422

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

1423

1424

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

1425

1426

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

1427

1428

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

1429

1430

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

1431

1432

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

1433

1434

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

1435

1436

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

1437

1438

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

1439

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

1440

}

1441

],

1442

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

1443

{

1444

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1455

1456

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

1457

1458

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

1459

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

1460

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

1461

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

1462

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

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

1469

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

1470

"mileageEnabled": true,

1471

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1476

"id": null,

1477

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

1478

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

1479

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

1480

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

1481

},

1482

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

1483

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

1484

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

1485

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

1486

"description": "", ~/~/ Описание задания

1487

"mileageCondition": "", ~/~/ Условие по пробегу

1488

"lastMileage": "", ~/~/ Пробег (в метрах)

1489

"motohoursCondition": "", ~/~/ Условие по моточасам

1490

"lastMotohours": "", ~/~/ Моточасы

1491

"periodicCondition": "", ~/~/ Условие периодичности по времени

1492

"kind": "", ~/~/ Вид периодичности по времени

1493

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1494

}

1495

1496

(% style="text-align:left" %)

1497

(% style="color:#000000" %)}

1498

1499

**Валидация:**

1500

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1501

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1502

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1503

1504

== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==

1505

1506

(% class="box infomessage" %)

1507

(((

1508

(% lang="en-US" %)**POST /api/v3/vehicles/find**

1509

)))

1510

1511

(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

1512

1513

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:

1514

1515

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

1516

1517

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

1518

1519

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

1520

1521

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

1522

1523

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

1524

1525

(% style="color:#000000" %)Метод запроса: **POST**

1526

1527

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

1528

1529

(% style="color:#000000" %)В заголовках запроса:

1530

1531

(% style="color:#000000" %)− Content-Type: __**application/json**__

1532

1533

(% style="color:#000000" %)− X-Auth: Токен авторизации

1534

1535

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1536

1537

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1538

1539

{

1540

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1541

"name": null, ~/~/ Имя ТС (string, опционально)

1542

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1543

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1544

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1545

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1546

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1547

"customFields": null ~/~/ значение любого из произвольных полей ТС

1548

}

1549

1550

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1551

1552

(% style="color:#000000" %)Ответ:

1553

1554

(% style="color:#000000" %){

1555

1556

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1557

"name": "" ~/~/ наименование объекта

1558

"imei": "" ~/~/ IMEI объекта

1559

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1560

"deviceTypeName": "" ~/~/ наименование типа устройства

1561

"sim1": "" ~/~/ первый номер телефона

1562

"sim2": "" ~/~/ второй номер телефона

1563

"parentId": "" ~/~/ идентификатор клиента-родителя

1564

"parentName": "" ~/~/ наименование клиента-родителя

1565

"modelId": "" ~/~/ идентификатор модели объекта

1566

"modelName": "" ~/~/ наименование модели объекта

1567

"unitId": "" ~/~/ идентификатор подразделения

1568

"unitName": "" ~/~/ наименование подразделения

1569

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1570

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1571

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1572

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1573

"customFields": [

1574

{

1575

"id": "", ~/~/ идентификатор произвольного поля

1576

"name": "", ~/~/ имя произвольного поля

1577

"value": "", ~/~/ значение произвольного поля

1578

"forClient": true, ~/~/ право на отображение у клиента

1579

"forTooltip": false, ~/~/ право на отображение в подсказке

1580

"forReport": false ~/~/ право на отображение в отчетах

1581

}(%%)

1582

(% style="color:#000000" %)}

1583

1584

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1585

1586

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1587

1588

(% class="box successmessage" %)

1589

(((

1590

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1591

)))

1592

1593

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1594

1595

(% style="color:#000000" %)Метод запроса: **POST**

1596

1597

(% 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}

1598

1599

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1600

1601

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1602

1603

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1604

1605

(% style="color:#000000" %){

1606

1607

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1608

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1609

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1610

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1611

"description": "", ~/~/ Описание

1612

"data": "", ~/~/ Данные

1613

"overwrite": false, ~/~/ Флаг перезаписи

1614

"stage": "", ~/~/ Состояние, может быть null

1615

1616

(% style="color:#000000" %)}

1617

1618

(% style="color:#000000" %)Ответ:

1619

1620

(% style="color:#000000" %){

1621

1622

"status": "", ~/~/ значение статуса

1623

"date": "", ~/~/ Дата смены статуса

1624

"description": "", ~/~/ Описание

1625

"data": "", ~/~/ Данные

1626

"overwrite": false, ~/~/ Флаг перезаписи

1627

"stage": "", ~/~/ Состояние

1628

1629

(% style="text-align:left" %)

1630

(% style="color:#000000" %) }

1631

1632

(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)

1633

**Отправить команду на терминал**

1634

1635

(% class="box successmessage" %)

1636

(((

1637

(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**

1638

)))

1639

1640

Команда для отправки на тс.

{

"id": "", ~/~/идентификатор произвольного поля

1646

1647

"command": "", ~/~/ Текст команды

1648

1649

"retries": "", ~/~/ Количество попыток

1650

1651

"idTemplate": "" ~/~/ ID шаблона команды

}

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1657

1658

(% class="box warningmessage" %)

1659

(((

1660

(% lang="en-US" %)**PUT /api/v3/vehicles**

1661

)))

1662

1663

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1664

1665

(% style="color:#000000" %)Метод запроса: **PUT**

1666

1667

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1668

1669

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1670

1671

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1672

1673

(% style="color:#000000" %){

1674

"vehicleId": , ~/~/ ID объекта

1675

"parentId": "" , ~/~/ ID клиента

1676

"name": "" , ~/~/ имя ТС

1677

"imei": "" , ~/~/ IMEI

1678

"deviceTypeId": "" , ~/~/ ID типа устройства

1679

"modelId": "" , ~/~/ ID модели

1680

"unitId": "" , ~/~/ ID подразделения

1681

"sim1": "" , ~/~/ Номер SIM 1

1682

"sim2": "" , ~/~/ Номер SIM2

1683

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1684

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1685

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1686

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1687

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1688

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1689

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1690

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1691

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1692

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1693

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1694

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1695

1696

"mileageCalcMethod": 0,

1697

"mileageCoeff": 0,

1698

"locationByCellId": true,

1699

"dottedLineTrackWhenNoCoords": true,

1700

"counters": ~/~/ счетчики

1701

{

1702

"mileage": "" , ~/~/ пробег

1703

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1704

"motohours": "" , ~/~/ моточасы

1705

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1706

},

1707

"cmsv6Parameters": { ~/~/ параметры CMSv6

1708

"enabled": true, ~/~/ флаг включения

1709

"id": "" , ~/~/ идентификатор

1710

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1711

"login": "" , ~/~/ имя учетной записи

1712

"password": "" ~/~/ пароль учетной записи

1713

},

1714

"inspectionTasks": ~/~/ задания на ТО

1715

{

1716

"enabled": "" , ~/~/ Признак включения

1717

"name": "" , ~/~/ Имя задания

1718

"description": "" , ~/~/ Описание задания

1719

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1720

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1721

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1722

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1723

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1724

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1725

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1726

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1727

}

1728

1729

"drivers": [ ~/~/ Водители

1730

{

1731

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1736

{

1737

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1745

{

1746

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1747

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1748

"type": 0, ~/~/ Тип датчика

1749

"name": "string", ~/~/ Имя датчика

1750

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1751

"inputNumber": 0, ~/~/ Номер входа

1752

"pseudonym": "string", ~/~/ Псевдоним

1753

"medianDegree": 0, ~/~/ Медианная фильтрация

1754

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1755

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1756

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1757

"gradesTables": [ ~/~/ Массив таблиц тарировки

1758

{

1759

"grades": [ ~/~/ Таблица тарировки 1

1760

{

1761

"input": 0, ~/~/ Входящее значение

1762

"output": 0 ~/~/ Выходящее значение

1763

}

1764

],

1765

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1766

}

1767

],

1768

"showInTooltip": true, ~/~/ Отображать в подсказке

1769

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1770

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1771

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1772

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1773

"expr": "string", ~/~/ Формула

1774

"children": [ ~/~/ массив дочерних датчиков

1775

"string"

1776

],

1777

"customParams": { ~/~/ прочие произвольные параметры

1778

"additionalProp1": "string",

1779

"additionalProp2": "string",

1780

"additionalProp3": "string"

1781

},

1782

1783

~/~/ Характерные для произвольного:

1784

1785

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1786

1787

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1788

1789

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1790

1791

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1792

1793

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1794

1795

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1796

1797

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1798

1799

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1800

1801

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1802

1803

~/~/ "ValueOn": "Вкл.",

1804

1805

~/~/ "ValueOff": "Выкл."

1806

"summaryMaxValue": 0 ~/~/ Макс. значение

1807

}

1808

],

1809

"customFields": [ ~/~/ Произвольные поля

1810

{

1811

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1822

1823

(% lang="en-US" style="text-align:left" %)

1824

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1825

1826

(% lang="en-US" style="text-align:left" %)

1827

"vehicleId": "", ~/~/ ID ТС

1828

"parentId": "", ~/~/ ID клиента

1829

"name": "", ~/~/ имя ТС

1830

"imei": "", ~/~/ IMEI

1831

"deviceTypeId": "", ~/~/ типа устройства

1832

"modelId": "", ~/~/ ID модели

1833

"unitId": "", ~/~/ ID подразделения

1834

"sim1": "", ~/~/ SIM 1

1835

"sim2": "", ~/~/ SIM2

1836

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1837

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1838

"counters":

1839

{

1840

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1841

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1842

"mileage": "", ~/~/ пробег

1843

"motohours": "", ~/~/ моточасы

1844

}

1845

"cmsv6Parameters": ~/~/ параметры CMSv6

1846

{

1847

"id": ~/~/ идентификатор

1848

"enabled": true, ~/~/ флаг включения

1849

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1850

"login": "", ~/~/ имя учетной записи

1851

"password": "", ~/~/ пароль учетной записи

1852

}

1853

"inspectionTasks": ~/~/ задания на ТО

1854

{

1855

"id": "", ~/~/ ID задания

1856

"enabled": false, ~/~/ Признак включения

1857

"name": "", ~/~/ Имя задания

1858

"description": "", ~/~/ Описание задания

1859

"mileageCondition": "", ~/~/ Условие по пробегу

1860

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1861

"motohoursCondition": "", ~/~/ Условие по моточасам

1862

"lastMotohours": "", ~/~/ Моточасы

1863

"periodicCondition": "", ~/~/ Условие периодичности по времени

1864

"kind": "", ~/~/ Вид периодичности по времени

1865

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1866

}

1867

1868

(% lang="en-US" style="text-align:left" %)

1869

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1870

1871

**Валидация:**

1872

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1873

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1874

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1875

1876

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1877

1878

(% class="box errormessage" %)

1879

(((

1880

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1881

)))

1882

1883

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1884

1885

(% style="color:#000000" %)Метод запроса: **DELETE**

1886

1887

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1888

1889

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1890

1891

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1892

1893

(% style="text-align:left" %)

1894

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1895

1896

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1897

1898

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1899

1900

(% class="box infomessage" %)

1901

(((

1902

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1903

)))

1904

1905

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1906

1907

(% style="color:#000000" %)Метод запроса: **GET**

1908

1909

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

1910

1911

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1912

1913

(% style="color:#000000" %)Ответ:

1914

1915

(% style="color:#000000" %){

1916

1917

"deviceTypeId" : "", ~/~/ ID типа устройства

1918

"deviceTypeName" : "" ~/~/ Название типа устройства

1919

1920

(% style="text-align:left" %)

1921

(% style="color:#000000" %)}

1922

1923

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1924

1925

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1926

1927

(% class="box infomessage" %)

1928

(((

1929

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1930

)))

1931

1932

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1933

1934

(% style="color:#000000" %)Метод запроса: **GET**

1935

1936

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1937

1938

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1939

1940

(% style="color:#000000" %)Ответ:

1941

1942

(% style="color:#000000" %){

1943

1944

"id": "", ~/~/ ID типа датчика

1945

"name": "", ~/~/ Название

1946

"description": "", ~/~/ Описание

1947

1948

(% style="text-align:left" %)

1949

(% style="color:#000000" %)}

1950

1951

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1952

1953

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1954

1955

(% class="box infomessage" style="text-align: left;" %)

1956

(((

1957

**POST /api/v3/terminalMessages/count**

1958

)))

1959

1960

(% style="text-align: left;" %)

1961

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1962

1963

(% style="text-align: left;" %)

1964

Метод запроса **POST**

1965

1966

(% style="text-align: left;" %)

1967

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1968

1969

(% style="text-align: left;" %)

1970

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1971

1972

(% style="text-align: left;" %)

1973

{

1974

"vehicleIds": [

1975

id ~/~/ здесь передается список идентификаторов объектов

1976

],

1977

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1978

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1979

}

1980

1981

(% style="text-align: left;" %)

1982

Ответ:

1983

1984

(% style="text-align: left;" %)

1985

[

1986

{

1987

"vehicleId": 0, ~/~/ идентификатор объекта

1988

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1993

1994

(% class="box infomessage" style="text-align: left;" %)

1995

(((

1996

**POST /api/v3/terminalMessages/mapping**

1997

)))

1998

1999

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

2000

2001

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

2002

2003

(% 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);" %)**Описание**

2011

|protocolType|ID типа протокола

2012

|params|(((

2013

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

2033

|protocolType|Тип протокола

2034

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2040

Перечень 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/]]

2041

2042

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2043

2044

(% class="box infomessage" %)

2045

(((

2046

**POST /api/v3/terminalMessages**

2047

)))

2048

2049

Метод возвращает список сообщений терминала объекта за выбранный период.

2050

2051

(% style="text-align: left;" %)

2052

Метод запроса **POST**

2053

2054

(% style="text-align: left;" %)

2055

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

2056

2057

(% style="text-align: left;" %)

2058

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2059

2060

{

2061

"vehicleId": 0, ~/~/ id объекта

2062

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2063

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2064

}

2065

2066

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2067

|vehicleId|ID объекта

2068

|from|Дата и время начала периода запроса

2069

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2078

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2088

"additionalProp2": "string",

2089

"additionalProp3": "string"

2090

},

2091

"photoCount": 0,

2092

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2100

|deviceTime|Время сообщения терминала

2101

|serverTime|Время когда сообщение поступило на сервер

2102

|speed|Скорость

2103

|altitude|Высота над уровнем моря

2104

|latitude|Широта

2105

|longitude|Долгота

2106

|satellites|Кол-во спутников

2107

|course|Курс

2108

|voltage|Бортовое напряжение

2109

|parameters|Список параметров и их значений

2110

|photoCount|Количество фото

2111

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2112

|protocolType|ID типа протокола

2113

2114

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2115

2116

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2117

2118

(% class="box infomessage" %)

2119

(((

2120

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2121

)))

2122

2123

(% style="color:#000000" %)Метод запроса: **POST**

2124

2125

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2126

2127

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2128

2129

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2134

"vehicleIds": [0], ~/~/ Список ID объектов

2135

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2136

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2137

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2145

"name": "string", ~/~/ Имя ТС

2146

"periods": [ ~/~/ Периоды

2147

{

2148

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2149

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2150

"mileageBegin": 0, ~/~/ Пробег на начало периода

2151

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2152

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2153

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2160

2161

(% class="box infomessage" %)

2162

(((

2163

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2164

)))

2165

2166

(% style="color:#000000" %)Метод запроса: **POST**

2167

2168

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2169

2170

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2171

2172

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2177

"vehicleIds": [0], ~/~/ Список ID объектов

2178

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2179

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2180

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2188

"name": "string", ~/~/ Имя ТС

2189

"periods": [ ~/~/ Периоды

2190

{

2191

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2192

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2193

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2194

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2195

"fuelConsumption": 0, ~/~/ Расход топлива

2196

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2203

2204

(% class="box infomessage" %)

2205

(((

2206

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2207

)))

2208

2209

(% style="color:#000000" %)Метод запроса: **POST**

2210

2211

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2212

2213

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2214

2215

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2220

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2221

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2222

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2230

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2231

"vehicleId": 0, ~/~/ ID объекта

2232

"name": "string", ~/~/ Имя объекта

2233

"model": "string", ~/~/ Модель объекта

2234

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2235

{

2236

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2237

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2238

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2239

"valueFuel": 0, ~/~/ Количество

2240

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2241

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2249

2250

(% class="box infomessage" %)

2251

(((

2252

**POST /api/v3/vehicles/moveStop**

2253

)))

2254

2255

Метод запроса: **POST**

2256

2257

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2258

2259

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2267

2268

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2269

2270

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2271

2272

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2283

2284

"vehicleName": "string", ~/~/ Имя объекта

2285

2286

"moves": [ ~/~/ Событие движения

{

"mileage": 0, ~/~/ Пробег, км

2291

2292

"eventId": 0, ~/~/ Идентификатор события

2293

2294

"eventName": "string", ~/~/ Название события

2295

2296

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2297

2298

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2299

2300

"duration": 0 ~/~/ Продолжительность события, секунд

}

],

"stops": [ ~/~/ События стоянок

{

"address": "string", ~/~/ Адрес события

2311

2312

"eventId": 0, ~/~/ Идентификатор события

2313

2314

"eventName": "string", ~/~/ Название события

2315

2316

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2317

2318

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2319

2320

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2334

2335

(% class="box infomessage" %)

2336

(((

2337

**POST /api/v3/vehicles/getlastdata**

2338

)))

2339

2340

Метод запроса: **POST**

2341

2342

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2343

2344

В заголовках запроса: X-Auth: Токен авторизации

2345

2346

2347

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2352

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2353

"vehicleNumber": "string",~/~/Номер объекта.

2354

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2355

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2356

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2357

"speed": 0,~/~/Скорость объекта.

2358

"course": 0,~/~/Курс движения [0;360]

2359

"latitude": 0,~/~/Широта [-90°;90°].

2360

"longitude": 0,~/~/Долгота [-180°;180°].

2361

"address": "string",~/~/Адрес.

2362

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2371

2372

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2373

2374

(% class="box infomessage" %)

2375

(((

2376

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2377

)))

2378

2379

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2380

2381

(% style="color:#000000" %)Метод запроса: **POST**

2382

2383

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2384

2385

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2386

2387

(% style="text-align:left" %)

2388

Тело запроса:

2389

2390

(% style="text-align:left" %)

2391

{

2392

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2393

}

2394

2395

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2401

"name": "string", ~/~/ Название объекта геозоны

2402

"type": 0, ~/~/ Тип объекта геозоны

2403

"fname": "string", ~/~/ Имя файла

2404

"parentId": "string", ~/~/ Идентификатор клиента

2405

"radius": 0, ~/~/ Радиус геообъекта

2406

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2407

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2408

"description": "string", ~/~/ Описание

2409

"area": 0, ~/~/ Площадь, м^^2^^

2410

"perimetr": 0, ~/~/ Периметр, м

2411

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2416

2417

(% class="box infomessage" %)

2418

(((

2419

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2420

)))

2421

2422

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2423

2424

(% style="color:#000000" %)Метод запроса: **POST**

2425

2426

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2427

2428

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2429

2430

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2435

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2436

"ids": [ ], ~/~/ Массив id объектов

2437

"byTime": 0, ~/~/ Объединение событий по времени

2438

"byDist": 0, ~/~/ Объединение событий по расстоянию

2439

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2440

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2447

"geozoneName": "string", ~/~/ Название геообъекта

2448

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2449

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2450

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2451

"vehicleId": 0, ~/~/ ID объекта

2452

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2457

2458

(% class="box infomessage" %)

2459

(((

2460

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2461

)))

2462

2463

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2464

2465

(% style="color:#000000" %)Метод запроса: **POST**

2466

2467

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2468

2469

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2470

2471

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2476

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2477

"ids": [ ], ~/~/ Массив id геообъектов

2478

"byTime": 0, ~/~/ Объединение событий по времени

2479

"byDist": 0, ~/~/ Объединение событий по расстоянию

2480

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2481

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2489

"geozoneName": "string", ~/~/ Название геообъекта

2490

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2491

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2492

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2493

"vehicleId": 0, ~/~/ ID объекта

2494

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2499

2500

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2501

2502

(% class="box infomessage" %)

2503

(((

2504

**POST /api/v3/notifications/find**

2505

)))

2506

2507

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2508

2509

(% style="text-align: left;" %)

2510

Метод запроса **POST**

2511

2512

(% style="text-align: left;" %)

2513

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2514

2515

(% style="text-align: left;" %)

2516

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2517

2518

{

2519

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2527

"name": "string", ~/~/ Название уведомления

2528

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2529

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2530

"userId": "", ~/~/ Пользователь, создавший уведомление

2531

"parentId": "", ~/~/ Идентификатор клиента

2532

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2537

2538

(% class="box infomessage" %)

2539

(((

2540

**GET /api/v3/notifications/{id}**

2541

)))

2542

2543

Метод возвращает данные правил формирования выбранного уведомления.

2544

2545

(% style="text-align: left;" %)

2546

Метод запроса **GET**

2547

2548

(% style="text-align: left;" %)

2549

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2550

2551

(% style="text-align: left;" %)

2552

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2553

2554

(% style="text-align: left;" %)

2555

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2556

2557

(% style="text-align: left;" %)

2558

(% style="color:#000000" %)Ответ:

2559

2560

(% style="text-align: left;" %)

2561

(% style="color:#000000" %){

2562

"id": 0, ~/~/ (%%)id уведомления

2563

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2564

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2565

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2566

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2567

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2568

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2569

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2570

(% style="color:#000000" %) 0

2571

],

2572

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2573

(% style="color:#000000" %) 0

2574

],

2575

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2576

(% style="color:#000000" %) 0

2577

],

2578

"settings": { ~/~/ Список параметров уведомления

2579

"additionalProp1": "string",

2580

"additionalProp2": "string",

2581

"additionalProp3": "string"

2582

},

2583

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2584

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2585

(% style="color:#000000" %) ""

2586

],

2587

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2588

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2589

(% style="color:#000000" %) "string"

2590

],

2591

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2592

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2593

(% style="color:#000000" %) {

2594

"id": 0, ~/~/ (%%)Идентификатор участника чата

2595

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2596

(% style="color:#000000" %) }

2597

],

2598

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2599

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2600

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2601

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2602

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2603

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2604

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2605

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2606

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2607

(% style="color:#000000" %)}

2608

2609

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2610

2611

(% class="box warningmessage" %)

2612

(((

2613

**PUT /api/v3/notifications/**

2614

)))

2615

2616

Метод позволяет отредактировать уведомление.

2617

2618

Метод запроса **PUT**

2619

2620

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2621

2622

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2627

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2628

"userId": "", ~/~/ Пользователь, создавший уведомление

2629

"parentId": "", ~/~/ Идентификатор клиента

2630

"parentName": "string", ~/~/ Имя клиента

2631

"name": "string", ~/~/ Название уведомления

2632

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2633

"vehicleIds": [ ~/~/ Список id объектов для анализа

2634

0

2635

],

2636

"geoids": [ ~/~/ Список id геообъектов для анализа

2637

0

2638

],

2639

"fieldids": [ ~/~/ Список id полей для анализа

2640

0

2641

],

2642

"settings": { ~/~/ Список параметров уведомления

2643

"additionalProp1": "string",

2644

"additionalProp2": "string",

2645

"additionalProp3": "string"

2646

},

2647

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2648

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2649

""

2650

],

2651

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2652

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2653

"string"

2654

],

2655

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2656

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2657

{

2658

"id": 0, ~/~/ Идентификатор участника чата

2659

"info": "string" ~/~/ Дополнительные сведения

2660

}

2661

],

2662

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2663

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2664

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2665

"kind": 0, ~/~/ Определяет вид уведомления

2666

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2667

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2668

"timezone": 0, ~/~/ Сдвиг часового пояса

2669

"validity": 0, ~/~/ Срок действия в днях (1-90)

2670

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2678

2679

(% class="box errormessage" %)

2680

(((

2681

**DELETE /api/v3/notifications/{id}**

2682

)))

2683

2684

Метод позволяет удалить выбранное уведомление.

2685

2686

Метод запроса **DELETE**

2687

2688

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2689

2690

Передаваемый параметр: {id} - id уведомления

2691

2692

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2700

2701

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2702

2703

(% class="box infomessage" %)

2704

(((

2705

**POST /api/v3/Drivers/find**

2706

)))

2707

2708

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2715

"description": "string", ~/~/ Определяет описание

2716

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2717

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2718

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2719

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2720

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2721

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2726

2727

(% class="box infomessage" %)

2728

(((

2729

**GET /api/v3/Drivers/{driverGuid}**

2730

)))

2731

2732

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2738

"description": "string", ~/~/ Определяет описание

2739

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2740

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2741

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2742

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2743

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2744

"deleted": true ~/~/ Признак удаления

2745

}

2746

2747

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2748

2749

(% class="box successmessage" %)

2750

(((

2751

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2759

"hiredate": "2023-06-30T12:50:54.020Z",

2760

"chopdate": "2023-06-30T12:50:54.020Z",

2761

"exclusive": true,

2762

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2763

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2772

"hiredate": "2023-06-30T12:50:54.051Z",

2773

"chopdate": "2023-06-30T12:50:54.051Z",

2774

"exclusive": true,

2775

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2776

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2782

2783

(% class="box warningmessage" %)

2784

(((

2785

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2793

"hiredate": "2023-06-30T12:50:27.910Z",

2794

"chopdate": "2023-06-30T12:50:27.910Z",

2795

"exclusive": true,

2796

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2797

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2806

"hiredate": "2023-06-30T12:50:27.929Z",

2807

"chopdate": "2023-06-30T12:50:27.929Z",

2808

"exclusive": true,

2809

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2810

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2816

2817

(% class="box errormessage" %)

2818

(((

2819

**DELETE /api/v3/Drivers/{driverGuid}**

2820

)))

2821

2822

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2830

2831

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2832

2833

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2834

2835

(% class="box infomessage" %)

2836

(((

2837

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2845

],

2846

"BeginTime": "2023-06-30T12:49:04.365Z",

2847

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2856

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2857

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2858

"BeginTime": "2023-06-30T09:52:31.240Z",

2859

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2865

2866

(% class="box infomessage" %)

2867

(((

2868

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2878

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2887

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2888

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2889

"BeginTime": "2023-06-30T09:54:01.631Z",

2890

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2896

2897

(% class="box successmessage" %)

2898

(((

2899

**POST /api/v3/DriversVehiclesAssignments**

2900

)))

2901

2902

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2909

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2910

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2911

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2912

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2922

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2923

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2924

"BeginTime": "2023-06-30T11:04:46.903Z",

2925

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2931

2932

(% class="box warningmessage" %)

2933

(((

2934

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2943

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2944

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2945

"BeginTime": "2023-06-30T11:14:08.117Z",

2946

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2956

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2957

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2958

"BeginTime": "2023-06-30T11:14:53.349Z",

2959

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2965

2966

(% class="box errormessage" %)

2967

(((

2968

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2983

2984

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2985

2986

(% class="box infomessage" %)

2987

(((

2988

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2996

],

2997

"BeginTime": "2023-06-30T12:47:12.162Z",

2998

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3006

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3007

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3008

"BeginTime": "2023-06-30T11:19:40.703Z",

3009

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

3015

3016

(% class="box infomessage" %)

3017

(((

3018

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3026

],

3027

"BeginTime": "2023-06-30T12:47:12.162Z",

3028

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3036

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3037

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3038

"BeginTime": "2023-06-30T11:19:40.703Z",

3039

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

3045

3046

(% class="box successmessage" %)

3047

(((

3048

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3056

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3057

"BeginTime": "2023-06-30T11:27:08.635Z",

3058

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3067

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3068

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3069

"BeginTime": "2023-06-30T11:27:08.677Z",

3070

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3076

3077

(% class="box warningmessage" %)

3078

(((

3079

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3087

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3088

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3089

"BeginTime": "2023-06-30T11:28:43.330Z",

3090

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3099

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3100

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3101

"BeginTime": "2023-06-30T11:28:43.331Z",

3102

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3108

3109

(% class="box errormessage" %)

3110

(((

3111

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3126

3127

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3128

3129

(% class="box infomessage" %)

3130

(((

3131

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3139

],

3140

"BeginTime": "2023-06-30T12:45:10.852Z",

3141

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3149

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3150

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3151

"BeginTime": "2023-06-30T11:58:04.695Z",

3152

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3158

3159

(% class="box infomessage" %)

3160

(((

3161

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3169

],

3170

"BeginTime": "2023-06-30T12:45:10.852Z",

3171

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3179

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3180

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3181

"BeginTime": "2023-06-30T11:58:04.695Z",

3182

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3188

3189

(% class="box successmessage" %)

3190

(((

3191

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3199

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3200

"BeginTime": "2023-06-30T12:09:53.175Z",

3201

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3210

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3211

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3212

"BeginTime": "2023-06-30T12:09:53.201Z",

3213

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3219

3220

(% class="box warningmessage" %)

3221

(((

3222

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3230

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3231

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3232

"BeginTime": "2023-06-30T12:09:53.201Z",

3233

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3242

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3243

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3244

"BeginTime": "2023-06-30T12:09:53.201Z",

3245

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3251

3252

(% class="box errormessage" %)

3253

(((

3254

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3269

3270

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3271

3272

(% class="box infomessage" %)

3273

(((

3274

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3281

"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);" %)**Описание**

3287

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3288

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3289

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3290

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3297

"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",

3307

"name": "string",

3308

"rid": "string",

3309

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3310

"trailer": {

3311

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3312

"Number": "string",

3313

"Description": "string",

3314

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3315

"ExternalID": "string",

3316

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3317

"CreateTime": "2023-11-14T10:48:03.717Z",

3318

"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);" %)**Описание**

3326

|SD|Дата и время начала события

3327

|ED|Дата и время окончания события

3328

|id|ID объекта

3329

|SLat|Широта начальной координаты

3330

|SLon|Долгота начальной координаты

3331

|ELat|Широта конечной координаты

3332

|ELon|Долгота конечной координаты

3333

|mileage|Пробег

3334

|Duration|Продолжительность

3335

|Address|Адрес начального местоположения

3336

|Address2|Адрес конечного местоположения

3337

|name|Имя радиометки

3338

|rid|Номер радиометки

3339

|rguid|ID радиометки

3340

|trailer|Информация об агрегате

3341

|ModelGuid|ID агрегата

3342

|Number|Название/номер агрегата

3343

|Description|Текст примечания агрегата

3344

3345

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3346

3347

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3348

3349

(% class="box infomessage" %)

3350

(((

3351

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3368

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3373

|parentId|ID клиента

3374

|name|Название карты-метки

3375

|number|Номер

3376

|period|Период запросов в секундах (работает только для агрегатов)

3377

|id|ID карты-метки

3378

3379

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3380

3381

(% class="box infomessage" %)

3382

(((

3383

**GET /api/v3/Rfids/{rfidGuid}**

3384

)))

3385

3386

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3396

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3401

|name|Название карты-метки

3402

|number|Номер

3403

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3408

3409

(% class="box successmessage" %)

3410

(((

3411

**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",

3430

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3431

}

3432

3433

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3434

|name|Название карты-метки

3435

|number|Номер

3436

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3441

3442

(% class="box warningmessage" %)

3443

(((

3444

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3454

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3464

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3465

}

3466

3467

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3468

|name|Название карты-метки

3469

|number|Номер

3470

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3475

3476

(% class="box errormessage" %)

3477

(((

3478

**DELETE /api/v3/Rfids/{rfidGuid}**

3479

)))

3480

3481

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3489

3490

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3491

3492

(% class="box infomessage" %)

3493

(((

3494

**GET /api/v3/Billing/client/balance/{clientId}**

3495

)))

3496

3497

Параметр запроса: **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);" %)**Описание**

3507

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3508

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3509

3510

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3511

3512

(% class="box infomessage" %)

3513

(((

3514

**GET /api/v3/Billing/client/constraint/{clientId}**

3515

)))

3516

3517

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3523

"CalculationType": 0,

3524

"PermissibleBalance": 0,

3525

"DefermentDays": 0,

3526

"SendUiNotifications": true,

3527

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3532

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3533

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3534

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3535

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3536

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3537

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3538

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3539

3540

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3541

3542

(% class="box infomessage" %)

3543

(((

3544

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3550

3551

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3557

"Plan": { **~/~/ Описание тарифного плана**

3558

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3559

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3564

"PermissibleBalance": 0,

3565

"DefermentDays": 0

3566

},

3567

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3579

"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);" %)**Описание**

3595

|ClientId|Идентификатор клиента

3596

|Id|Идентификатор тарифного плана

3597

|OwnerId|Идентификатор клиента-владельца

3598

|Name|Наименование тарифного плана

3599

|IsArchived|Признак, определяющий архивный тарифный план

3600

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3601

|PermissibleBalance|Допустимый баланс

3602

|DefermentDays|Отсрочка, количество дней

3603

|Feature|Код услуги

3604

|IsEnabled|Признак, определяющий активирована ли услуга

3605

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3606

|IsFactual|Признак, определяющий расчёт по факту

3607

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3608

|Price|Цена за единицу.

3609

|DebitDate|Следующий момент времени списания с баланса за услугу.

3610

|PeriodValue|Значение периода.

3611

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3612

3613

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3614

3615

(% class="box infomessage" %)

3616

(((

3617

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3618

)))

3619

3620

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3627

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3632

"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);" %)**Описание**

3649

|ClientId|Идентификатор клиента

3650

|Id|Идентификатор тарифного плана

3651

|OwnerId|Идентификатор клиента-владельца

3652

|Name|Наименование тарифного плана

3653

|IsArchived|Признак, определяющий архивный тарифный план

3654

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3655

|PermissibleBalance|Допустимый баланс

3656

|DefermentDays|Отсрочка, количество дней

3657

|Feature|Код услуги

3658

|IsFactual|Признак, определяющий расчёт по факту

3659

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3660

|Price|Цена за единицу.

3661

|PeriodValue|Значение периода.

3662

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3663

3664

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3665

3666

(% class="box infomessage" %)

3667

(((

3668

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3669

)))

3670

3671

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3678

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3683

"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);" %)**Описание**

3700

|ClientId|Идентификатор клиента

3701

|Id|Идентификатор тарифного плана

3702

|OwnerId|Идентификатор клиента-владельца

3703

|Name|Наименование тарифного плана

3704

|IsArchived|Признак, определяющий архивный тарифный план

3705

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3706

|PermissibleBalance|Допустимый баланс

3707

|DefermentDays|Отсрочка, количество дней

3708

|Feature|Код услуги

3709

|IsFactual|Признак, определяющий расчёт по факту

3710

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3711

|Price|Цена за единицу.

3712

|PeriodValue|Значение периода.

3713

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3714

3715

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3716

3717

(% class="box warningmessage" %)

3718

(((

3719

**PUT /api/v3/Billing/client/balance**

3720

)))

3721

3722

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3734

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3735

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3736

3737

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3738

3739

(% class="box warningmessage" %)

3740

(((

3741

**PUT /api/v3/billing/client/balance/deposit**

3742

)))

3743

3744

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3756

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3757

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3758

3759

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3760

3761

Создает операцию **Списание **с указанной суммой

3762

3763

(% class="box warningmessage" %)

3764

(((

3765

**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);" %)**Описание**

3778

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3779

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3780

3781

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3782

3783

(% class="box warningmessage" %)

3784

(((

3785

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3792

"CalculationType": 0,

3793

"PermissibleBalance": 0,

3794

"DefermentDays": 0,

3795

"SendUiNotifications": true,

3796

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3803

|ClientId|Идентификатор клиента

3804

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3805

|PermissibleBalance|Допустимый баланс

3806

|DefermentDays|(((

3807

Отсрочка, количество дней

3808

)))

3809

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3810

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3811

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3812

3813

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3814

3815

(% class="box warningmessage" %)

3816

(((

3817

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3824

"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);" %)**Описание**

3842

|ClientId|Идентификатор клиента

3843

|PlanId|Идентификатор тарифного плана

3844

|Feature|Код услуги

3845

|IsEnabled|Признак, определяющий активирована ли услуга

3846

|IsFactual|Признак, определяющий расчёт по факту

3847

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3848

|Price|Цена за единицу.

3849

|DebitDate|Следующий момент времени списания с баланса за услугу.

3850

|PeriodValue|Значение периода.

3851

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3852

3853

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3854

3855

(% class="box warningmessage" %)

3856

(((

3857

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3858

)))

3859

3860

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3861

3862

(% class="box infomessage" %)

3863

(((

3864

**POST /api/v3/vehicles/import/{agentId}**

3865

)))

3866

3867

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3868

3869

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3878

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3879

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3880

3881

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3886

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3887

|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);" %)**Описание**

3898

|vehicleId|ID созданного объекта

3899

|name|Имя созданного объекта

3900

|errors|Ошибки и их описание

3901

3902

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3903

3904

(% class="box infomessage" %)

3905

(((

3906

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3907

)))

3908

3909

(% class="wikigeneratedid" %)

3910

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3911

3912

(% class="wikigeneratedid" %)

3913

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3918

3919

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3924

|**history**|В значении передавать файл с историей

3925

3926

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3939

"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);" %)**Описание**

3947

|results|Результаты импорта в разрезе ТС

3948

|vehicleGuid|Guid ТС

3949

|vehicleId|ID ТС

3950

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3951

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3952

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3953

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3954

|msgCount|Кол-во обработанных сообщений всего

3955

3956

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3957

3958

(% class="box infomessage" %)

3959

(((

3960

**GET /api/v3/vehicles/import/history/status**

3961

)))

3962

3963

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3974

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3975

|progress|Guid ТС

3976

3977

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3978

3979

(% class="box infomessage" %)

3980

(((

3981

**POST /api/v3/vehicles/export**

3982

)))

3983

3984

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3993

3994

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3995

3996

(% class="box infomessage" %)

3997

(((

3998

**POST /api/v3/vehicles/export/history**

3999

)))

4000

4001

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4009

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4015

4016

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4017

|vehicleId|ID объекта

4018

|asArchive|true - Архивировать файл, False - не архивировать

4019

|from|Дата и время начала запроса

4020

|to|Дата и время окончания запроса

4021

4022

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4023

4024

(% class="box infomessage" %)

4025

(((

4026

**GET /api/v3/vehicles/export/history/status**

4027

)))

4028

4029

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4040

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4041

|progress|Прогресс экспорта, от 0 до 100%

4042

|message|Текст описывающий статус

4043

4044

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4045

4046

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4047

4048

(% class="box infomessage" %)

4049

(((

4050

**POST /api/v3/EcoDriving/rating**

4051

)))

4052

4053

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

4059

"from": "2023-11-22T09:29:48.051Z",

4060

"to": "2023-11-22T09:29:48.051Z"

4061

}

4062

4063

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4064

|vehicleIds|Массив ID объектов

4065

|from|Дата начала запроса

4066

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

4074

"to": "2023-11-22T09:29:48.052Z",

4075

"vehicleId": 0,

4076

"vehicleName": "string",

4077

"vehicleModel": "string",

4078

"penalty": 0,

4079

"score": 0,

4080

"totalViolations": 0,

4081

"violationsByType": {

4082

"overspeedingViolations": 0,

4083

"accelerationViolations": 0,

4084

"brakingViolations": 0,

4085

"turningViolations": 0,

4086

"dangerousDrivingViolations": 0,

4087

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

4097

"violationsByType": {

4098

"overspeedingViolations": 0,

4099

"accelerationViolations": 0,

4100

"brakingViolations": 0,

4101

"turningViolations": 0,

4102

"dangerousDrivingViolations": 0,

4103

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4110

"endAddress": "string",

4111

"drivers": [

4112

{

4113

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4114

"driverName": "string",

4115

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4125

|from|Дата начала запроса

4126

|to|Дата окончания

4127

|vehicleId|ID объекта

4128

|vehicleName|Имя объекта

4129

|vehicleModel|Модель объекта

4130

|penalty|Сумма штрафных баллов

4131

|score|Оценка

4132

|totalViolations|Суммарное количество нарушений

4133

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4134

|overspeedingViolations|Превышение скорости

4135

|accelerationViolations|Ускорение

4136

|brakingViolations|Торможение

4137

|turningViolations|Резкий поворот

4138

|dangerousDrivingViolations|Резкое вождение

4139

|sensorViolations|Нарушение по датчику

4140

|moveTime|Время в движении

4141

|mileage|Пробег

4142

|tripsCount|Количество рейсов

4143

|motohours|Моточасы

4144

|maxSpeed|Максимальная скорость

4145

|startAddress|Адрес начала рейса

4146

|endAddress|Адрес окончания рейса

4147

|drivers|Список водителей, которые были на объекте в течениии рейса

4148

|driverGuid|Guid водителя

4149

|driverName|Имя водителя

4150

|driverRfid|Номер Карты-метки

4151

4152

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4153

4154

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4155

4156

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4157

4158

(% class="box infomessage" %)

4159

(((

4160

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4166

\\В заголовках запроса: X-Auth: Токен авторизации

4167

4168

Параметры в теле запроса (JSON):

{

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4173

4174

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

"ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

],

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4191

4192

"driver": "string", ~/~/Водители, привязанные к ТК

4193

4194

"object": "string", ~/~/Наименование ТС

4195

4196

"amount": 0, ~/~/Количество топлива

4197

4198

"amountDut": 0, ~/~/Количество по ДУТ

4199

4200

"amountDiff": 0, ~/~/Разница, л

4201

4202

"amountDiffPerc": 0, ~/~/Разница, %

4203

4204

"summa": 0, ~/~/Стоимость, руб

4205

4206

"serviceName": "string", ~/~/Тип топлива

4207

4208

"price": 0, ~/~/Цена за литр, руб

4209

4210

"cardName": "string", ~/~/Наименование ТК

4211

4212

"cardNum": "string", ~/~/Номер ТК

4213

4214

"operator": "string", ~/~/Оператор ТК

4215

4216

"address": "string" ~/~/Адрес АЗС

}

==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====

4222

4223

4224

==== **Получение полных данных о ретрансляторе** ====

4225

4226

(% class="box infomessage" %)

4227

(((

4228

**GET ** **/api/v3/retranslations/{id}**

4229

)))

4230

4231

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4239

4240

"subscriberId": "", ~/~/ Подписчик

4241

4242

"protocolType": 0, ~/~/ Тип протокола

4243

4244

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4245

4246

"address": "string", ~/~/ Адрес события

4247

4248

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ Идентификатор объекта ретрансляции

4253

4254

"name": "", ~/~/ Наименование объекта ретрансляции

4255

4256

"imei": "", ~/~/ IMEI объекта

4257

4258

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

"id": "", ~/~/ идентификатор пользователя

4265

4266

"parentId": "", ~/~/Guid родителя

4267

4268

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

==== **Удаление данных ретранслятора** ====

4274

4275

(% class="box infomessage" %)

4276

(((

4277

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

==== **Создание ретранслятора** ====

4284

4285

(% class="box infomessage" %)

4286

(((

4287

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4296

4297

"subscriberId": "", ~/~/ Подписчик

4298

4299

"protocolType": 0, ~/~/ Тип протокола

4300

4301

"address": "", ~/~/ Адрес ретрансляции

4302

4303

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4304

4305

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ идентификатор пользователя

4310

4311

"imei": "", ~/~/IMEI объекта

4312

4313

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ

{

"description": "string", ~/~/ Определяет описание

4328

4329

"subscriberId": "", ~/~/ идентификатор запроса

4330

4331

"protocolType": 0, ~/~/ Тип протокола

4332

4333

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4334

4335

"address": "", ~/~/ Адрес события

4336

4337

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ идентификатор пользователя

4342

4343

"name": "string", ~/~/ Название уведомления

4344

4345

"imei": "string", ~/~/IMEI объекта

4346

4347

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

"id": "", ~/~/ идентификатор пользователя

4354

4355

"parentId": "", ~/~/ Guid идентификатор родителя

4356

4357

"deleted": true ~/~/ Признак удаления

}

==== **Редактирование ретранслятора** ====

4363

4364

(% class="box infomessage" %)

4365

(((

4366

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4374

4375

"description": "string", ~/~/ Определяет описание

4376

4377

"subscriberId": "", ~/~/ идентификатор запроса

4378

4379

"protocolType": 0, ~/~/ Тип протокола

4380

4381

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4382

4383

"address": "string", ~/~/ Адрес события

4384

4385

"objects": ~/~/Объекты для ретрансляции

[

{

"id": "", ~/~/ идентификатор пользователя

4392

4393

"imei": "", ~/~/IMEI объекта

4394

4395

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4409

4410

"subscriberId": "", ~/~/ идентификатор запроса

4411

4412

"protocolType": 0, ~/~/ Тип протокола

4413

4414

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4415

4416

"address": "string", ~/~/ Адрес события

4417

4418

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ идентификатор пользователя

4423

4424

"name": "string", ~/~/ Название уведомления

4425

4426

"imei": "", ~/~/IMEI объекта

4427

4428

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

"id": "", ~/~/ идентификатор пользователя

4435

4436

"parentId": "", ~/~/ Guid идентификатор родителя

4437

4438

"deleted": true ~/~/ Признак удаления

}

==== **Получение списка ретранслятора клиента** ====

4445

4446

(% class="box infomessage" %)

4447

(((

4448

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4457

4458

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4459

4460

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ

[

{

"description": "", ~/~/ Определяет описание

4474

4475

"subscriberId": "", ~/~/ идентификатор запроса

4476

4477

"protocolType": 0, ~/~/ Тип протокола

4478

4479

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4480

4481

"address": "string", ~/~/ Адрес события

4482

4483

"id": "", ~/~/ идентификатор пользователя

4484

4485

"parentId": "", ~/~/ Guid идентификатор родителя

4486

4487

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =

4495

4496

4497

==== **API для отчета по выгрузке комбайнов** ====

4498

4499

4500

(% class="box infomessage" %)

4501

(((

4502

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4511

4512

"byDist": 0, ~/~/ Объединение событий по расстоянию

4513

4514

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4515

4516

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4517

4518

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4519

4520

"vehicleIds": [ ~/~/ Список id объектов для анализа

0

],

"from": "", ~/~/ Дата и время начало запроса

4527

4528

"to": "", ~/~/ Дата и время окончания запроса

4529

4530

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4544

4545

"harvesterId": 0, ~/~/Комбайн, id

4546

4547

"harvesterModel": "", ~/~/ Модель комбайна

4548

4549

"hopperCapacity": 0, ~/~/ Объем бункера м3

4550

4551

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4552

4553

"events": [ ~/~/Список событий в разрезе комбайна

{

"driverId": "", ~/~/Идентификатор водителя

4558

4559

"driverName": "", ~/~/Водитель комбайна, ФИО

4560

4561

"RFID": "", ~/~/ идентификатор карты-метки

4562

4563

"rfidName": "", ~/~/Водитель комбайна, имя метки

4564

4565

"vehicleId": 0, ~/~/идентификатор объекта

4566

4567

"vehicleName": "string", ~/~/ Имя объекта

4568

4569

"modelName": "string", ~/~/ Имя модели объекта

4570

4571

"nearestVehicles": [ ~/~/Объекты рядом

{

"vehicleId": 0, ~/~/идентификатор объекта

4576

4577

"vehicleName": "string" ~/~/ Имя объекта

}

],

"fields": [ ~/~/Поля, где происходила выгрузка

{

"id": 0, ~/~/ идентификатор пользователя

4588

4589

"name": "string" ~/~/ имя пользователя

}

],

"event": "string", ~/~/Событие

4596

4597

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4598

4599

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4600

4601

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4602

4603

"cultureName": "string", ~/~/ название культуры

4604

4605

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4606

4607

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4608

4609

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4610

4611

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4612

4613

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4614

4615

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4616

4617

"issued": 0, ~/~/Выдано, бункеров

4618

4619

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4620

4621

"latitude": 0, ~/~/Широта

4622

4623

"longitude": 0, ~/~/ Долгота

4624

4625

"litresAway": 0, ~/~/Отдано, л

4626

4627

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4639

4640

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4641

4642

4643

(% class="box infomessage" %)

4644

(((

4645

GET api/v3/Vehicles/recyclebin/all

4646

)))

4647

4648

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4649

4650

Параметр запроса: {parentId} - идентификатор агента

4651

4652

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4661

4662

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4663

4664

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4665

4666

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4667

4668

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4669

4670

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4671

4672

"details": { ~/~/Список деталей объекта, помещённого в корзину

"items": [ ~/~/ [

nullable: true ~/~/Детали

{

"name": "string", ~/~/наименование столбца

4681

4682

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4702

4703

(% class="box infomessage" %)

4704

(((

4705

POST/api/v3/Vehicles/recyclebin/erase

4706

)))

4707

4708

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4727

4728

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4729

4730

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4731

4732

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4733

4734

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4735

4736

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4737

4738

"details": { ~/~/Список деталей объекта, помещённого в корзину

4739

4740

"items": [ ~/~/Детали

{

"name": "", ~/~/Имя свойства

4745

4746

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4765

4766

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4767

4768

(% class="box infomessage" %)

4769

(((

4770

POST/api/v3/Vehicles/recyclebin/restore

4771

)))

4772

4773

В заголовках запроса: X-Auth: Токен авторизации

4774

4775

Параметры в теле запроса (JSON):

4776

4777

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4778

4779

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4798

4799

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4800

4801

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4802

4803

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4804

4805

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4806

4807

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4808

4809

"details": { ~/~/Список деталей объекта, помещённого в корзину

4810

4811

"items": [ ~/~/Детали

{

"name": "string", ~/~/Имя свойства

4816

4817

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4838

(((

4839

(% 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]] **

4840

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню