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

(% class="wikigeneratedid" %)

1213

===== =====

1214

1215

(% class="wikigeneratedid" %)

1216

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

1217

1218

(% class="box infomessage" %)

1219

(((

1220

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

1221

)))

1222

1223

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

1224

1225

1226

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

1227

1228

1229

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

1230

1231

1232

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

1233

1234

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

1235

1236

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

1237

1238

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

1239

1240

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

1241

1242

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

1243

1244

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

1245

1246

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

(((

(% class="wikigeneratedid" %)

1252

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

1253

1254

(% class="box infomessage" %)

1255

(((

1256

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

1257

)))

1258

1259

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

1260

1261

1262

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

1263

1264

1265

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

[

{

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

1273

1274

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

1275

1276

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

1277

1278

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

1279

1280

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

1281

1282

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

1283

1284

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

}

]

)))

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

1294

1295

(% class="box successmessage" %)

1296

(((

1297

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

1298

)))

1299

1300

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

1301

1302

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

1303

1304

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

1305

1306

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

1307

1308

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

1309

1310

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

1311

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

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

1331

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

1332

1333

"mileageCalcMethod": 0,

1334

"mileageCoeff": 0,

1335

"locationByCellId": true,

1336

"dottedLineTrackWhenNoCoords": true,

1337

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

1338

{

1339

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

1340

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

1341

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

1342

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

1343

},

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

},

1351

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

1352

{

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

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

1361

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

1362

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

1363

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

1364

}

1365

1366

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

1367

{

1368

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

"isDefault": true

}

],

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

1373

{

1374

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1382

{

1383

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

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

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

1394

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

1395

{

1396

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

1397

{

1398

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

1399

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

1400

}

1401

],

1402

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

1403

}

1404

],

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

"string"

1413

],

1414

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

1415

"additionalProp1": "string",

1416

"additionalProp2": "string",

1417

"additionalProp3": "string"

1418

},

1419

1420

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

1421

1422

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

1423

1424

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

1425

1426

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

1427

1428

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

1429

1430

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

1431

1432

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

1433

1434

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

1435

1436

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

1437

1438

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

1439

1440

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

1441

1442

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

1443

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

1444

}

1445

],

1446

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

1447

{

1448

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1459

1460

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

1461

1462

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

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

1469

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

1470

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

1471

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

1472

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

1473

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

1474

"mileageEnabled": true,

1475

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1480

"id": null,

1481

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

1482

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

1483

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

1484

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

1485

},

1486

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

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

1495

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

1496

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

1497

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

1498

}

1499

1500

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

1501

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

1502

1503

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

1504

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

1505

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

1506

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

1507

1508

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

1509

1510

(% class="box infomessage" %)

1511

(((

1512

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

1513

)))

1514

1515

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

1516

1517

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

1518

1519

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

1520

1521

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

1522

1523

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

1524

1525

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

1526

1527

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

1528

1529

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

1530

1531

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

1532

1533

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

1534

1535

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

1536

1537

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

1538

1539

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

1540

1541

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

1542

1543

{

1544

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

1545

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

1546

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

1547

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

1548

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

1549

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

1550

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

1551

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

1552

}

1553

1554

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

1555

1556

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

1557

1558

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

1559

1560

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

1561

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

1562

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

1563

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

1564

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

1565

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

1566

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

1567

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

1568

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

1569

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

1570

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

1571

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

1572

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

1573

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

1574

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

1575

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

1576

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

1577

"customFields": [

1578

{

1579

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

1580

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

1581

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

1582

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

1583

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

1584

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

1585

}(%%)

1586

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

1587

1588

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

1589

1590

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

1591

1592

(% class="box successmessage" %)

1593

(((

1594

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

1595

)))

1596

1597

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

1598

1599

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

1600

1601

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

1602

1603

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

1604

1605

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

1606

1607

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

1608

1609

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

1610

1611

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

1612

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

1613

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

1614

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

1615

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

1616

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

1617

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

1618

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

1619

1620

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

1621

1622

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

1623

1624

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

1625

1626

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

1627

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

1628

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

1629

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

1630

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

1631

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

1632

1633

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

1634

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

1635

1636

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

1637

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

1638

1639

(% class="box successmessage" %)

1640

(((

1641

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

1642

)))

1643

1644

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

{

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

1650

1651

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

1652

1653

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

1654

1655

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

}

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

1661

1662

(% class="box warningmessage" %)

1663

(((

1664

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

1665

)))

1666

1667

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

1668

1669

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

1670

1671

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

1672

1673

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

1674

1675

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

1676

1677

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

1678

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

1679

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

1680

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

1681

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

1682

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

1683

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

1684

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

1685

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

1686

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

1687

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

1688

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

1689

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

1690

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

1691

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

1692

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

1693

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

1694

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

1695

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

1696

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

1697

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

1698

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

1699

1700

"mileageCalcMethod": 0,

1701

"mileageCoeff": 0,

1702

"locationByCellId": true,

1703

"dottedLineTrackWhenNoCoords": true,

1704

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

1705

{

1706

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

1707

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

1708

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

1709

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

1710

},

1711

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

1712

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

1713

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

1714

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

1715

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

1716

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

1717

},

1718

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

1719

{

1720

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

1721

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

1722

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

1723

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

1724

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

1725

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

1726

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

1727

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

1728

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

1729

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

1730

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

1731

}

1732

1733

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

1734

{

1735

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

"isDefault": true

}

],

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

1740

{

1741

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1749

{

1750

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

1751

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

1752

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

1753

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

1754

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

1755

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

1756

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

1757

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

1758

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

1759

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

1760

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

1761

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

1762

{

1763

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

1764

{

1765

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

1766

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

1767

}

1768

],

1769

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

1770

}

1771

],

1772

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

1773

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

1774

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

1775

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

1776

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

1777

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

1778

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

1779

"string"

1780

],

1781

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

1782

"additionalProp1": "string",

1783

"additionalProp2": "string",

1784

"additionalProp3": "string"

1785

},

1786

1787

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

1788

1789

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

1790

1791

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

1792

1793

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

1794

1795

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

1796

1797

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

1798

1799

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

1800

1801

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

1802

1803

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

1804

1805

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

1806

1807

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

1808

1809

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

1810

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

1811

}

1812

],

1813

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

1814

{

1815

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1826

1827

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

1828

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

1829

1830

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

1831

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

1832

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

1833

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

1834

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

1835

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

1836

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

1837

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

1838

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

1839

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

1840

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

1841

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

1842

"counters":

1843

{

1844

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

1845

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

1846

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

1847

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

1848

}

1849

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

1850

{

1851

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

1852

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

1853

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

1854

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

1855

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

1856

}

1857

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

1858

{

1859

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

1860

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

1861

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

1862

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

1863

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

1864

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

1865

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

1866

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

1867

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

1868

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

1869

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

1870

}

1871

1872

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

1873

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

1874

1875

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

1876

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

1877

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

1878

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

1879

1880

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

1881

1882

(% class="box errormessage" %)

1883

(((

1884

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

1885

)))

1886

1887

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

1888

1889

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

1890

1891

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

1892

1893

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

1894

1895

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

1896

1897

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

1898

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

1899

1900

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

1901

1902

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

1903

1904

(% class="box infomessage" %)

1905

(((

1906

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

1907

)))

1908

1909

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

1910

1911

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

1912

1913

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

1914

1915

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

1916

1917

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

1918

1919

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

1920

1921

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

1922

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

1923

1924

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

1925

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

1926

1927

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

1928

1929

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

1930

1931

(% class="box infomessage" %)

1932

(((

1933

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

1934

)))

1935

1936

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

1937

1938

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

1939

1940

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

1941

1942

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

1943

1944

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

1945

1946

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

1947

1948

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

1949

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

1950

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

1951

1952

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

1953

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

1954

1955

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

1956

1957

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

1958

1959

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

1960

(((

1961

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

1962

)))

1963

1964

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

1965

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

1966

1967

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

1968

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

1969

1970

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

1971

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

1972

1973

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

1974

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

1975

1976

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

1977

{

1978

"vehicleIds": [

1979

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

1980

],

1981

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

1982

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

1983

}

1984

1985

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

1986

Ответ:

1987

1988

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

1989

[

1990

{

1991

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

1992

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

}

]

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

1997

1998

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

1999

(((

2000

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

2001

)))

2002

2003

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

2004

2005

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

2006

2007

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

2015

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

2016

|params|(((

2017

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

)))

Ответ:

{

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

2037

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

2038

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

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2044

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

2045

2046

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

2047

2048

(% class="box infomessage" %)

2049

(((

2050

**POST /api/v3/terminalMessages**

2051

)))

2052

2053

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

2054

2055

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

2056

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

2057

2058

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

2059

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

2060

2061

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

2062

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

2063

2064

{

2065

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

2066

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

2067

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

2068

}

2069

2070

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

2071

|vehicleId|ID объекта

2072

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

2073

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

Ответ:

[

{

"messages": [

{

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

2082

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

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2092

"additionalProp2": "string",

2093

"additionalProp3": "string"

2094

},

2095

"photoCount": 0,

2096

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

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

2104

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

2105

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

2106

|speed|Скорость

2107

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

2108

|latitude|Широта

2109

|longitude|Долгота

2110

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

2111

|course|Курс

2112

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

2113

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

2114

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

2115

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

2116

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

2117

2118

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

2119

2120

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

2121

2122

(% class="box infomessage" %)

2123

(((

2124

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

2125

)))

2126

2127

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

2128

2129

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

2130

2131

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

2132

2133

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

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

{

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

2138

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

2139

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

2140

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

2141

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

}

Ответ:

[

{

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

2149

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

2150

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

2151

{

2152

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

2153

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

2154

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

2155

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

2156

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

2157

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

}

]

}

]

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

2164

2165

(% class="box infomessage" %)

2166

(((

2167

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

2168

)))

2169

2170

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

2171

2172

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

2173

2174

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

2175

2176

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

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

{

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

2181

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

2182

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

2183

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

2184

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

}

Ответ:

[

{

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

2192

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

2193

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

2194

{

2195

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

2196

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

2197

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

2198

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

2199

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

2200

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

}

]

}

]

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

2207

2208

(% class="box infomessage" %)

2209

(((

2210

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

2211

)))

2212

2213

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

2214

2215

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

2216

2217

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

2218

2219

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

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

{

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

2224

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

2225

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

2226

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

}

Ответ:

[

{

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

2234

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

2235

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

2236

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

2237

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

2238

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

2239

{

2240

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

2241

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

2242

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

2243

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

2244

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

2245

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

}

]

}

]

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

2253

2254

(% class="box infomessage" %)

2255

(((

2256

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

2257

)))

2258

2259

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

2260

2261

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

2262

2263

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

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

{

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

2271

2272

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

2273

2274

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

2275

2276

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

}

Ответ:

[

{

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

2287

2288

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

2289

2290

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

{

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

2295

2296

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

2297

2298

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

2299

2300

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

2301

2302

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

2303

2304

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

}

],

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

{

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

2315

2316

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

2317

2318

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

2319

2320

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

2321

2322

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

2323

2324

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

}

]

}

]

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

2338

2339

(% class="box infomessage" %)

2340

(((

2341

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

2342

)))

2343

2344

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

2345

2346

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

2347

2348

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

2349

2350

2351

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

Ответ:

{

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

2356

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

2357

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

2358

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

2359

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

2360

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

2361

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

2362

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

2363

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

2364

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

2365

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

2366

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

{

"id": 0,

"name": "string"

}

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

2375

2376

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

2377

2378

(% class="box infomessage" %)

2379

(((

2380

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

2381

)))

2382

2383

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

2384

2385

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

2386

2387

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

2388

2389

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

2390

2391

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

2392

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

2393

2394

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

2395

{

2396

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

2397

}

2398

2399

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

Ответ:

[

{

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

2405

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

2406

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

2407

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

2408

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

2409

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

2410

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

2411

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

2412

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

2413

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

2414

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

2415

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

}

]

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

2420

2421

(% class="box infomessage" %)

2422

(((

2423

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

2424

)))

2425

2426

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

2427

2428

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

2429

2430

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

2431

2432

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

2433

2434

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

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

{

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

2439

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

2440

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

2441

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

2442

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

2443

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

2444

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

}

Ответ:

[

{

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

2451

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

2452

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

2453

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

2454

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

2455

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

2456

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

}

]

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

2461

2462

(% class="box infomessage" %)

2463

(((

2464

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

2465

)))

2466

2467

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

2468

2469

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

2470

2471

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

2472

2473

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

2474

2475

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

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

{

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

2480

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

2481

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

2482

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

2483

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

2484

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

2485

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

}

Ответ:

[

{

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

2493

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

2494

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

2495

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

2496

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

2497

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

2498

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

}

]

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

2503

2504

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

2505

2506

(% class="box infomessage" %)

2507

(((

2508

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

2509

)))

2510

2511

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

2512

2513

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

2514

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

2515

2516

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

2517

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

2518

2519

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

2520

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

2521

2522

{

2523

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

}

Ответ:

[

{

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

2531

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

2532

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

2533

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

2534

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

2535

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

2536

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

}

]

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

2541

2542

(% class="box infomessage" %)

2543

(((

2544

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

2545

)))

2546

2547

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

2548

2549

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

2550

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

2551

2552

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

2553

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

2554

2555

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

2556

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

2557

2558

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

2559

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

2560

2561

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

2562

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

2563

2564

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

2565

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

2566

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

2567

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

2568

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

2569

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

2570

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

2571

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

2572

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

2573

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

2574

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

2575

],

2576

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

2577

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

2578

],

2579

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

2580

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

2581

],

2582

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

2583

"additionalProp1": "string",

2584

"additionalProp2": "string",

2585

"additionalProp3": "string"

2586

},

2587

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

2588

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

2589

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

2590

],

2591

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

2592

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

2593

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

2594

],

2595

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

2596

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

2597

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

2598

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

2599

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

2600

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

2601

],

2602

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

2603

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

2604

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

2605

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

2606

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

2607

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

2608

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

2609

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

2610

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

2611

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

2612

2613

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

2614

2615

(% class="box warningmessage" %)

2616

(((

2617

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

2618

)))

2619

2620

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

2621

2622

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

2623

2624

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

2625

2626

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

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

{

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

2631

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

2632

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

2633

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

2634

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

2635

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

2636

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

2637

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

2638

0

2639

],

2640

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

2641

0

2642

],

2643

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

2644

0

2645

],

2646

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

2647

"additionalProp1": "string",

2648

"additionalProp2": "string",

2649

"additionalProp3": "string"

2650

},

2651

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

2652

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

2653

""

2654

],

2655

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

2656

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

2657

"string"

2658

],

2659

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

2660

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

2661

{

2662

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

2663

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

2664

}

2665

],

2666

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

2667

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

2668

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

2669

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

2670

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

2671

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

2672

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

2673

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

2674

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

}

Ответ:

Success

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

2682

2683

(% class="box errormessage" %)

2684

(((

2685

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

2686

)))

2687

2688

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

2689

2690

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

2691

2692

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

2693

2694

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

2695

2696

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

Ответ:

Success

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

2704

2705

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

2706

2707

(% class="box infomessage" %)

2708

(((

2709

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

2710

)))

2711

2712

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

Ответ:

[

{

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

2719

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

2720

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

2721

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

2722

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

2723

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

2724

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

2725

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

}

]

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

2730

2731

(% class="box infomessage" %)

2732

(((

2733

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

2734

)))

2735

2736

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

Ответ:

{

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

2742

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

2743

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

2744

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

2745

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

2746

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

2747

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

2748

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

2749

}

2750

2751

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

2752

2753

(% class="box successmessage" %)

2754

(((

2755

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2763

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

2764

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

2765

"exclusive": true,

2766

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

2767

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2776

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

2777

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

2778

"exclusive": true,

2779

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

2780

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

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2786

2787

(% class="box warningmessage" %)

2788

(((

2789

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2797

"hiredate": "2023-06-30T12:50:27.910Z",

2798

"chopdate": "2023-06-30T12:50:27.910Z",

2799

"exclusive": true,

2800

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2801

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2810

"hiredate": "2023-06-30T12:50:27.929Z",

2811

"chopdate": "2023-06-30T12:50:27.929Z",

2812

"exclusive": true,

2813

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2814

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2820

2821

(% class="box errormessage" %)

2822

(((

2823

**DELETE /api/v3/Drivers/{driverGuid}**

2824

)))

2825

2826

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2834

2835

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2836

2837

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2838

2839

(% class="box infomessage" %)

2840

(((

2841

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2849

],

2850

"BeginTime": "2023-06-30T12:49:04.365Z",

2851

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2860

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2861

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2862

"BeginTime": "2023-06-30T09:52:31.240Z",

2863

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2869

2870

(% class="box infomessage" %)

2871

(((

2872

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2882

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2891

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2892

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2893

"BeginTime": "2023-06-30T09:54:01.631Z",

2894

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2900

2901

(% class="box successmessage" %)

2902

(((

2903

**POST /api/v3/DriversVehiclesAssignments**

2904

)))

2905

2906

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2913

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2914

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2915

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2916

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2926

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2927

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2928

"BeginTime": "2023-06-30T11:04:46.903Z",

2929

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2935

2936

(% class="box warningmessage" %)

2937

(((

2938

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2947

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2948

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2949

"BeginTime": "2023-06-30T11:14:08.117Z",

2950

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2960

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2961

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2962

"BeginTime": "2023-06-30T11:14:53.349Z",

2963

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2969

2970

(% class="box errormessage" %)

2971

(((

2972

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2987

2988

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2989

2990

(% class="box infomessage" %)

2991

(((

2992

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3000

],

3001

"BeginTime": "2023-06-30T12:47:12.162Z",

3002

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3010

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3011

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3012

"BeginTime": "2023-06-30T11:19:40.703Z",

3013

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

3019

3020

(% class="box infomessage" %)

3021

(((

3022

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3030

],

3031

"BeginTime": "2023-06-30T12:47:12.162Z",

3032

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3040

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3041

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3042

"BeginTime": "2023-06-30T11:19:40.703Z",

3043

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

3049

3050

(% class="box successmessage" %)

3051

(((

3052

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3060

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3061

"BeginTime": "2023-06-30T11:27:08.635Z",

3062

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3071

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3072

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3073

"BeginTime": "2023-06-30T11:27:08.677Z",

3074

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3080

3081

(% class="box warningmessage" %)

3082

(((

3083

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3091

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3092

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3093

"BeginTime": "2023-06-30T11:28:43.330Z",

3094

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3103

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3104

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3105

"BeginTime": "2023-06-30T11:28:43.331Z",

3106

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3112

3113

(% class="box errormessage" %)

3114

(((

3115

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3130

3131

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3132

3133

(% class="box infomessage" %)

3134

(((

3135

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3143

],

3144

"BeginTime": "2023-06-30T12:45:10.852Z",

3145

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3153

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3154

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3155

"BeginTime": "2023-06-30T11:58:04.695Z",

3156

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3162

3163

(% class="box infomessage" %)

3164

(((

3165

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3173

],

3174

"BeginTime": "2023-06-30T12:45:10.852Z",

3175

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3183

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3184

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3185

"BeginTime": "2023-06-30T11:58:04.695Z",

3186

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3192

3193

(% class="box successmessage" %)

3194

(((

3195

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3203

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3204

"BeginTime": "2023-06-30T12:09:53.175Z",

3205

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3214

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3215

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3216

"BeginTime": "2023-06-30T12:09:53.201Z",

3217

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3223

3224

(% class="box warningmessage" %)

3225

(((

3226

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3234

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3235

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3236

"BeginTime": "2023-06-30T12:09:53.201Z",

3237

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3246

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3247

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3248

"BeginTime": "2023-06-30T12:09:53.201Z",

3249

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3255

3256

(% class="box errormessage" %)

3257

(((

3258

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3273

3274

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3275

3276

(% class="box infomessage" %)

3277

(((

3278

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3285

"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);" %)**Описание**

3291

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3292

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3293

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3294

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3301

"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",

3311

"name": "string",

3312

"rid": "string",

3313

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3314

"trailer": {

3315

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3316

"Number": "string",

3317

"Description": "string",

3318

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3319

"ExternalID": "string",

3320

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3321

"CreateTime": "2023-11-14T10:48:03.717Z",

3322

"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);" %)**Описание**

3330

|SD|Дата и время начала события

3331

|ED|Дата и время окончания события

3332

|id|ID объекта

3333

|SLat|Широта начальной координаты

3334

|SLon|Долгота начальной координаты

3335

|ELat|Широта конечной координаты

3336

|ELon|Долгота конечной координаты

3337

|mileage|Пробег

3338

|Duration|Продолжительность

3339

|Address|Адрес начального местоположения

3340

|Address2|Адрес конечного местоположения

3341

|name|Имя радиометки

3342

|rid|Номер радиометки

3343

|rguid|ID радиометки

3344

|trailer|Информация об агрегате

3345

|ModelGuid|ID агрегата

3346

|Number|Название/номер агрегата

3347

|Description|Текст примечания агрегата

3348

3349

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3350

3351

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3352

3353

(% class="box infomessage" %)

3354

(((

3355

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3372

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3377

|parentId|ID клиента

3378

|name|Название карты-метки

3379

|number|Номер

3380

|period|Период запросов в секундах (работает только для агрегатов)

3381

|id|ID карты-метки

3382

3383

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3384

3385

(% class="box infomessage" %)

3386

(((

3387

**GET /api/v3/Rfids/{rfidGuid}**

3388

)))

3389

3390

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3400

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3405

|name|Название карты-метки

3406

|number|Номер

3407

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3412

3413

(% class="box successmessage" %)

3414

(((

3415

**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",

3434

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3435

}

3436

3437

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3438

|name|Название карты-метки

3439

|number|Номер

3440

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3445

3446

(% class="box warningmessage" %)

3447

(((

3448

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3458

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3468

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3469

}

3470

3471

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3472

|name|Название карты-метки

3473

|number|Номер

3474

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3479

3480

(% class="box errormessage" %)

3481

(((

3482

**DELETE /api/v3/Rfids/{rfidGuid}**

3483

)))

3484

3485

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3493

3494

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3495

3496

(% class="box infomessage" %)

3497

(((

3498

**GET /api/v3/Billing/client/balance/{clientId}**

3499

)))

3500

3501

Параметр запроса: **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);" %)**Описание**

3511

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3512

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3513

3514

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3515

3516

(% class="box infomessage" %)

3517

(((

3518

**GET /api/v3/Billing/client/constraint/{clientId}**

3519

)))

3520

3521

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3527

"CalculationType": 0,

3528

"PermissibleBalance": 0,

3529

"DefermentDays": 0,

3530

"SendUiNotifications": true,

3531

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3536

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3537

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3538

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3539

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3540

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3541

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3542

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3543

3544

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3545

3546

(% class="box infomessage" %)

3547

(((

3548

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3554

3555

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3561

"Plan": { **~/~/ Описание тарифного плана**

3562

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3563

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3568

"PermissibleBalance": 0,

3569

"DefermentDays": 0

3570

},

3571

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3583

"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);" %)**Описание**

3599

|ClientId|Идентификатор клиента

3600

|Id|Идентификатор тарифного плана

3601

|OwnerId|Идентификатор клиента-владельца

3602

|Name|Наименование тарифного плана

3603

|IsArchived|Признак, определяющий архивный тарифный план

3604

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3605

|PermissibleBalance|Допустимый баланс

3606

|DefermentDays|Отсрочка, количество дней

3607

|Feature|Код услуги

3608

|IsEnabled|Признак, определяющий активирована ли услуга

3609

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3610

|IsFactual|Признак, определяющий расчёт по факту

3611

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3612

|Price|Цена за единицу.

3613

|DebitDate|Следующий момент времени списания с баланса за услугу.

3614

|PeriodValue|Значение периода.

3615

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3616

3617

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3618

3619

(% class="box infomessage" %)

3620

(((

3621

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3622

)))

3623

3624

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3631

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3636

"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);" %)**Описание**

3653

|ClientId|Идентификатор клиента

3654

|Id|Идентификатор тарифного плана

3655

|OwnerId|Идентификатор клиента-владельца

3656

|Name|Наименование тарифного плана

3657

|IsArchived|Признак, определяющий архивный тарифный план

3658

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3659

|PermissibleBalance|Допустимый баланс

3660

|DefermentDays|Отсрочка, количество дней

3661

|Feature|Код услуги

3662

|IsFactual|Признак, определяющий расчёт по факту

3663

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3664

|Price|Цена за единицу.

3665

|PeriodValue|Значение периода.

3666

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3667

3668

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3669

3670

(% class="box infomessage" %)

3671

(((

3672

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3673

)))

3674

3675

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3682

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3687

"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);" %)**Описание**

3704

|ClientId|Идентификатор клиента

3705

|Id|Идентификатор тарифного плана

3706

|OwnerId|Идентификатор клиента-владельца

3707

|Name|Наименование тарифного плана

3708

|IsArchived|Признак, определяющий архивный тарифный план

3709

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3710

|PermissibleBalance|Допустимый баланс

3711

|DefermentDays|Отсрочка, количество дней

3712

|Feature|Код услуги

3713

|IsFactual|Признак, определяющий расчёт по факту

3714

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3715

|Price|Цена за единицу.

3716

|PeriodValue|Значение периода.

3717

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3718

3719

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3720

3721

(% class="box warningmessage" %)

3722

(((

3723

**PUT /api/v3/Billing/client/balance**

3724

)))

3725

3726

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3738

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3739

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3740

3741

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3742

3743

(% class="box warningmessage" %)

3744

(((

3745

**PUT /api/v3/billing/client/balance/deposit**

3746

)))

3747

3748

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3760

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3761

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3762

3763

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3764

3765

Создает операцию **Списание **с указанной суммой

3766

3767

(% class="box warningmessage" %)

3768

(((

3769

**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);" %)**Описание**

3782

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3783

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3784

3785

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3786

3787

(% class="box warningmessage" %)

3788

(((

3789

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3796

"CalculationType": 0,

3797

"PermissibleBalance": 0,

3798

"DefermentDays": 0,

3799

"SendUiNotifications": true,

3800

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3807

|ClientId|Идентификатор клиента

3808

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3809

|PermissibleBalance|Допустимый баланс

3810

|DefermentDays|(((

3811

Отсрочка, количество дней

3812

)))

3813

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3814

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3815

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3816

3817

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3818

3819

(% class="box warningmessage" %)

3820

(((

3821

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3828

"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);" %)**Описание**

3846

|ClientId|Идентификатор клиента

3847

|PlanId|Идентификатор тарифного плана

3848

|Feature|Код услуги

3849

|IsEnabled|Признак, определяющий активирована ли услуга

3850

|IsFactual|Признак, определяющий расчёт по факту

3851

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3852

|Price|Цена за единицу.

3853

|DebitDate|Следующий момент времени списания с баланса за услугу.

3854

|PeriodValue|Значение периода.

3855

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3856

3857

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3858

3859

(% class="box warningmessage" %)

3860

(((

3861

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3862

)))

3863

3864

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3865

3866

(% class="box infomessage" %)

3867

(((

3868

**POST /api/v3/vehicles/import/{agentId}**

3869

)))

3870

3871

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3872

3873

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3882

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3883

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3884

3885

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3890

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3891

|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);" %)**Описание**

3902

|vehicleId|ID созданного объекта

3903

|name|Имя созданного объекта

3904

|errors|Ошибки и их описание

3905

3906

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3907

3908

(% class="box infomessage" %)

3909

(((

3910

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3911

)))

3912

3913

(% class="wikigeneratedid" %)

3914

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3915

3916

(% class="wikigeneratedid" %)

3917

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3922

3923

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3928

|**history**|В значении передавать файл с историей

3929

3930

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3943

"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);" %)**Описание**

3951

|results|Результаты импорта в разрезе ТС

3952

|vehicleGuid|Guid ТС

3953

|vehicleId|ID ТС

3954

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3955

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3956

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3957

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3958

|msgCount|Кол-во обработанных сообщений всего

3959

3960

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3961

3962

(% class="box infomessage" %)

3963

(((

3964

**GET /api/v3/vehicles/import/history/status**

3965

)))

3966

3967

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3978

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3979

|progress|Guid ТС

3980

3981

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3982

3983

(% class="box infomessage" %)

3984

(((

3985

**POST /api/v3/vehicles/export**

3986

)))

3987

3988

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3997

3998

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3999

4000

(% class="box infomessage" %)

4001

(((

4002

**POST /api/v3/vehicles/export/history**

4003

)))

4004

4005

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4013

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4019

4020

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4021

|vehicleId|ID объекта

4022

|asArchive|true - Архивировать файл, False - не архивировать

4023

|from|Дата и время начала запроса

4024

|to|Дата и время окончания запроса

4025

4026

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4027

4028

(% class="box infomessage" %)

4029

(((

4030

**GET /api/v3/vehicles/export/history/status**

4031

)))

4032

4033

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4044

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4045

|progress|Прогресс экспорта, от 0 до 100%

4046

|message|Текст описывающий статус

4047

4048

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4049

4050

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4051

4052

(% class="box infomessage" %)

4053

(((

4054

**POST /api/v3/EcoDriving/rating**

4055

)))

4056

4057

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

4063

"from": "2023-11-22T09:29:48.051Z",

4064

"to": "2023-11-22T09:29:48.051Z"

4065

}

4066

4067

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4068

|vehicleIds|Массив ID объектов

4069

|from|Дата начала запроса

4070

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

4078

"to": "2023-11-22T09:29:48.052Z",

4079

"vehicleId": 0,

4080

"vehicleName": "string",

4081

"vehicleModel": "string",

4082

"penalty": 0,

4083

"score": 0,

4084

"totalViolations": 0,

4085

"violationsByType": {

4086

"overspeedingViolations": 0,

4087

"accelerationViolations": 0,

4088

"brakingViolations": 0,

4089

"turningViolations": 0,

4090

"dangerousDrivingViolations": 0,

4091

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

4101

"violationsByType": {

4102

"overspeedingViolations": 0,

4103

"accelerationViolations": 0,

4104

"brakingViolations": 0,

4105

"turningViolations": 0,

4106

"dangerousDrivingViolations": 0,

4107

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4114

"endAddress": "string",

4115

"drivers": [

4116

{

4117

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4118

"driverName": "string",

4119

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4129

|from|Дата начала запроса

4130

|to|Дата окончания

4131

|vehicleId|ID объекта

4132

|vehicleName|Имя объекта

4133

|vehicleModel|Модель объекта

4134

|penalty|Сумма штрафных баллов

4135

|score|Оценка

4136

|totalViolations|Суммарное количество нарушений

4137

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4138

|overspeedingViolations|Превышение скорости

4139

|accelerationViolations|Ускорение

4140

|brakingViolations|Торможение

4141

|turningViolations|Резкий поворот

4142

|dangerousDrivingViolations|Резкое вождение

4143

|sensorViolations|Нарушение по датчику

4144

|moveTime|Время в движении

4145

|mileage|Пробег

4146

|tripsCount|Количество рейсов

4147

|motohours|Моточасы

4148

|maxSpeed|Максимальная скорость

4149

|startAddress|Адрес начала рейса

4150

|endAddress|Адрес окончания рейса

4151

|drivers|Список водителей, которые были на объекте в течениии рейса

4152

|driverGuid|Guid водителя

4153

|driverName|Имя водителя

4154

|driverRfid|Номер Карты-метки

4155

4156

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4157

4158

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4159

4160

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4161

4162

(% class="box infomessage" %)

4163

(((

4164

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4170

\\В заголовках запроса: X-Auth: Токен авторизации

4171

4172

Параметры в теле запроса (JSON):

{

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4177

4178

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

"ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

],

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4195

4196

"driver": "string", ~/~/Водители, привязанные к ТК

4197

4198

"object": "string", ~/~/Наименование ТС

4199

4200

"amount": 0, ~/~/Количество топлива

4201

4202

"amountDut": 0, ~/~/Количество по ДУТ

4203

4204

"amountDiff": 0, ~/~/Разница, л

4205

4206

"amountDiffPerc": 0, ~/~/Разница, %

4207

4208

"summa": 0, ~/~/Стоимость, руб

4209

4210

"serviceName": "string", ~/~/Тип топлива

4211

4212

"price": 0, ~/~/Цена за литр, руб

4213

4214

"cardName": "string", ~/~/Наименование ТК

4215

4216

"cardNum": "string", ~/~/Номер ТК

4217

4218

"operator": "string", ~/~/Оператор ТК

4219

4220

"address": "string" ~/~/Адрес АЗС

}

==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====

4226

4227

4228

==== **Получение полных данных о ретрансляторе** ====

4229

4230

(% class="box infomessage" %)

4231

(((

4232

**GET ** **/api/v3/retranslations/{id}**

4233

)))

4234

4235

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4243

4244

"subscriberId": "", ~/~/ Подписчик

4245

4246

"protocolType": 0, ~/~/ Тип протокола

4247

4248

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4249

4250

"address": "string", ~/~/ Адрес события

4251

4252

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ Идентификатор объекта ретрансляции

4257

4258

"name": "", ~/~/ Наименование объекта ретрансляции

4259

4260

"imei": "", ~/~/ IMEI объекта

4261

4262

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

"id": "", ~/~/ идентификатор пользователя

4269

4270

"parentId": "", ~/~/Guid родителя

4271

4272

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

==== **Удаление данных ретранслятора** ====

4278

4279

(% class="box infomessage" %)

4280

(((

4281

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

==== **Создание ретранслятора** ====

4288

4289

(% class="box infomessage" %)

4290

(((

4291

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4300

4301

"subscriberId": "", ~/~/ Подписчик

4302

4303

"protocolType": 0, ~/~/ Тип протокола

4304

4305

"address": "", ~/~/ Адрес ретрансляции

4306

4307

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4308

4309

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ идентификатор пользователя

4314

4315

"imei": "", ~/~/IMEI объекта

4316

4317

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ

{

"description": "string", ~/~/ Определяет описание

4332

4333

"subscriberId": "", ~/~/ идентификатор запроса

4334

4335

"protocolType": 0, ~/~/ Тип протокола

4336

4337

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4338

4339

"address": "", ~/~/ Адрес события

4340

4341

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ идентификатор пользователя

4346

4347

"name": "string", ~/~/ Название уведомления

4348

4349

"imei": "string", ~/~/IMEI объекта

4350

4351

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

"id": "", ~/~/ идентификатор пользователя

4358

4359

"parentId": "", ~/~/ Guid идентификатор родителя

4360

4361

"deleted": true ~/~/ Признак удаления

}

==== **Редактирование ретранслятора** ====

4367

4368

(% class="box infomessage" %)

4369

(((

4370

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4378

4379

"description": "string", ~/~/ Определяет описание

4380

4381

"subscriberId": "", ~/~/ идентификатор запроса

4382

4383

"protocolType": 0, ~/~/ Тип протокола

4384

4385

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4386

4387

"address": "string", ~/~/ Адрес события

4388

4389

"objects": ~/~/Объекты для ретрансляции

[

{

"id": "", ~/~/ идентификатор пользователя

4396

4397

"imei": "", ~/~/IMEI объекта

4398

4399

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4413

4414

"subscriberId": "", ~/~/ идентификатор запроса

4415

4416

"protocolType": 0, ~/~/ Тип протокола

4417

4418

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4419

4420

"address": "string", ~/~/ Адрес события

4421

4422

"objects": [ ~/~/Объекты для ретрансляции

{

"id": "", ~/~/ идентификатор пользователя

4427

4428

"name": "string", ~/~/ Название уведомления

4429

4430

"imei": "", ~/~/IMEI объекта

4431

4432

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

],

"id": "", ~/~/ идентификатор пользователя

4439

4440

"parentId": "", ~/~/ Guid идентификатор родителя

4441

4442

"deleted": true ~/~/ Признак удаления

}

==== **Получение списка ретранслятора клиента** ====

4449

4450

(% class="box infomessage" %)

4451

(((

4452

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4461

4462

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4463

4464

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ

[

{

"description": "", ~/~/ Определяет описание

4478

4479

"subscriberId": "", ~/~/ идентификатор запроса

4480

4481

"protocolType": 0, ~/~/ Тип протокола

4482

4483

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4484

4485

"address": "string", ~/~/ Адрес события

4486

4487

"id": "", ~/~/ идентификатор пользователя

4488

4489

"parentId": "", ~/~/ Guid идентификатор родителя

4490

4491

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =

4499

4500

4501

==== **API для отчета по выгрузке комбайнов** ====

4502

4503

4504

(% class="box infomessage" %)

4505

(((

4506

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4515

4516

"byDist": 0, ~/~/ Объединение событий по расстоянию

4517

4518

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4519

4520

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4521

4522

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4523

4524

"vehicleIds": [ ~/~/ Список id объектов для анализа

0

],

"from": "", ~/~/ Дата и время начало запроса

4531

4532

"to": "", ~/~/ Дата и время окончания запроса

4533

4534

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4548

4549

"harvesterId": 0, ~/~/Комбайн, id

4550

4551

"harvesterModel": "", ~/~/ Модель комбайна

4552

4553

"hopperCapacity": 0, ~/~/ Объем бункера м3

4554

4555

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4556

4557

"events": [ ~/~/Список событий в разрезе комбайна

{

"driverId": "", ~/~/Идентификатор водителя

4562

4563

"driverName": "", ~/~/Водитель комбайна, ФИО

4564

4565

"RFID": "", ~/~/ идентификатор карты-метки

4566

4567

"rfidName": "", ~/~/Водитель комбайна, имя метки

4568

4569

"vehicleId": 0, ~/~/идентификатор объекта

4570

4571

"vehicleName": "string", ~/~/ Имя объекта

4572

4573

"modelName": "string", ~/~/ Имя модели объекта

4574

4575

"nearestVehicles": [ ~/~/Объекты рядом

{

"vehicleId": 0, ~/~/идентификатор объекта

4580

4581

"vehicleName": "string" ~/~/ Имя объекта

}

],

"fields": [ ~/~/Поля, где происходила выгрузка

{

"id": 0, ~/~/ идентификатор пользователя

4592

4593

"name": "string" ~/~/ имя пользователя

}

],

"event": "string", ~/~/Событие

4600

4601

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4602

4603

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4604

4605

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4606

4607

"cultureName": "string", ~/~/ название культуры

4608

4609

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4610

4611

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4612

4613

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4614

4615

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4616

4617

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4618

4619

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4620

4621

"issued": 0, ~/~/Выдано, бункеров

4622

4623

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4624

4625

"latitude": 0, ~/~/Широта

4626

4627

"longitude": 0, ~/~/ Долгота

4628

4629

"litresAway": 0, ~/~/Отдано, л

4630

4631

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4643

4644

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4645

4646

4647

(% class="box infomessage" %)

4648

(((

4649

GET api/v3/Vehicles/recyclebin/all

4650

)))

4651

4652

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4653

4654

Параметр запроса: {parentId} - идентификатор агента

4655

4656

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4665

4666

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4667

4668

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4669

4670

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4671

4672

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4673

4674

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4675

4676

"details": { ~/~/Список деталей объекта, помещённого в корзину

"items": [ ~/~/ [

nullable: true ~/~/Детали

{

"name": "string", ~/~/наименование столбца

4685

4686

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4706

4707

(% class="box infomessage" %)

4708

(((

4709

POST/api/v3/Vehicles/recyclebin/erase

4710

)))

4711

4712

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4731

4732

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4733

4734

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4735

4736

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4737

4738

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4739

4740

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4741

4742

"details": { ~/~/Список деталей объекта, помещённого в корзину

4743

4744

"items": [ ~/~/Детали

{

"name": "", ~/~/Имя свойства

4749

4750

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4769

4770

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4771

4772

(% class="box infomessage" %)

4773

(((

4774

POST/api/v3/Vehicles/recyclebin/restore

4775

)))

4776

4777

В заголовках запроса: X-Auth: Токен авторизации

4778

4779

Параметры в теле запроса (JSON):

4780

4781

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4782

4783

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4802

4803

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4804

4805

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4806

4807

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4808

4809

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4810

4811

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4812

4813

"details": { ~/~/Список деталей объекта, помещённого в корзину

4814

4815

"items": [ ~/~/Детали

{

"name": "string", ~/~/Имя свойства

4820

4821

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4842

(((

4843

(% 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]] **

4844

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню