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

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

48

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

49

}

50

51

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

52

53

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

54

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

55

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

56

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

57

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

58

59

(% class="wikigeneratedid" %)

60

Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])

61

62

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

63

64

(% class="box infomessage" %)

65

(((

66

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

67

)))

68

69

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

70

71

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

72

73

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

74

75

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

76

77

(% lang="en-US" %)

78

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

79

80

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

81

82

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

83

84

(% class="box infomessage" %)

85

(((

86

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

87

)))

88

89

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

90

91

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

92

93

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

94

95

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

96

97

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

98

99

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

104

"name": "string",

105

"fullName": "string",

106

"agentInfoType": 0,

107

"isForeign": true/false,

108

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

115

"email": "string",

116

"director": "string",

117

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

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

145

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

146

147

(% class="box infomessage" %)

148

(((

149

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

150

)))

151

152

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

153

154

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

155

156

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

157

158

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

159

160

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

161

162

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

163

164

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

165

166

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

"parentId": "string"

}

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

171

172

{

173

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

174

"parentId": "",

175

"name": "string",

176

"fullName": "string",

177

"agentInfoType": 0,

178

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

}

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

183

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

184

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

185

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

186

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

187

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

188

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

189

190

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

191

192

(% class="box successmessage" %)

193

(((

194

**POST /api/v3/agents **

195

)))

196

197

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

198

199

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

200

201

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

202

203

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

204

205

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

206

207

{

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

}

Ответ:

{

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

}

251

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

274

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

275

276

(% class="box warningmessage" %)

277

(((

278

**PUT /api/v3/agents**

279

)))

280

281

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

282

283

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

284

285

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

286

287

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

288

289

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

290

291

{

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

}

Ответ:

{

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

}

335

336

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

337

338

(% class="box errormessage" %)

339

(((

340

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

341

)))

342

343

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

344

345

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

346

347

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

348

349

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

350

351

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

352

353

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

354

355

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

356

357

(% class="box warningmessage" %)

358

(((

359

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

360

)))

361

362

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

363

364

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

365

366

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

Ответ: Code 204

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

371

372

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

373

374

(% class="box successmessage" %)

375

(((

376

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

377

)))

378

379

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

380

381

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

382

383

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

384

385

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

386

387

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

388

389

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

390

{

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

"doubleAuth":

407

{

408

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

409

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

},

"groups":

[

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

],

"customGroups":

[

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

418

],

419

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

420

}

421

{

422

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

423

"lastName": "string",

424

"firstName": "string",

425

"position": "string",

426

"phone": "string",

427

"organization": "string",

428

"login": "string",

429

"password": "string",

430

"email": "string",

431

432

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

433

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

434

{

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

}

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

456

457

(% class="box infomessage" %)

458

(((

459

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

460

)))

461

462

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

463

464

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

465

466

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

467

468

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

469

470

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

471

472

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

473

474

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

475

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

476

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

477

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

478

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

479

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

480

481

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

482

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

499

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

500

501

(% class="box infomessage" %)

502

(((

503

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

504

)))

505

506

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

507

508

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

509

510

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

511

512

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

513

514

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

(((

(((

{

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

"doubleAuth":

534

{

535

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

536

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

537

},

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

}

)))

)))

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

552

553

(% class="box warningmessage" %)

554

(((

555

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

556

)))

557

558

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

559

560

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

561

562

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

563

564

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

565

566

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

567

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

568

569

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

570

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

571

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

572

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

573

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

574

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

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

"doubleAuth":

588

{

589

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

590

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

591

},

592

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

593

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

594

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

595

596

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

597

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

598

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

"doubleAuth":

615

{

616

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

617

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

618

},

619

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

620

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

621

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

622

}

623

624

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

625

626

(% class="box warningmessage" %)

627

(((

628

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

629

)))

630

631

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

632

633

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

634

635

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

636

637

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

638

639

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

640

641

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

642

643

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

644

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

645

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

646

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

647

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

648

649

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

650

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

651

652

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

653

654

(% class="box warningmessage" %)

655

(((

656

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

657

)))

658

659

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

660

661

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

662

663

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

664

665

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

666

667

[

668

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

669

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

670

]

671

672

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

673

674

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

675

676

(% class="box warningmessage" %)

677

(((

678

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

679

)))

680

681

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

682

683

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

684

685

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

686

687

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

688

689

[

690

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

691

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

692

]

693

694

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

695

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

(((

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

{

"errorMessages": [

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

702

],

703

"users": [

704

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

705

]

706

}

707

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

708

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

709

)))

710

711

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

712

713

(% class="box errormessage" %)

714

(((

715

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

716

)))

717

718

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

719

720

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

721

722

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

723

724

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

725

726

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

727

728

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

729

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

730

731

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

732

733

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

734

735

(% class="box infomessage" %)

736

(((

737

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

738

)))

739

740

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

741

742

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

743

744

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

745

746

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

747

748

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

749

750

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

751

752

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

753

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

760

"hoppercapacity": 0,

761

"hopperdischargespeed": 0,

762

"modelType": 0,

763

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

764

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

769

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

770

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

771

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

772

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

773

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

774

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

775

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

776

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

777

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

778

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

779

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

780

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

781

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

782

783

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

784

785

(% class="box successmessage" %)

786

(((

787

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

788

)))

789

790

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

791

792

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

793

794

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

795

796

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

797

798

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

799

800

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

801

}

802

803

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

804

805

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

806

{

807

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

808

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

809

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

816

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

817

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

818

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

819

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

820

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

821

822

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

823

824

(% class="box successmessage" %)

825

(((

826

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

827

)))

828

829

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

830

831

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

832

833

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

834

835

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

836

837

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

838

839

{

840

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

841

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

850

"fueloutlay": 0,

851

"hoppercapacity": 0,

852

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

860

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

869

"hoppercapacity": 0,

870

"hopperdischargespeed": 0,

"modelType": 0

}

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

875

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

876

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

877

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

878

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

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

888

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

889

890

(% class="box warningmessage" %)

891

(((

892

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

893

)))

894

895

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

896

897

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

898

899

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

900

901

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

902

903

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

904

905

{

906

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

907

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

916

"fueloutlay": 0,

917

"hoppercapacity": 0,

918

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

926

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

935

"fueloutlay": 0,

936

"hoppercapacity": 0,

937

"hopperdischargespeed": 0,

"modelType": 0

}

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

942

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

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

955

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

956

957

(% class="box errormessage" %)

958

(((

959

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

960

)))

961

962

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

963

964

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

965

966

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

967

968

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

969

970

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

971

972

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

973

974

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

975

976

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

977

978

(% class="box infomessage" %)

979

(((

980

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

981

)))

982

983

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

984

985

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

986

987

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

988

989

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

990

991

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

992

993

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

994

995

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

996

997

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

998

999

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

(((

{

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

},

1019

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

1020

{

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

}

1028

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

},

1054

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

},

1062

1063

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

1064

{

1065

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

1066

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

1067

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

1068

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

1069

}

1070

],

1071

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

1072

{

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

{

1086

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

1087

{

1088

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

1089

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

1090

}

1091

],

1092

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

1093

}

1094

],

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

"string"

1103

],

1104

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

1105

"additionalProp1": "string",

1106

"additionalProp2": "string",

1107

"additionalProp3": "string"

1108

},

1109

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

}

1124

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

1125

{

1126

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

1127

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

1128

"description": "string",

1129

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

1130

}

1131

],

1132

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

1133

{

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

}

1147

],

1148

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

1149

{

1150

"status": 0,

1151

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

1152

"description": "string",

1153

"additionalInfo": "string"

}

]

}

)))

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

1160

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

1161

1162

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

1163

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

1164

1165

1166

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

1167

1168

(% class="box infomessage" %)

1169

(((

1170

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

1171

)))

1172

1173

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

1174

1175

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

1176

1177

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

1178

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

1188

(((

1189

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

1190

1191

(% class="box infomessage" %)

1192

(((

1193

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

1194

)))

1195

1196

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

1197

1198

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

1199

1200

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

[

{

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

1205

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

1206

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

1207

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

1208

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

1209

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

1210

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

}

]

)))

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

1216

1217

(% class="box successmessage" %)

1218

(((

1219

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

1220

)))

1221

1222

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

1223

1224

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

1225

1226

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

1227

1228

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

1229

1230

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

1231

1232

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

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

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

1250

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

1251

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

1252

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

1253

"mileageCalcMethod": 0,

1254

"mileageCoeff": 0,

1255

"locationByCellId": true,

1256

"dottedLineTrackWhenNoCoords": true,

1257

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

1258

{

1259

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

1260

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

1261

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

1262

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

1263

},

1264

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

1265

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

1266

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

1267

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

1268

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

1269

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

1270

},

1271

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

1272

{

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

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

1284

}

1285

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

1286

{

1287

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

"isDefault": true

}

],

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

1292

{

1293

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1300

{

1301

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

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

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

1312

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

1313

{

1314

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

1315

{

1316

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

1317

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

1318

}

1319

],

1320

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

1321

}

1322

],

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

"string"

1331

],

1332

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

1333

"additionalProp1": "string",

1334

"additionalProp2": "string",

1335

"additionalProp3": "string"

1336

},

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

}

1351

],

1352

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

1353

{

1354

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1365

1366

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

1367

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

1368

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

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

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

1376

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

1377

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

1378

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

1379

"mileageEnabled": true,

1380

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1385

"id": null,

1386

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

1387

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

1388

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

1389

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

1390

},

1391

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

1392

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

1393

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

1394

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

1395

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

1396

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

1397

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

1398

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

1399

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

1400

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

1401

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

1402

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

1403

}

1404

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

1405

1406

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

1407

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

1408

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

1409

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

1410

1411

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

1412

1413

(% class="box infomessage" %)

1414

(((

1415

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

1416

)))

1417

1418

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

1419

1420

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

1421

1422

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

1423

1424

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

1425

1426

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

1427

1428

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

1429

1430

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

1431

1432

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

1433

1434

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

1435

1436

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

1437

1438

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

1439

1440

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

1441

1442

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

1443

1444

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

1445

1446

{

1447

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

1448

"name": null, ~/~/ Имя ТС (string, опционально)

1449

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1450

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1451

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1452

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1453

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1454

"customFields": null ~/~/ значение любого из произвольных полей ТС

1455

}

1456

1457

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1458

1459

(% style="color:#000000" %)Ответ:

1460

1461

(% style="color:#000000" %){

1462

"vehicleId": "" ~/~/ идентификатор объекта

1463

"name": "" ~/~/ наименование объекта

1464

"imei": "" ~/~/ IMEI объекта

1465

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1466

"deviceTypeName": "" ~/~/ наименование типа устройства

1467

"sim1": "" ~/~/ первый номер телефона

1468

"sim2": "" ~/~/ второй номер телефона

1469

"parentId": "" ~/~/ идентификатор клиента-родителя

1470

"parentName": "" ~/~/ наименование клиента-родителя

1471

"modelId": "" ~/~/ идентификатор модели объекта

1472

"modelName": "" ~/~/ наименование модели объекта

1473

"unitId": "" ~/~/ идентификатор подразделения

1474

"unitName": "" ~/~/ наименование подразделения

1475

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1476

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1477

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1478

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1479

"customFields": [

1480

{

1481

"id": "", ~/~/ идентификатор произвольного поля

1482

"name": "", ~/~/ имя произвольного поля

1483

"value": "", ~/~/ значение произвольного поля

1484

"forClient": true, ~/~/ право на отображение у клиента

1485

"forTooltip": false, ~/~/ право на отображение в подсказке

1486

"forReport": false ~/~/ право на отображение в отчетах

1487

}(%%)

1488

(% style="color:#000000" %)}

1489

1490

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1491

1492

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1493

1494

(% class="box successmessage" %)

1495

(((

1496

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1497

)))

1498

1499

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1500

1501

(% style="color:#000000" %)Метод запроса: **POST**

1502

1503

(% 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}

1504

1505

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1506

1507

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1508

1509

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1510

1511

(% style="color:#000000" %){

1512

1513

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1514

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1515

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1516

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1517

"description": "", ~/~/ Описание

1518

"data": "", ~/~/ Данные

1519

"overwrite": false, ~/~/ Флаг перезаписи

1520

"stage": "", ~/~/ Состояние, может быть null

1521

(% style="color:#000000" %)}

1522

1523

(% style="color:#000000" %)Ответ:

1524

1525

(% style="color:#000000" %){(%%)

1526

"status": "", ~/~/ значение статуса

1527

"date": "", ~/~/ Дата смены статуса

1528

"description": "", ~/~/ Описание

1529

"data": "", ~/~/ Данные

1530

"overwrite": false, ~/~/ Флаг перезаписи

1531

"stage": "", ~/~/ Состояние

1532

(% style="color:#000000" %) }

1533

1534

(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)

1535

**Отправить команду на терминал**

1536

1537

(% class="box successmessage" %)

1538

(((

1539

(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**

1540

)))

1541

1542

Команда для отправки на тс.

1543

1544

{

1545

"id": "", ~/~/идентификатор произвольного поля

1546

"command": "", ~/~/ Текст команды

1547

"retries": "", ~/~/ Количество попыток

1548

"idTemplate": "" ~/~/ ID шаблона команды

}

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1553

1554

(% class="box warningmessage" %)

1555

(((

1556

(% lang="en-US" %)**PUT /api/v3/vehicles**

1557

)))

1558

1559

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1560

1561

(% style="color:#000000" %)Метод запроса: **PUT**

1562

1563

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1564

1565

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1566

1567

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1568

1569

(% style="color:#000000" %){

1570

"vehicleId": , ~/~/ ID объекта

1571

"parentId": "" , ~/~/ ID клиента

1572

"name": "" , ~/~/ имя ТС

1573

"imei": "" , ~/~/ IMEI

1574

"deviceTypeId": "" , ~/~/ ID типа устройства

1575

"modelId": "" , ~/~/ ID модели

1576

"unitId": "" , ~/~/ ID подразделения

1577

"sim1": "" , ~/~/ Номер SIM 1

1578

"sim2": "" , ~/~/ Номер SIM2

1579

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1580

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1581

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1582

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1583

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1584

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1585

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1586

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1587

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1588

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1589

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1590

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1591

1592

"mileageCalcMethod": 0,

1593

"mileageCoeff": 0,

1594

"locationByCellId": true,

1595

"dottedLineTrackWhenNoCoords": true,

1596

"counters": ~/~/ счетчики

1597

{

1598

"mileage": "" , ~/~/ пробег

1599

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1600

"motohours": "" , ~/~/ моточасы

1601

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1602

},

1603

"cmsv6Parameters": { ~/~/ параметры CMSv6

1604

"enabled": true, ~/~/ флаг включения

1605

"id": "" , ~/~/ идентификатор

1606

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1607

"login": "" , ~/~/ имя учетной записи

1608

"password": "" ~/~/ пароль учетной записи

1609

},

1610

"inspectionTasks": ~/~/ задания на ТО

1611

{

1612

"enabled": "" , ~/~/ Признак включения

1613

"name": "" , ~/~/ Имя задания

1614

"description": "" , ~/~/ Описание задания

1615

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1616

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1617

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1618

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1619

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1620

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1621

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1622

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1623

}

1624

1625

"drivers": [ ~/~/ Водители

1626

{

1627

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1632

{

1633

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1640

{

1641

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1642

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1643

"type": 0, ~/~/ Тип датчика

1644

"name": "string", ~/~/ Имя датчика

1645

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1646

"inputNumber": 0, ~/~/ Номер входа

1647

"pseudonym": "string", ~/~/ Псевдоним

1648

"medianDegree": 0, ~/~/ Медианная фильтрация

1649

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1650

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1651

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1652

"gradesTables": [ ~/~/ Массив таблиц тарировки

1653

{

1654

"grades": [ ~/~/ Таблица тарировки 1

1655

{

1656

"input": 0, ~/~/ Входящее значение

1657

"output": 0 ~/~/ Выходящее значение

1658

}

1659

],

1660

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1661

}

1662

],

1663

"showInTooltip": true, ~/~/ Отображать в подсказке

1664

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1665

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1666

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1667

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1668

"expr": "string", ~/~/ Формула

1669

"children": [ ~/~/ массив дочерних датчиков

1670

"string"

1671

],

1672

"customParams": { ~/~/ прочие произвольные параметры

1673

"additionalProp1": "string",

1674

"additionalProp2": "string",

1675

"additionalProp3": "string"

1676

},

1677

~/~/ Характерные для произвольного:

1678

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1679

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1680

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1681

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1682

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1683

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1684

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1685

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1686

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1687

~/~/ "ValueOn": "Вкл.",

1688

~/~/ "ValueOff": "Выкл."

1689

"summaryMaxValue": 0 ~/~/ Макс. значение

1690

}

1691

],

1692

"customFields": [ ~/~/ Произвольные поля

1693

{

1694

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1705

1706

(% lang="en-US" style="text-align:left" %)

1707

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%)

1708

"vehicleId": "", ~/~/ ID ТС

1709

"parentId": "", ~/~/ ID клиента

1710

"name": "", ~/~/ имя ТС

1711

"imei": "", ~/~/ IMEI

1712

"deviceTypeId": "", ~/~/ типа устройства

1713

"modelId": "", ~/~/ ID модели

1714

"unitId": "", ~/~/ ID подразделения

1715

"sim1": "", ~/~/ SIM 1

1716

"sim2": "", ~/~/ SIM2

1717

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1718

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1719

"counters":

1720

{

1721

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1722

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1723

"mileage": "", ~/~/ пробег

1724

"motohours": "", ~/~/ моточасы

1725

}

1726

"cmsv6Parameters": ~/~/ параметры CMSv6

1727

{

1728

"id": ~/~/ идентификатор

1729

"enabled": true, ~/~/ флаг включения

1730

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1731

"login": "", ~/~/ имя учетной записи

1732

"password": "", ~/~/ пароль учетной записи

1733

}

1734

"inspectionTasks": ~/~/ задания на ТО

1735

{

1736

"id": "", ~/~/ ID задания

1737

"enabled": false, ~/~/ Признак включения

1738

"name": "", ~/~/ Имя задания

1739

"description": "", ~/~/ Описание задания

1740

"mileageCondition": "", ~/~/ Условие по пробегу

1741

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1742

"motohoursCondition": "", ~/~/ Условие по моточасам

1743

"lastMotohours": "", ~/~/ Моточасы

1744

"periodicCondition": "", ~/~/ Условие периодичности по времени

1745

"kind": "", ~/~/ Вид периодичности по времени

1746

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1747

}

1748

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1749

1750

**Валидация:**

1751

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1752

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1753

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1754

1755

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1756

1757

(% class="box errormessage" %)

1758

(((

1759

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1760

)))

1761

1762

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1763

1764

(% style="color:#000000" %)Метод запроса: **DELETE**

1765

1766

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1767

1768

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1769

1770

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1771

1772

(% style="text-align:left" %)

1773

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1774

1775

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1776

1777

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1778

1779

(% class="box infomessage" %)

1780

(((

1781

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1782

)))

1783

1784

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1785

1786

(% style="color:#000000" %)Метод запроса: **GET**

1787

1788

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

1789

1790

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1791

1792

(% style="color:#000000" %)Ответ:

1793

1794

(% style="color:#000000" %){(%%)

1795

"deviceTypeId" : "", ~/~/ ID типа устройства

1796

"deviceTypeName" : "" ~/~/ Название типа устройства

1797

(% style="color:#000000" %)}

1798

1799

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1800

1801

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1802

1803

(% class="box infomessage" %)

1804

(((

1805

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1806

)))

1807

1808

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1809

1810

(% style="color:#000000" %)Метод запроса: **GET**

1811

1812

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1813

1814

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1815

1816

(% style="color:#000000" %)Ответ:

1817

1818

(% style="color:#000000" %){(%%)

1819

"id": "", ~/~/ ID типа датчика

1820

"name": "", ~/~/ Название

1821

"description": "", ~/~/ Описание

1822

(% style="color:#000000" %)}

1823

1824

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1825

1826

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1827

1828

(% class="box infomessage" style="text-align: left;" %)

1829

(((

1830

**POST /api/v3/terminalMessages/count**

1831

)))

1832

1833

(% style="text-align: left;" %)

1834

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1835

1836

(% style="text-align: left;" %)

1837

Метод запроса **POST**

1838

1839

(% style="text-align: left;" %)

1840

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1841

1842

(% style="text-align: left;" %)

1843

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1844

1845

(% style="text-align: left;" %)

1846

{

1847

"vehicleIds": [

1848

id ~/~/ здесь передается список идентификаторов объектов

1849

],

1850

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1851

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1852

}

1853

1854

(% style="text-align: left;" %)

1855

Ответ:

1856

1857

(% style="text-align: left;" %)

1858

[

1859

{

1860

"vehicleId": 0, ~/~/ идентификатор объекта

1861

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1866

1867

(% class="box infomessage" style="text-align: left;" %)

1868

(((

1869

**POST /api/v3/terminalMessages/mapping**

1870

)))

1871

1872

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

1873

1874

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

1875

1876

(% 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);" %)**Описание**

1884

|protocolType|ID типа протокола

1885

|params|(((

1886

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

1906

|protocolType|Тип протокола

1907

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

1913

Перечень 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/]]

1914

1915

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

1916

1917

(% class="box infomessage" %)

1918

(((

1919

**POST /api/v3/terminalMessages**

1920

)))

1921

1922

Метод возвращает список сообщений терминала объекта за выбранный период.

1923

1924

(% style="text-align: left;" %)

1925

Метод запроса **POST**

1926

1927

(% style="text-align: left;" %)

1928

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

1929

1930

(% style="text-align: left;" %)

1931

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1932

1933

{

1934

"vehicleId": 0, ~/~/ id объекта

1935

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

1936

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

1937

}

1938

1939

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1940

|vehicleId|ID объекта

1941

|from|Дата и время начала периода запроса

1942

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

1951

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

1961

"additionalProp2": "string",

1962

"additionalProp3": "string"

1963

},

1964

"photoCount": 0,

1965

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1973

|deviceTime|Время сообщения терминала

1974

|serverTime|Время когда сообщение поступило на сервер

1975

|speed|Скорость

1976

|altitude|Высота над уровнем моря

1977

|latitude|Широта

1978

|longitude|Долгота

1979

|satellites|Кол-во спутников

1980

|course|Курс

1981

|voltage|Бортовое напряжение

1982

|parameters|Список параметров и их значений

1983

|photoCount|Количество фото

1984

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

1985

|protocolType|ID типа протокола

1986

1987

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

1988

1989

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

1990

1991

(% class="box infomessage" %)

1992

(((

1993

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

1994

)))

1995

1996

(% style="color:#000000" %)Метод запроса: **POST**

1997

1998

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

1999

2000

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2001

2002

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2007

"vehicleIds": [0], ~/~/ Список ID объектов

2008

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2009

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2010

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2018

"name": "string", ~/~/ Имя ТС

2019

"periods": [ ~/~/ Периоды

2020

{

2021

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2022

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2023

"mileageBegin": 0, ~/~/ Пробег на начало периода

2024

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2025

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2026

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2033

2034

(% class="box infomessage" %)

2035

(((

2036

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2037

)))

2038

2039

(% style="color:#000000" %)Метод запроса: **POST**

2040

2041

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2042

2043

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2044

2045

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2050

"vehicleIds": [0], ~/~/ Список ID объектов

2051

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2052

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2053

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2061

"name": "string", ~/~/ Имя ТС

2062

"periods": [ ~/~/ Периоды

2063

{

2064

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2065

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2066

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2067

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2068

"fuelConsumption": 0, ~/~/ Расход топлива

2069

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2076

2077

(% class="box infomessage" %)

2078

(((

2079

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2080

)))

2081

2082

(% style="color:#000000" %)Метод запроса: **POST**

2083

2084

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2085

2086

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2087

2088

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2093

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2094

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2095

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2103

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2104

"vehicleId": 0, ~/~/ ID объекта

2105

"name": "string", ~/~/ Имя объекта

2106

"model": "string", ~/~/ Модель объекта

2107

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2108

{

2109

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2110

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2111

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2112

"valueFuel": 0, ~/~/ Количество

2113

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2114

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2122

2123

(% class="box infomessage" %)

2124

(((

2125

**POST /api/v3/vehicles/moveStop**

2126

)))

2127

2128

Метод запроса: **POST**

2129

2130

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2131

2132

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2139

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2140

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2141

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2149

"vehicleName": "string", ~/~/ Имя объекта

2150

"moves": [ ~/~/ Событие движения

2151

{

2152

"mileage": 0, ~/~/ Пробег, км

2153

"eventId": 0, ~/~/ Идентификатор события

2154

"eventName": "string", ~/~/ Название события

2155

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2156

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2157

"duration": 0 ~/~/ Продолжительность события, секунд

2158

}

2159

],

2160

"stops": [ ~/~/ События стоянок

2161

{

2162

"address": "string", ~/~/ Адрес события

2163

"eventId": 0, ~/~/ Идентификатор события

2164

"eventName": "string", ~/~/ Название события

2165

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2166

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2167

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2175

2176

(% class="box infomessage" %)

2177

(((

2178

**POST /api/v3/vehicles/getlastdata**

2179

)))

2180

2181

Метод запроса: **POST**

2182

2183

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2184

2185

В заголовках запроса: X-Auth: Токен авторизации

2186

2187

2188

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2193

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2194

"vehicleNumber": "string",~/~/Номер объекта.

2195

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2196

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2197

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2198

"speed": 0,~/~/Скорость объекта.

2199

"course": 0,~/~/Курс движения [0;360]

2200

"latitude": 0,~/~/Широта [-90°;90°].

2201

"longitude": 0,~/~/Долгота [-180°;180°].

2202

"address": "string",~/~/Адрес.

2203

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2211

2212

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2213

2214

(% class="box infomessage" %)

2215

(((

2216

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2217

)))

2218

2219

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2220

2221

(% style="color:#000000" %)Метод запроса: **POST**

2222

2223

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2224

2225

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2226

2227

(% style="text-align:left" %)

2228

Тело запроса:

2229

2230

(% style="text-align:left" %)

2231

{

2232

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2233

}

2234

2235

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2241

"name": "string", ~/~/ Название объекта геозоны

2242

"type": 0, ~/~/ Тип объекта геозоны

2243

"fname": "string", ~/~/ Имя файла

2244

"parentId": "string", ~/~/ Идентификатор клиента

2245

"radius": 0, ~/~/ Радиус геообъекта

2246

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2247

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2248

"description": "string", ~/~/ Описание

2249

"area": 0, ~/~/ Площадь, м^^2^^

2250

"perimetr": 0, ~/~/ Периметр, м

2251

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2256

2257

(% class="box infomessage" %)

2258

(((

2259

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2260

)))

2261

2262

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2263

2264

(% style="color:#000000" %)Метод запроса: **POST**

2265

2266

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2267

2268

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2269

2270

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2275

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2276

"ids": [ ], ~/~/ Массив id объектов

2277

"byTime": 0, ~/~/ Объединение событий по времени

2278

"byDist": 0, ~/~/ Объединение событий по расстоянию

2279

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2280

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2287

"geozoneName": "string", ~/~/ Название геообъекта

2288

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2289

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2290

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2291

"vehicleId": 0, ~/~/ ID объекта

2292

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2297

2298

(% class="box infomessage" %)

2299

(((

2300

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2301

)))

2302

2303

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2304

2305

(% style="color:#000000" %)Метод запроса: **POST**

2306

2307

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2308

2309

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2310

2311

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2316

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2317

"ids": [ ], ~/~/ Массив id геообъектов

2318

"byTime": 0, ~/~/ Объединение событий по времени

2319

"byDist": 0, ~/~/ Объединение событий по расстоянию

2320

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2321

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2329

"geozoneName": "string", ~/~/ Название геообъекта

2330

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2331

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2332

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2333

"vehicleId": 0, ~/~/ ID объекта

2334

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2339

2340

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2341

2342

(% class="box infomessage" %)

2343

(((

2344

**POST /api/v3/notifications/find**

2345

)))

2346

2347

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2348

2349

(% style="text-align: left;" %)

2350

Метод запроса **POST**

2351

2352

(% style="text-align: left;" %)

2353

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2354

2355

(% style="text-align: left;" %)

2356

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2357

2358

{

2359

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2367

"name": "string", ~/~/ Название уведомления

2368

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2369

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2370

"userId": "", ~/~/ Пользователь, создавший уведомление

2371

"parentId": "", ~/~/ Идентификатор клиента

2372

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2377

2378

(% class="box infomessage" %)

2379

(((

2380

**GET /api/v3/notifications/{id}**

2381

)))

2382

2383

Метод возвращает данные правил формирования выбранного уведомления.

2384

2385

(% style="text-align: left;" %)

2386

Метод запроса **GET**

2387

2388

(% style="text-align: left;" %)

2389

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2390

2391

(% style="text-align: left;" %)

2392

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2393

2394

(% style="text-align: left;" %)

2395

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2396

2397

(% style="text-align: left;" %)

2398

(% style="color:#000000" %)Ответ:

2399

2400

(% style="text-align: left;" %)

2401

(% style="color:#000000" %){

2402

"id": 0, ~/~/ (%%)id уведомления

2403

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2404

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2405

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2406

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2407

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2408

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2409

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2410

(% style="color:#000000" %) 0

2411

],

2412

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2413

(% style="color:#000000" %) 0

2414

],

2415

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2416

(% style="color:#000000" %) 0

2417

],

2418

"settings": { ~/~/ Список параметров уведомления

2419

"additionalProp1": "string",

2420

"additionalProp2": "string",

2421

"additionalProp3": "string"

2422

},

2423

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2424

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2425

(% style="color:#000000" %) ""

2426

],

2427

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2428

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2429

(% style="color:#000000" %) "string"

2430

],

2431

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2432

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2433

(% style="color:#000000" %) {

2434

"id": 0, ~/~/ (%%)Идентификатор участника чата

2435

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2436

(% style="color:#000000" %) }

2437

],

2438

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2439

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2440

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2441

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2442

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2443

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2444

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2445

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2446

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2447

(% style="color:#000000" %)}

2448

2449

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2450

2451

(% class="box warningmessage" %)

2452

(((

2453

**PUT /api/v3/notifications/**

2454

)))

2455

2456

Метод позволяет отредактировать уведомление.

2457

2458

Метод запроса **PUT**

2459

2460

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2461

2462

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2467

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2468

"userId": "", ~/~/ Пользователь, создавший уведомление

2469

"parentId": "", ~/~/ Идентификатор клиента

2470

"parentName": "string", ~/~/ Имя клиента

2471

"name": "string", ~/~/ Название уведомления

2472

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2473

"vehicleIds": [ ~/~/ Список id объектов для анализа

2474

0

2475

],

2476

"geoids": [ ~/~/ Список id геообъектов для анализа

2477

0

2478

],

2479

"fieldids": [ ~/~/ Список id полей для анализа

2480

0

2481

],

2482

"settings": { ~/~/ Список параметров уведомления

2483

"additionalProp1": "string",

2484

"additionalProp2": "string",

2485

"additionalProp3": "string"

2486

},

2487

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2488

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2489

""

2490

],

2491

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2492

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2493

"string"

2494

],

2495

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2496

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2497

{

2498

"id": 0, ~/~/ Идентификатор участника чата

2499

"info": "string" ~/~/ Дополнительные сведения

2500

}

2501

],

2502

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2503

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2504

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2505

"kind": 0, ~/~/ Определяет вид уведомления

2506

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2507

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2508

"timezone": 0, ~/~/ Сдвиг часового пояса

2509

"validity": 0, ~/~/ Срок действия в днях (1-90)

2510

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2518

2519

(% class="box errormessage" %)

2520

(((

2521

**DELETE /api/v3/notifications/{id}**

2522

)))

2523

2524

Метод позволяет удалить выбранное уведомление.

2525

2526

Метод запроса **DELETE**

2527

2528

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2529

2530

Передаваемый параметр: {id} - id уведомления

2531

2532

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2540

2541

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2542

2543

(% class="box infomessage" %)

2544

(((

2545

**POST /api/v3/Drivers/find**

2546

)))

2547

2548

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2555

"description": "string", ~/~/ Определяет описание

2556

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2557

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2558

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2559

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2560

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2561

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2566

2567

(% class="box infomessage" %)

2568

(((

2569

**GET /api/v3/Drivers/{driverGuid}**

2570

)))

2571

2572

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2578

"description": "string", ~/~/ Определяет описание

2579

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2580

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2581

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2582

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2583

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2584

"deleted": true ~/~/ Признак удаления

2585

}

2586

2587

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2588

2589

(% class="box successmessage" %)

2590

(((

2591

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2599

"hiredate": "2023-06-30T12:50:54.020Z",

2600

"chopdate": "2023-06-30T12:50:54.020Z",

2601

"exclusive": true,

2602

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2603

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2612

"hiredate": "2023-06-30T12:50:54.051Z",

2613

"chopdate": "2023-06-30T12:50:54.051Z",

2614

"exclusive": true,

2615

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2616

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2622

2623

(% class="box warningmessage" %)

2624

(((

2625

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2633

"hiredate": "2023-06-30T12:50:27.910Z",

2634

"chopdate": "2023-06-30T12:50:27.910Z",

2635

"exclusive": true,

2636

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2637

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2646

"hiredate": "2023-06-30T12:50:27.929Z",

2647

"chopdate": "2023-06-30T12:50:27.929Z",

2648

"exclusive": true,

2649

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2650

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2656

2657

(% class="box errormessage" %)

2658

(((

2659

**DELETE /api/v3/Drivers/{driverGuid}**

2660

)))

2661

2662

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2670

2671

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2672

2673

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2674

2675

(% class="box infomessage" %)

2676

(((

2677

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2685

],

2686

"BeginTime": "2023-06-30T12:49:04.365Z",

2687

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2696

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2697

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2698

"BeginTime": "2023-06-30T09:52:31.240Z",

2699

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2705

2706

(% class="box infomessage" %)

2707

(((

2708

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2718

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2727

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2728

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2729

"BeginTime": "2023-06-30T09:54:01.631Z",

2730

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2736

2737

(% class="box successmessage" %)

2738

(((

2739

**POST /api/v3/DriversVehiclesAssignments**

2740

)))

2741

2742

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2749

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2750

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2751

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2752

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2762

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2763

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2764

"BeginTime": "2023-06-30T11:04:46.903Z",

2765

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2771

2772

(% class="box warningmessage" %)

2773

(((

2774

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2783

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2784

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2785

"BeginTime": "2023-06-30T11:14:08.117Z",

2786

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2796

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2797

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2798

"BeginTime": "2023-06-30T11:14:53.349Z",

2799

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2805

2806

(% class="box errormessage" %)

2807

(((

2808

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2823

2824

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2825

2826

(% class="box infomessage" %)

2827

(((

2828

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2836

],

2837

"BeginTime": "2023-06-30T12:47:12.162Z",

2838

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2846

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2847

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2848

"BeginTime": "2023-06-30T11:19:40.703Z",

2849

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2855

2856

(% class="box infomessage" %)

2857

(((

2858

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2866

],

2867

"BeginTime": "2023-06-30T12:47:12.162Z",

2868

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2876

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2877

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2878

"BeginTime": "2023-06-30T11:19:40.703Z",

2879

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2885

2886

(% class="box successmessage" %)

2887

(((

2888

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2896

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2897

"BeginTime": "2023-06-30T11:27:08.635Z",

2898

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2907

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2908

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2909

"BeginTime": "2023-06-30T11:27:08.677Z",

2910

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

2916

2917

(% class="box warningmessage" %)

2918

(((

2919

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2927

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2928

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2929

"BeginTime": "2023-06-30T11:28:43.330Z",

2930

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2939

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2940

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2941

"BeginTime": "2023-06-30T11:28:43.331Z",

2942

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

2948

2949

(% class="box errormessage" %)

2950

(((

2951

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

2966

2967

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

2968

2969

(% class="box infomessage" %)

2970

(((

2971

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2979

],

2980

"BeginTime": "2023-06-30T12:45:10.852Z",

2981

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2989

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2990

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2991

"BeginTime": "2023-06-30T11:58:04.695Z",

2992

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

2998

2999

(% class="box infomessage" %)

3000

(((

3001

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3009

],

3010

"BeginTime": "2023-06-30T12:45:10.852Z",

3011

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3019

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3020

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3021

"BeginTime": "2023-06-30T11:58:04.695Z",

3022

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3028

3029

(% class="box successmessage" %)

3030

(((

3031

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3039

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3040

"BeginTime": "2023-06-30T12:09:53.175Z",

3041

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3050

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3051

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3052

"BeginTime": "2023-06-30T12:09:53.201Z",

3053

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3059

3060

(% class="box warningmessage" %)

3061

(((

3062

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3070

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3071

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3072

"BeginTime": "2023-06-30T12:09:53.201Z",

3073

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3082

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3083

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3084

"BeginTime": "2023-06-30T12:09:53.201Z",

3085

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3091

3092

(% class="box errormessage" %)

3093

(((

3094

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3109

3110

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3111

3112

(% class="box infomessage" %)

3113

(((

3114

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3121

"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);" %)**Описание**

3127

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3128

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3129

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3130

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3137

"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",

3147

"name": "string",

3148

"rid": "string",

3149

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3150

"trailer": {

3151

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3152

"Number": "string",

3153

"Description": "string",

3154

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3155

"ExternalID": "string",

3156

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3157

"CreateTime": "2023-11-14T10:48:03.717Z",

3158

"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);" %)**Описание**

3166

|SD|Дата и время начала события

3167

|ED|Дата и время окончания события

3168

|id|ID объекта

3169

|SLat|Широта начальной координаты

3170

|SLon|Долгота начальной координаты

3171

|ELat|Широта конечной координаты

3172

|ELon|Долгота конечной координаты

3173

|mileage|Пробег

3174

|Duration|Продолжительность

3175

|Address|Адрес начального местоположения

3176

|Address2|Адрес конечного местоположения

3177

|name|Имя радиометки

3178

|rid|Номер радиометки

3179

|rguid|ID радиометки

3180

|trailer|Информация об агрегате

3181

|ModelGuid|ID агрегата

3182

|Number|Название/номер агрегата

3183

|Description|Текст примечания агрегата

3184

3185

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3186

3187

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3188

3189

(% class="box infomessage" %)

3190

(((

3191

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3208

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3213

|parentId|ID клиента

3214

|name|Название карты-метки

3215

|number|Номер

3216

|period|Период запросов в секундах (работает только для агрегатов)

3217

|id|ID карты-метки

3218

3219

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3220

3221

(% class="box infomessage" %)

3222

(((

3223

**GET /api/v3/Rfids/{rfidGuid}**

3224

)))

3225

3226

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3236

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3241

|name|Название карты-метки

3242

|number|Номер

3243

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3248

3249

(% class="box successmessage" %)

3250

(((

3251

**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",

3270

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3271

}

3272

3273

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3274

|name|Название карты-метки

3275

|number|Номер

3276

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3281

3282

(% class="box warningmessage" %)

3283

(((

3284

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3294

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3304

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3305

}

3306

3307

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3308

|name|Название карты-метки

3309

|number|Номер

3310

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3315

3316

(% class="box errormessage" %)

3317

(((

3318

**DELETE /api/v3/Rfids/{rfidGuid}**

3319

)))

3320

3321

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3329

3330

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3331

3332

(% class="box infomessage" %)

3333

(((

3334

**GET /api/v3/Billing/client/balance/{clientId}**

3335

)))

3336

3337

Параметр запроса: **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);" %)**Описание**

3347

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3348

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3349

3350

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3351

3352

(% class="box infomessage" %)

3353

(((

3354

**GET /api/v3/Billing/client/constraint/{clientId}**

3355

)))

3356

3357

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3363

"CalculationType": 0,

3364

"PermissibleBalance": 0,

3365

"DefermentDays": 0,

3366

"SendUiNotifications": true,

3367

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3372

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3373

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3374

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3375

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3376

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3377

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3378

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3379

3380

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3381

3382

(% class="box infomessage" %)

3383

(((

3384

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3390

3391

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3397

"Plan": { **~/~/ Описание тарифного плана**

3398

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3399

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3404

"PermissibleBalance": 0,

3405

"DefermentDays": 0

3406

},

3407

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3419

"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);" %)**Описание**

3435

|ClientId|Идентификатор клиента

3436

|Id|Идентификатор тарифного плана

3437

|OwnerId|Идентификатор клиента-владельца

3438

|Name|Наименование тарифного плана

3439

|IsArchived|Признак, определяющий архивный тарифный план

3440

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3441

|PermissibleBalance|Допустимый баланс

3442

|DefermentDays|Отсрочка, количество дней

3443

|Feature|Код услуги

3444

|IsEnabled|Признак, определяющий активирована ли услуга

3445

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3446

|IsFactual|Признак, определяющий расчёт по факту

3447

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3448

|Price|Цена за единицу.

3449

|DebitDate|Следующий момент времени списания с баланса за услугу.

3450

|PeriodValue|Значение периода.

3451

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3452

3453

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3454

3455

(% class="box infomessage" %)

3456

(((

3457

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3458

)))

3459

3460

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3467

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3472

"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);" %)**Описание**

3489

|ClientId|Идентификатор клиента

3490

|Id|Идентификатор тарифного плана

3491

|OwnerId|Идентификатор клиента-владельца

3492

|Name|Наименование тарифного плана

3493

|IsArchived|Признак, определяющий архивный тарифный план

3494

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3495

|PermissibleBalance|Допустимый баланс

3496

|DefermentDays|Отсрочка, количество дней

3497

|Feature|Код услуги

3498

|IsFactual|Признак, определяющий расчёт по факту

3499

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3500

|Price|Цена за единицу.

3501

|PeriodValue|Значение периода.

3502

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3503

3504

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3505

3506

(% class="box infomessage" %)

3507

(((

3508

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3509

)))

3510

3511

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3518

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3523

"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);" %)**Описание**

3540

|ClientId|Идентификатор клиента

3541

|Id|Идентификатор тарифного плана

3542

|OwnerId|Идентификатор клиента-владельца

3543

|Name|Наименование тарифного плана

3544

|IsArchived|Признак, определяющий архивный тарифный план

3545

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3546

|PermissibleBalance|Допустимый баланс

3547

|DefermentDays|Отсрочка, количество дней

3548

|Feature|Код услуги

3549

|IsFactual|Признак, определяющий расчёт по факту

3550

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3551

|Price|Цена за единицу.

3552

|PeriodValue|Значение периода.

3553

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3554

3555

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3556

3557

(% class="box warningmessage" %)

3558

(((

3559

**PUT /api/v3/Billing/client/balance**

3560

)))

3561

3562

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3574

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3575

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3576

3577

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3578

3579

(% class="box warningmessage" %)

3580

(((

3581

**PUT /api/v3/billing/client/balance/deposit**

3582

)))

3583

3584

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3596

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3597

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3598

3599

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3600

3601

Создает операцию **Списание **с указанной суммой

3602

3603

(% class="box warningmessage" %)

3604

(((

3605

**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);" %)**Описание**

3618

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3619

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3620

3621

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3622

3623

(% class="box warningmessage" %)

3624

(((

3625

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3632

"CalculationType": 0,

3633

"PermissibleBalance": 0,

3634

"DefermentDays": 0,

3635

"SendUiNotifications": true,

3636

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3643

|ClientId|Идентификатор клиента

3644

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3645

|PermissibleBalance|Допустимый баланс

3646

|DefermentDays|(((

3647

Отсрочка, количество дней

3648

)))

3649

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3650

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3651

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3652

3653

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3654

3655

(% class="box warningmessage" %)

3656

(((

3657

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3664

"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);" %)**Описание**

3682

|ClientId|Идентификатор клиента

3683

|PlanId|Идентификатор тарифного плана

3684

|Feature|Код услуги

3685

|IsEnabled|Признак, определяющий активирована ли услуга

3686

|IsFactual|Признак, определяющий расчёт по факту

3687

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3688

|Price|Цена за единицу.

3689

|DebitDate|Следующий момент времени списания с баланса за услугу.

3690

|PeriodValue|Значение периода.

3691

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3692

3693

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3694

3695

(% class="box warningmessage" %)

3696

(((

3697

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3698

)))

3699

3700

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3701

3702

(% class="box infomessage" %)

3703

(((

3704

**POST /api/v3/vehicles/import/{agentId}**

3705

)))

3706

3707

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3708

3709

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3718

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3719

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3720

3721

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3726

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3727

|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);" %)**Описание**

3738

|vehicleId|ID созданного объекта

3739

|name|Имя созданного объекта

3740

|errors|Ошибки и их описание

3741

3742

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3743

3744

(% class="box infomessage" %)

3745

(((

3746

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3747

)))

3748

3749

(% class="wikigeneratedid" %)

3750

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3751

3752

(% class="wikigeneratedid" %)

3753

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3758

3759

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3764

|**history**|В значении передавать файл с историей

3765

3766

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3779

"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);" %)**Описание**

3787

|results|Результаты импорта в разрезе ТС

3788

|vehicleGuid|Guid ТС

3789

|vehicleId|ID ТС

3790

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3791

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3792

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3793

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3794

|msgCount|Кол-во обработанных сообщений всего

3795

3796

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3797

3798

(% class="box infomessage" %)

3799

(((

3800

**GET /api/v3/vehicles/import/history/status**

3801

)))

3802

3803

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3814

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3815

|progress|Guid ТС

3816

3817

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3818

3819

(% class="box infomessage" %)

3820

(((

3821

**POST /api/v3/vehicles/export**

3822

)))

3823

3824

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3833

3834

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3835

3836

(% class="box infomessage" %)

3837

(((

3838

**POST /api/v3/vehicles/export/history**

3839

)))

3840

3841

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3849

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3855

3856

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3857

|vehicleId|ID объекта

3858

|asArchive|true - Архивировать файл, False - не архивировать

3859

|from|Дата и время начала запроса

3860

|to|Дата и время окончания запроса

3861

3862

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3863

3864

(% class="box infomessage" %)

3865

(((

3866

**GET /api/v3/vehicles/export/history/status**

3867

)))

3868

3869

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3880

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3881

|progress|Прогресс экспорта, от 0 до 100%

3882

|message|Текст описывающий статус

3883

3884

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3885

3886

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

3887

3888

(% class="box infomessage" %)

3889

(((

3890

**POST /api/v3/EcoDriving/rating**

3891

)))

3892

3893

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3899

"from": "2023-11-22T09:29:48.051Z",

3900

"to": "2023-11-22T09:29:48.051Z"

3901

}

3902

3903

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3904

|vehicleIds|Массив ID объектов

3905

|from|Дата начала запроса

3906

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

3914

"to": "2023-11-22T09:29:48.052Z",

3915

"vehicleId": 0,

3916

"vehicleName": "string",

3917

"vehicleModel": "string",

3918

"penalty": 0,

3919

"score": 0,

3920

"totalViolations": 0,

3921

"violationsByType": {

3922

"overspeedingViolations": 0,

3923

"accelerationViolations": 0,

3924

"brakingViolations": 0,

3925

"turningViolations": 0,

3926

"dangerousDrivingViolations": 0,

3927

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

3937

"violationsByType": {

3938

"overspeedingViolations": 0,

3939

"accelerationViolations": 0,

3940

"brakingViolations": 0,

3941

"turningViolations": 0,

3942

"dangerousDrivingViolations": 0,

3943

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

3950

"endAddress": "string",

3951

"drivers": [

3952

{

3953

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3954

"driverName": "string",

3955

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3965

|from|Дата начала запроса

3966

|to|Дата окончания

3967

|vehicleId|ID объекта

3968

|vehicleName|Имя объекта

3969

|vehicleModel|Модель объекта

3970

|penalty|Сумма штрафных баллов

3971

|score|Оценка

3972

|totalViolations|Суммарное количество нарушений

3973

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

3974

|overspeedingViolations|Превышение скорости

3975

|accelerationViolations|Ускорение

3976

|brakingViolations|Торможение

3977

|turningViolations|Резкий поворот

3978

|dangerousDrivingViolations|Резкое вождение

3979

|sensorViolations|Нарушение по датчику

3980

|moveTime|Время в движении

3981

|mileage|Пробег

3982

|tripsCount|Количество рейсов

3983

|motohours|Моточасы

3984

|maxSpeed|Максимальная скорость

3985

|startAddress|Адрес начала рейса

3986

|endAddress|Адрес окончания рейса

3987

|drivers|Список водителей, которые были на объекте в течениии рейса

3988

|driverGuid|Guid водителя

3989

|driverName|Имя водителя

3990

|driverRfid|Номер Карты-метки

3991

3992

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

3993

3994

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

3995

3996

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

3997

3998

(% class="box infomessage" %)

3999

(((

4000

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4006

\\В заголовках запроса: X-Auth: Токен авторизации

4007

4008

Параметры в теле запроса (JSON):

4009

4010

{

4011

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4012

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4013

"ids": [

4014

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4015

],

4016

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4023

"driver": "string", ~/~/Водители, привязанные к ТК

4024

"object": "string", ~/~/Наименование ТС

4025

"amount": 0, ~/~/Количество топлива

4026

"amountDut": 0, ~/~/Количество по ДУТ

4027

"amountDiff": 0, ~/~/Разница, л

4028

"amountDiffPerc": 0, ~/~/Разница, %

4029

"summa": 0, ~/~/Стоимость, руб

4030

"serviceName": "string", ~/~/Тип топлива

4031

"price": 0, ~/~/Цена за литр, руб

4032

"cardName": "string", ~/~/Наименование ТК

4033

"cardNum": "string", ~/~/Номер ТК

4034

"operator": "string", ~/~/Оператор ТК

4035

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4040

4041

4042

== **Получение полных данных о ретрансляторе** ==

4043

4044

(% class="box infomessage" %)

4045

(((

4046

**GET ** **/api/v3/retranslations/{id}**

4047

)))

4048

4049

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4056

"subscriberId": "", ~/~/ Подписчик

4057

"protocolType": 0, ~/~/ Тип протокола

4058

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4059

"address": "string", ~/~/ Адрес события

4060

"objects": [ ~/~/Объекты для ретрансляции

4061

{

4062

"id": "", ~/~/ Идентификатор объекта ретрансляции

4063

"name": "", ~/~/ Наименование объекта ретрансляции

4064

"imei": "", ~/~/ IMEI объекта

4065

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4066

}

4067

],

4068

"id": "", ~/~/ идентификатор пользователя

4069

"parentId": "", ~/~/Guid родителя

4070

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4075

4076

(% class="box infomessage" %)

4077

(((

4078

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4085

4086

(% class="box infomessage" %)

4087

(((

4088

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4095

"subscriberId": "", ~/~/ Подписчик

4096

"protocolType": 0, ~/~/ Тип протокола

4097

"address": "", ~/~/ Адрес ретрансляции

4098

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4099

"objects": [ ~/~/Объекты для ретрансляции

4100

{

4101

"id": "", ~/~/ идентификатор пользователя

4102

"imei": "", ~/~/IMEI объекта

4103

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4113

"subscriberId": "", ~/~/ идентификатор запроса

4114

"protocolType": 0, ~/~/ Тип протокола

4115

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4116

"address": "", ~/~/ Адрес события

4117

"objects": [ ~/~/Объекты для ретрансляции

4118

{

4119

"id": "", ~/~/ идентификатор пользователя

4120

"name": "string", ~/~/ Название уведомления

4121

"imei": "string", ~/~/IMEI объекта

4122

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4123

}

4124

],

4125

"id": "", ~/~/ идентификатор пользователя

4126

"parentId": "", ~/~/ Guid идентификатор родителя

4127

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4132

4133

(% class="box infomessage" %)

4134

(((

4135

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4142

"description": "string", ~/~/ Определяет описание

4143

"subscriberId": "", ~/~/ идентификатор запроса

4144

"protocolType": 0, ~/~/ Тип протокола

4145

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4146

"address": "string", ~/~/ Адрес события

4147

"objects": ~/~/Объекты для ретрансляции

4148

[

4149

{

4150

"id": "", ~/~/ идентификатор пользователя

4151

"imei": "", ~/~/IMEI объекта

4152

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4162

"subscriberId": "", ~/~/ идентификатор запроса

4163

"protocolType": 0, ~/~/ Тип протокола

4164

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4165

"address": "string", ~/~/ Адрес события

4166

"objects": [ ~/~/Объекты для ретрансляции

4167

{

4168

"id": "", ~/~/ идентификатор пользователя

4169

"name": "string", ~/~/ Название уведомления

4170

"imei": "", ~/~/IMEI объекта

4171

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4172

}

4173

],

4174

"id": "", ~/~/ идентификатор пользователя

4175

"parentId": "", ~/~/ Guid идентификатор родителя

4176

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4181

4182

(% class="box infomessage" %)

4183

(((

4184

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4191

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4192

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4200

"subscriberId": "", ~/~/ идентификатор запроса

4201

"protocolType": 0, ~/~/ Тип протокола

4202

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4203

"address": "string", ~/~/ Адрес события

4204

"id": "", ~/~/ идентификатор пользователя

4205

"parentId": "", ~/~/ Guid идентификатор родителя

4206

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4212

4213

== **API для отчета по выгрузке комбайнов** ==

4214

4215

(% class="box infomessage" %)

4216

(((

4217

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4224

"byDist": 0, ~/~/ Объединение событий по расстоянию

4225

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4226

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4227

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4228

"vehicleIds": [ ~/~/ Список id объектов для анализа

4229

0

4230

],

4231

"from": "", ~/~/ Дата и время начало запроса

4232

"to": "", ~/~/ Дата и время окончания запроса

4233

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4241

"harvesterId": 0, ~/~/Комбайн, id

4242

"harvesterModel": "", ~/~/ Модель комбайна

4243

"hopperCapacity": 0, ~/~/ Объем бункера м3

4244

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4245

"events": [ ~/~/Список событий в разрезе комбайна

4246

{

4247

"driverId": "", ~/~/Идентификатор водителя

4248

"driverName": "", ~/~/Водитель комбайна, ФИО

4249

"RFID": "", ~/~/ идентификатор карты-метки

4250

"rfidName": "", ~/~/Водитель комбайна, имя метки

4251

"vehicleId": 0, ~/~/идентификатор объекта

4252

"vehicleName": "string", ~/~/ Имя объекта

4253

"modelName": "string", ~/~/ Имя модели объекта

4254

"nearestVehicles": [ ~/~/Объекты рядом

4255

{

4256

"vehicleId": 0, ~/~/идентификатор объекта

4257

"vehicleName": "string" ~/~/ Имя объекта

4258

}

4259

],

4260

"fields": [ ~/~/Поля, где происходила выгрузка

4261

{

4262

"id": 0, ~/~/ идентификатор пользователя

4263

"name": "string" ~/~/ имя пользователя

4264

}

4265

],

4266

"event": "string", ~/~/Событие

4267

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4268

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4269

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4270

"cultureName": "string", ~/~/ название культуры

4271

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4272

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4273

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4274

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4275

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4276

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4277

"issued": 0, ~/~/Выдано, бункеров

4278

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4279

"latitude": 0, ~/~/Широта

4280

"longitude": 0, ~/~/ Долгота

4281

"litresAway": 0, ~/~/Отдано, л

4282

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4290

4291

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4292

4293

4294

(% class="box infomessage" %)

4295

(((

4296

GET api/v3/Vehicles/recyclebin/all

4297

)))

4298

4299

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4300

4301

Параметр запроса: {parentId} - идентификатор агента

4302

4303

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4310

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4311

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4312

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4313

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4314

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4315

"details": { ~/~/Список деталей объекта, помещённого в корзину

4316

"items": [ ~/~/

4317

nullable: true ~/~/Детали

4318

{

4319

"name": "string", ~/~/наименование столбца

4320

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4332

4333

(% class="box infomessage" %)

4334

(((

4335

POST/api/v3/Vehicles/recyclebin/erase

4336

)))

4337

4338

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4352

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4353

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4354

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4355

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4356

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4357

"details": { ~/~/Список деталей объекта, помещённого в корзину

4358

"items": [ ~/~/Детали

4359

{

4360

"name": "", ~/~/Имя свойства

4361

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4372

4373

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4374

4375

(% class="box infomessage" %)

4376

(((

4377

POST/api/v3/Vehicles/recyclebin/restore

4378

)))

4379

4380

В заголовках запроса: X-Auth: Токен авторизации

4381

4382

Параметры в теле запроса (JSON):

4383

4384

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4385

4386

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4409

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4410

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4411

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4412

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4413

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4414

"details": { ~/~/Список деталей объекта, помещённого в корзину

4415

"items": [ ~/~/Детали

4416

{

4417

"name": "string", ~/~/Имя свойства

4418

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4431

(((

4432

(% 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]] **

4433

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню