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

20

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

21

22

- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).

23

24

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

25

26

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

27

28

(% class="box successmessage" %)

29

(((

30

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

31

)))

32

33

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

34

35

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

36

37

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

38

39

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

40

41

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

42

43

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

44

"login": "testuser",

45

"password": "testuser"

46

}

47

48

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

49

50

(% lang="en-US" %)

51

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

52

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

53

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

54

}

55

56

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

57

58

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

59

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

60

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

61

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

62

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

63

64

(% class="wikigeneratedid" %)

65

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

66

67

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

68

69

(% class="box infomessage" %)

70

(((

71

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

72

)))

73

74

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

75

76

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

77

78

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

79

80

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

81

82

(% lang="en-US" %)

83

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

84

85

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

86

87

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

88

89

(% class="box infomessage" %)

90

(((

91

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

92

)))

93

94

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

95

96

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

97

98

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

99

100

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

101

102

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

103

104

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

109

"name": "string",

110

"fullName": "string",

111

"agentInfoType": 0,

112

"isForeign": true/false,

113

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

120

"email": "string",

121

"director": "string",

122

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

150

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

151

152

(% class="box infomessage" %)

153

(((

154

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

155

)))

156

157

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

158

159

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

160

161

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

162

163

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

164

165

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

166

167

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

168

169

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

170

171

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

"parentId": "string"

}

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

176

177

{

178

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

179

"parentId": "",

180

"name": "string",

181

"fullName": "string",

182

"agentInfoType": 0,

183

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

}

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

188

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

189

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

190

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

191

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

192

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

193

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

194

195

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

196

197

(% class="box successmessage" %)

198

(((

199

**POST /api/v3/agents **

200

)))

201

202

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

203

204

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

205

206

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

207

208

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

209

210

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

211

212

{

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

}

Ответ:

{

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

}

256

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

279

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

280

281

(% class="box warningmessage" %)

282

(((

283

**PUT /api/v3/agents**

284

)))

285

286

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

287

288

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

289

290

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

291

292

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

293

294

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

295

296

{

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

}

Ответ:

{

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

}

340

341

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

342

343

(% class="box errormessage" %)

344

(((

345

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

346

)))

347

348

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

349

350

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

351

352

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

353

354

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

355

356

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

357

358

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

359

360

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

361

362

(% class="box warningmessage" %)

363

(((

364

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

365

)))

366

367

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

368

369

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

370

371

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

Ответ: Code 204

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

376

377

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

378

379

(% class="box successmessage" %)

380

(((

381

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

382

)))

383

384

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

385

386

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

387

388

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

389

390

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

391

392

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

393

394

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

395

{

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

"doubleAuth":

412

{

413

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

414

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

},

"groups":

[

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

],

"customGroups":

[

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

423

],

424

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

425

}

426

{

427

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

428

"lastName": "string",

429

"firstName": "string",

430

"position": "string",

431

"phone": "string",

432

"organization": "string",

433

"login": "string",

434

"password": "string",

435

"email": "string",

436

437

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

438

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

439

{

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

}

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

461

462

(% class="box infomessage" %)

463

(((

464

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

465

)))

466

467

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

468

469

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

470

471

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

472

473

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

474

475

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

476

477

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

478

479

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

480

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

481

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

482

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

483

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

484

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

485

486

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

487

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

504

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

505

506

(% class="box infomessage" %)

507

(((

508

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

509

)))

510

511

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

512

513

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

514

515

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

516

517

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

518

519

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

(((

(((

{

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

"doubleAuth":

539

{

540

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

541

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

542

},

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

}

)))

)))

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

557

558

(% class="box warningmessage" %)

559

(((

560

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

561

)))

562

563

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

564

565

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

566

567

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

568

569

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

570

571

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

572

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

573

574

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

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

"doubleAuth":

593

{

594

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

595

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

596

},

597

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

598

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

599

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

600

601

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

602

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

603

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

"doubleAuth":

620

{

621

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

622

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

623

},

624

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

625

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

626

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

627

}

628

629

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

630

631

(% class="box warningmessage" %)

632

(((

633

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

634

)))

635

636

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

637

638

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

639

640

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

641

642

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

643

644

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

645

646

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

647

648

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

649

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

650

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

651

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

652

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

653

654

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

655

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

656

657

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

658

659

(% class="box warningmessage" %)

660

(((

661

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

662

)))

663

664

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

665

666

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

667

668

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

669

670

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

671

672

[

673

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

674

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

675

]

676

677

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

678

679

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

680

681

(% class="box warningmessage" %)

682

(((

683

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

684

)))

685

686

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

687

688

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

689

690

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

691

692

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

693

694

[

695

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

696

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

697

]

698

699

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

700

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

(((

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

{

"errorMessages": [

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

707

],

708

"users": [

709

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

710

]

711

}

712

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

713

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

714

)))

715

716

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

717

718

(% class="box errormessage" %)

719

(((

720

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

721

)))

722

723

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

724

725

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

726

727

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

728

729

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

730

731

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

732

733

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

734

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

735

736

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

737

738

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

739

740

(% class="box infomessage" %)

741

(((

742

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

743

)))

744

745

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

746

747

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

748

749

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

750

751

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

752

753

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

754

755

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

756

757

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

758

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

765

"hoppercapacity": 0,

766

"hopperdischargespeed": 0,

767

"modelType": 0,

768

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

769

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

774

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

775

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

776

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

777

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

788

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

789

790

(% class="box successmessage" %)

791

(((

792

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

793

)))

794

795

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

796

797

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

798

799

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

800

801

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

802

803

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

804

805

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

806

}

807

808

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

809

810

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

811

{

812

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

813

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

814

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

821

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

822

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

823

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

824

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

825

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

826

827

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

828

829

(% class="box successmessage" %)

830

(((

831

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

832

)))

833

834

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

835

836

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

837

838

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

839

840

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

841

842

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

843

844

{

845

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

846

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

855

"fueloutlay": 0,

856

"hoppercapacity": 0,

857

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

865

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

874

"hoppercapacity": 0,

875

"hopperdischargespeed": 0,

"modelType": 0

}

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

893

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

894

895

(% class="box warningmessage" %)

896

(((

897

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

898

)))

899

900

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

901

902

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

903

904

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

905

906

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

907

908

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

909

910

{

911

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

912

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

921

"fueloutlay": 0,

922

"hoppercapacity": 0,

923

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

931

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

940

"fueloutlay": 0,

941

"hoppercapacity": 0,

942

"hopperdischargespeed": 0,

"modelType": 0

}

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

960

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

961

962

(% class="box errormessage" %)

963

(((

964

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

965

)))

966

967

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

968

969

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

970

971

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

972

973

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

974

975

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

976

977

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

978

979

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

980

981

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

982

983

(% class="box infomessage" %)

984

(((

985

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

986

)))

987

988

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

989

990

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

991

992

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

993

994

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

995

996

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

997

998

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

999

1000

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

1001

1002

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

1003

1004

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

(((

{

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

},

1024

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

1025

{

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

}

1033

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

},

1059

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

},

1067

1068

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

1069

{

1070

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

1071

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

1072

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

1073

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

1074

}

1075

],

1076

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

1077

{

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

{

1091

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

1092

{

1093

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

1094

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

1095

}

1096

],

1097

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

1098

}

1099

],

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

1106

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

1107

"string"

1108

],

1109

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

1110

"additionalProp1": "string",

1111

"additionalProp2": "string",

1112

"additionalProp3": "string"

1113

},

1114

1115

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

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

}

1129

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

1130

{

1131

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

1132

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

1133

"description": "string",

1134

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

1135

}

1136

],

1137

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

1138

{

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

}

1152

],

1153

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

1154

{

1155

"status": 0,

1156

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

1157

"description": "string",

1158

"additionalInfo": "string"

}

]

}

)))

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

1165

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

1166

1167

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

1168

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

1169

1170

1171

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

1172

1173

(% class="box successmessage" %)

1174

(((

1175

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

1176

)))

1177

1178

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

1179

1180

{

1181

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

1182

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

1183

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

1184

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

}

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

1189

1190

(% class="box infomessage" %)

1191

(((

1192

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

1193

)))

1194

1195

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

1196

1197

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

1198

1199

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

1200

1201

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

1202

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

1203

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

1204

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

1205

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

1206

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

1207

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

1208

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

1209

1210

(((

1211

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

1212

1213

(% class="box infomessage" %)

1214

(((

1215

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

1216

)))

1217

1218

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

1219

1220

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

1221

1222

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

[

{

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

1227

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

1228

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

1229

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

1230

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

1231

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

1232

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

}

]

)))

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

1238

1239

(% class="box successmessage" %)

1240

(((

1241

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

1242

)))

1243

1244

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

1245

1246

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

1247

1248

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

1249

1250

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

1251

1252

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

1253

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

"mileageCalcMethod": 0,

1276

"mileageCoeff": 0,

1277

"locationByCellId": true,

1278

"dottedLineTrackWhenNoCoords": true,

1279

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

1280

{

1281

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

1282

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

1283

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

1284

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

1285

},

1286

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

1287

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

1288

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

1289

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

1290

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

1291

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

1292

},

1293

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

1294

{

1295

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

1296

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

1297

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

1298

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

1299

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

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

1306

}

1307

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

1308

{

1309

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

"isDefault": true

}

],

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

1314

{

1315

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1322

{

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

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

1331

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

1332

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

1333

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

1334

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

1335

{

1336

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

1337

{

1338

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

1339

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

1340

}

1341

],

1342

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

1343

}

1344

],

1345

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

1346

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

1347

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

1348

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

1349

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

1350

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

1351

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

1352

"string"

1353

],

1354

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

1355

"additionalProp1": "string",

1356

"additionalProp2": "string",

1357

"additionalProp3": "string"

1358

},

1359

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

1360

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

1361

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

1362

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

1363

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

1364

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

1365

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

1366

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

1367

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

1368

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

1369

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

1370

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

1371

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

1372

}

1373

],

1374

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

1375

{

1376

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1387

1388

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

1389

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

1390

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

1391

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

1392

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

1393

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

1394

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

1395

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

1396

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

1397

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

1398

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

1399

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

1400

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

1401

"mileageEnabled": true,

1402

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1407

"id": null,

1408

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

1409

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

1410

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

1411

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

1412

},

1413

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

1414

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

1415

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

1416

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

1417

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

1418

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

1419

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

1420

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

1421

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

1422

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

1423

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

1424

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

1425

}

1426

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

1427

1428

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

1429

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1430

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1431

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1432

1433

== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==

1434

1435

(% class="box infomessage" %)

1436

(((

1437

(% lang="en-US" %)**POST /api/v3/vehicles/find**

1438

)))

1439

1440

(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

1441

1442

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:

1443

1444

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

1445

1446

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

1447

1448

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

1449

1450

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

1451

1452

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

1453

1454

(% style="color:#000000" %)Метод запроса: **POST**

1455

1456

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

1457

1458

(% style="color:#000000" %)В заголовках запроса:

1459

1460

(% style="color:#000000" %)− Content-Type: __**application/json**__

1461

1462

(% style="color:#000000" %)− X-Auth: Токен авторизации

1463

1464

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1465

1466

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1467

1468

{

1469

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1470

"name": null, ~/~/ Имя ТС (string, опционально)

1471

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1472

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1473

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1474

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1475

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1476

"customFields": null ~/~/ значение любого из произвольных полей ТС

1477

}

1478

1479

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1480

1481

(% style="color:#000000" %)Ответ:

1482

1483

(% style="color:#000000" %){

1484

"vehicleId": "" ~/~/ идентификатор объекта

1485

"name": "" ~/~/ наименование объекта

1486

"imei": "" ~/~/ IMEI объекта

1487

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1488

"deviceTypeName": "" ~/~/ наименование типа устройства

1489

"sim1": "" ~/~/ первый номер телефона

1490

"sim2": "" ~/~/ второй номер телефона

1491

"parentId": "" ~/~/ идентификатор клиента-родителя

1492

"parentName": "" ~/~/ наименование клиента-родителя

1493

"modelId": "" ~/~/ идентификатор модели объекта

1494

"modelName": "" ~/~/ наименование модели объекта

1495

"unitId": "" ~/~/ идентификатор подразделения

1496

"unitName": "" ~/~/ наименование подразделения

1497

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1498

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1499

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1500

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1501

"customFields": [

1502

{

1503

"id": "", ~/~/ идентификатор произвольного поля

1504

"name": "", ~/~/ имя произвольного поля

1505

"value": "", ~/~/ значение произвольного поля

1506

"forClient": true, ~/~/ право на отображение у клиента

1507

"forTooltip": false, ~/~/ право на отображение в подсказке

1508

"forReport": false ~/~/ право на отображение в отчетах

1509

}(%%)

1510

(% style="color:#000000" %)}

1511

1512

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1513

1514

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1515

1516

(% class="box successmessage" %)

1517

(((

1518

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1519

)))

1520

1521

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1522

1523

(% style="color:#000000" %)Метод запроса: **POST**

1524

1525

(% 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}

1526

1527

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1528

1529

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1530

1531

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1532

1533

(% style="color:#000000" %){

1534

1535

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1536

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1537

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1538

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1539

"description": "", ~/~/ Описание

1540

"data": "", ~/~/ Данные

1541

"overwrite": false, ~/~/ Флаг перезаписи

1542

"stage": "", ~/~/ Состояние, может быть null

1543

(% style="color:#000000" %)}

1544

1545

(% style="color:#000000" %)Ответ:

1546

1547

(% style="color:#000000" %){(%%)

1548

"status": "", ~/~/ значение статуса

1549

"date": "", ~/~/ Дата смены статуса

1550

"description": "", ~/~/ Описание

1551

"data": "", ~/~/ Данные

1552

"overwrite": false, ~/~/ Флаг перезаписи

1553

"stage": "", ~/~/ Состояние

1554

(% style="color:#000000" %) }

== ==

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1559

1560

(% class="box warningmessage" %)

1561

(((

1562

(% lang="en-US" %)**PUT /api/v3/vehicles**

1563

)))

1564

1565

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1566

1567

(% style="color:#000000" %)Метод запроса: **PUT**

1568

1569

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1570

1571

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1572

1573

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1574

1575

(% style="color:#000000" %){

1576

"vehicleId": , ~/~/ ID объекта

1577

"parentId": "" , ~/~/ ID клиента

1578

"name": "" , ~/~/ имя ТС

1579

"imei": "" , ~/~/ IMEI

1580

"deviceTypeId": "" , ~/~/ ID типа устройства

1581

"modelId": "" , ~/~/ ID модели

1582

"unitId": "" , ~/~/ ID подразделения

1583

"sim1": "" , ~/~/ Номер SIM 1

1584

"sim2": "" , ~/~/ Номер SIM2

1585

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1586

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1587

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1588

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1589

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1590

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1591

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1592

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1593

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1594

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1595

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1596

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1597

1598

"mileageCalcMethod": 0,

1599

"mileageCoeff": 0,

1600

"locationByCellId": true,

1601

"dottedLineTrackWhenNoCoords": true,

1602

"counters": ~/~/ счетчики

1603

{

1604

"mileage": "" , ~/~/ пробег

1605

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1606

"motohours": "" , ~/~/ моточасы

1607

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1608

},

1609

"cmsv6Parameters": { ~/~/ параметры CMSv6

1610

"enabled": true, ~/~/ флаг включения

1611

"id": "" , ~/~/ идентификатор

1612

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1613

"login": "" , ~/~/ имя учетной записи

1614

"password": "" ~/~/ пароль учетной записи

1615

},

1616

"inspectionTasks": ~/~/ задания на ТО

1617

{

1618

"enabled": "" , ~/~/ Признак включения

1619

"name": "" , ~/~/ Имя задания

1620

"description": "" , ~/~/ Описание задания

1621

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1622

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1623

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1624

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1625

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1626

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1627

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1628

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1629

}

1630

1631

"drivers": [ ~/~/ Водители

1632

{

1633

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1638

{

1639

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1646

{

1647

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1648

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1649

"type": 0, ~/~/ Тип датчика

1650

"name": "string", ~/~/ Имя датчика

1651

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1652

"inputNumber": 0, ~/~/ Номер входа

1653

"pseudonym": "string", ~/~/ Псевдоним

1654

"medianDegree": 0, ~/~/ Медианная фильтрация

1655

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1656

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1657

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1658

"gradesTables": [ ~/~/ Массив таблиц тарировки

1659

{

1660

"grades": [ ~/~/ Таблица тарировки 1

1661

{

1662

"input": 0, ~/~/ Входящее значение

1663

"output": 0 ~/~/ Выходящее значение

1664

}

1665

],

1666

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1667

}

1668

],

1669

"showInTooltip": true, ~/~/ Отображать в подсказке

1670

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1671

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1672

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1673

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1674

"expr": "string", ~/~/ Формула

1675

"children": [ ~/~/ массив дочерних датчиков

1676

"string"

1677

],

1678

"customParams": { ~/~/ прочие произвольные параметры

1679

"additionalProp1": "string",

1680

"additionalProp2": "string",

1681

"additionalProp3": "string"

1682

},

1683

~/~/ Характерные для произвольного:

1684

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1685

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1686

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1687

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1688

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1689

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1690

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1691

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1692

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1693

~/~/ "ValueOn": "Вкл.",

1694

~/~/ "ValueOff": "Выкл."

1695

"summaryMaxValue": 0 ~/~/ Макс. значение

1696

}

1697

],

1698

"customFields": [ ~/~/ Произвольные поля

1699

{

1700

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1711

1712

(% lang="en-US" style="text-align:left" %)

1713

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%)

1714

"vehicleId": "", ~/~/ ID ТС

1715

"parentId": "", ~/~/ ID клиента

1716

"name": "", ~/~/ имя ТС

1717

"imei": "", ~/~/ IMEI

1718

"deviceTypeId": "", ~/~/ типа устройства

1719

"modelId": "", ~/~/ ID модели

1720

"unitId": "", ~/~/ ID подразделения

1721

"sim1": "", ~/~/ SIM 1

1722

"sim2": "", ~/~/ SIM2

1723

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1724

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1725

"counters":

1726

{

1727

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1728

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1729

"mileage": "", ~/~/ пробег

1730

"motohours": "", ~/~/ моточасы

1731

}

1732

"cmsv6Parameters": ~/~/ параметры CMSv6

1733

{

1734

"id": ~/~/ идентификатор

1735

"enabled": true, ~/~/ флаг включения

1736

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1737

"login": "", ~/~/ имя учетной записи

1738

"password": "", ~/~/ пароль учетной записи

1739

}

1740

"inspectionTasks": ~/~/ задания на ТО

1741

{

1742

"id": "", ~/~/ ID задания

1743

"enabled": false, ~/~/ Признак включения

1744

"name": "", ~/~/ Имя задания

1745

"description": "", ~/~/ Описание задания

1746

"mileageCondition": "", ~/~/ Условие по пробегу

1747

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1748

"motohoursCondition": "", ~/~/ Условие по моточасам

1749

"lastMotohours": "", ~/~/ Моточасы

1750

"periodicCondition": "", ~/~/ Условие периодичности по времени

1751

"kind": "", ~/~/ Вид периодичности по времени

1752

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1753

}

1754

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1755

1756

**Валидация:**

1757

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1758

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1759

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1760

1761

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1762

1763

(% class="box errormessage" %)

1764

(((

1765

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1766

)))

1767

1768

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1769

1770

(% style="color:#000000" %)Метод запроса: **DELETE**

1771

1772

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1773

1774

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1775

1776

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1777

1778

(% style="text-align:left" %)

1779

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1780

1781

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1782

1783

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1784

1785

(% class="box infomessage" %)

1786

(((

1787

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1788

)))

1789

1790

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1791

1792

(% style="color:#000000" %)Метод запроса: **GET**

1793

1794

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

1795

1796

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1797

1798

(% style="color:#000000" %)Ответ:

1799

1800

(% style="color:#000000" %){(%%)

1801

"deviceTypeId" : "", ~/~/ ID типа устройства

1802

"deviceTypeName" : "" ~/~/ Название типа устройства

1803

(% style="color:#000000" %)}

1804

1805

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1806

1807

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1808

1809

(% class="box infomessage" %)

1810

(((

1811

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1812

)))

1813

1814

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1815

1816

(% style="color:#000000" %)Метод запроса: **GET**

1817

1818

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1819

1820

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1821

1822

(% style="color:#000000" %)Ответ:

1823

1824

(% style="color:#000000" %){(%%)

1825

"id": "", ~/~/ ID типа датчика

1826

"name": "", ~/~/ Название

1827

"description": "", ~/~/ Описание

1828

(% style="color:#000000" %)}

1829

1830

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1831

1832

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1833

1834

(% class="box infomessage" style="text-align: left;" %)

1835

(((

1836

**POST /api/v3/terminalMessages/count**

1837

)))

1838

1839

(% style="text-align: left;" %)

1840

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1841

1842

(% style="text-align: left;" %)

1843

Метод запроса **POST**

1844

1845

(% style="text-align: left;" %)

1846

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1847

1848

(% style="text-align: left;" %)

1849

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1850

1851

(% style="text-align: left;" %)

1852

{

1853

"vehicleIds": [

1854

id ~/~/ здесь передается список идентификаторов объектов

1855

],

1856

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1857

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1858

}

1859

1860

(% style="text-align: left;" %)

1861

Ответ:

1862

1863

(% style="text-align: left;" %)

1864

[

1865

{

1866

"vehicleId": 0, ~/~/ идентификатор объекта

1867

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1872

1873

(% class="box infomessage" style="text-align: left;" %)

1874

(((

1875

**POST /api/v3/terminalMessages/mapping**

1876

)))

1877

1878

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

1879

1880

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

1881

1882

(% 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);" %)**Описание**

1890

|protocolType|ID типа протокола

1891

|params|(((

1892

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

1912

|protocolType|Тип протокола

1913

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

1919

Перечень 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/]]

1920

1921

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

1922

1923

(% class="box infomessage" %)

1924

(((

1925

**POST /api/v3/terminalMessages**

1926

)))

1927

1928

Метод возвращает список сообщений терминала объекта за выбранный период.

1929

1930

(% style="text-align: left;" %)

1931

Метод запроса **POST**

1932

1933

(% style="text-align: left;" %)

1934

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

1935

1936

(% style="text-align: left;" %)

1937

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1938

1939

{

1940

"vehicleId": 0, ~/~/ id объекта

1941

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

1942

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

1943

}

1944

1945

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1946

|vehicleId|ID объекта

1947

|from|Дата и время начала периода запроса

1948

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

1957

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

1967

"additionalProp2": "string",

1968

"additionalProp3": "string"

1969

},

1970

"photoCount": 0,

1971

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1979

|deviceTime|Время сообщения терминала

1980

|serverTime|Время когда сообщение поступило на сервер

1981

|speed|Скорость

1982

|altitude|Высота над уровнем моря

1983

|latitude|Широта

1984

|longitude|Долгота

1985

|satellites|Кол-во спутников

1986

|course|Курс

1987

|voltage|Бортовое напряжение

1988

|parameters|Список параметров и их значений

1989

|photoCount|Количество фото

1990

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

1991

|protocolType|ID типа протокола

1992

1993

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

1994

1995

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

1996

1997

(% class="box infomessage" %)

1998

(((

1999

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2000

)))

2001

2002

(% style="color:#000000" %)Метод запроса: **POST**

2003

2004

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2005

2006

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2007

2008

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2013

"vehicleIds": [0], ~/~/ Список ID объектов

2014

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2015

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2016

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2024

"name": "string", ~/~/ Имя ТС

2025

"periods": [ ~/~/ Периоды

2026

{

2027

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2028

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2029

"mileage": 0, ~/~/ Пробег за период, километры

2030

"mileageBegin": 0, ~/~/ Пробег на начало периода, километры

2031

"mileageEnd": 0, ~/~/ Пробег на окончание периода, километры

2032

"motohours": 0, ~/~/ Моточасы за период, секунды

2033

"motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды

2034

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2041

2042

(% class="box infomessage" %)

2043

(((

2044

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2045

)))

2046

2047

(% style="color:#000000" %)Метод запроса: **POST**

2048

2049

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2050

2051

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2052

2053

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2058

"vehicleIds": [0], ~/~/ Список ID объектов

2059

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2060

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2061

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2069

"name": "string", ~/~/ Имя ТС

2070

"periods": [ ~/~/ Периоды

2071

{

2072

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2073

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2074

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2075

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2076

"fuelConsumption": 0, ~/~/ Расход топлива

2077

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2084

2085

(% class="box infomessage" %)

2086

(((

2087

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2088

)))

2089

2090

(% style="color:#000000" %)Метод запроса: **POST**

2091

2092

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2093

2094

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2095

2096

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2101

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2102

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2103

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2111

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2112

"vehicleId": 0, ~/~/ ID объекта

2113

"name": "string", ~/~/ Имя объекта

2114

"model": "string", ~/~/ Модель объекта

2115

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2116

{

2117

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2118

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2119

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2120

"valueFuel": 0, ~/~/ Количество

2121

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2122

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2130

2131

(% class="box infomessage" %)

2132

(((

2133

**POST /api/v3/vehicles/moveStop**

2134

)))

2135

2136

Метод запроса: **POST**

2137

2138

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2139

2140

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2147

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2148

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2149

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2157

"vehicleName": "string", ~/~/ Имя объекта

2158

"moves": [ ~/~/ Событие движения

2159

{

2160

"mileage": 0, ~/~/ Пробег, км

2161

"eventId": 0, ~/~/ Идентификатор события

2162

"eventName": "string", ~/~/ Название события

2163

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2164

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2165

"duration": 0 ~/~/ Продолжительность события, секунд

2166

}

2167

],

2168

"stops": [ ~/~/ События стоянок

2169

{

2170

"address": "string", ~/~/ Адрес события

2171

"eventId": 0, ~/~/ Идентификатор события

2172

"eventName": "string", ~/~/ Название события

2173

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2174

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2175

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2183

2184

(% class="box infomessage" %)

2185

(((

2186

**POST /api/v3/vehicles/getlastdata**

2187

)))

2188

2189

Метод запроса: **POST**

2190

2191

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2192

2193

В заголовках запроса: X-Auth: Токен авторизации

2194

2195

2196

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2201

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2202

"vehicleNumber": "string",~/~/Номер объекта.

2203

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2204

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2205

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2206

"speed": 0,~/~/Скорость объекта.

2207

"course": 0,~/~/Курс движения [0;360]

2208

"latitude": 0,~/~/Широта [-90°;90°].

2209

"longitude": 0,~/~/Долгота [-180°;180°].

2210

"address": "string",~/~/Адрес.

2211

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2219

2220

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2221

2222

(% class="box infomessage" %)

2223

(((

2224

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2225

)))

2226

2227

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2228

2229

(% style="color:#000000" %)Метод запроса: **POST**

2230

2231

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2232

2233

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2234

2235

(% style="text-align:left" %)

2236

Тело запроса:

2237

2238

(% style="text-align:left" %)

2239

{

2240

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2241

}

2242

2243

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2249

"name": "string", ~/~/ Название объекта геозоны

2250

"type": 0, ~/~/ Тип объекта геозоны

2251

"fname": "string", ~/~/ Имя файла

2252

"parentId": "string", ~/~/ Идентификатор клиента

2253

"radius": 0, ~/~/ Радиус геообъекта

2254

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2255

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2256

"description": "string", ~/~/ Описание

2257

"area": 0, ~/~/ Площадь, м^^2^^

2258

"perimetr": 0, ~/~/ Периметр, м

2259

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2264

2265

(% class="box infomessage" %)

2266

(((

2267

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2268

)))

2269

2270

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2271

2272

(% style="color:#000000" %)Метод запроса: **POST**

2273

2274

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2275

2276

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2277

2278

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2283

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2284

"ids": [ ], ~/~/ Массив id объектов

2285

"byTime": 0, ~/~/ Объединение событий по времени

2286

"byDist": 0, ~/~/ Объединение событий по расстоянию

2287

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2288

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2295

"geozoneName": "string", ~/~/ Название геообъекта

2296

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2297

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2298

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2299

"vehicleId": 0, ~/~/ ID объекта

2300

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2305

2306

(% class="box infomessage" %)

2307

(((

2308

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2309

)))

2310

2311

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2312

2313

(% style="color:#000000" %)Метод запроса: **POST**

2314

2315

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2316

2317

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2318

2319

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2324

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2325

"ids": [ ], ~/~/ Массив id геообъектов

2326

"byTime": 0, ~/~/ Объединение событий по времени

2327

"byDist": 0, ~/~/ Объединение событий по расстоянию

2328

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2329

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2337

"geozoneName": "string", ~/~/ Название геообъекта

2338

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2339

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2340

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2341

"vehicleId": 0, ~/~/ ID объекта

2342

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2347

2348

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2349

2350

(% class="box infomessage" %)

2351

(((

2352

**POST /api/v3/notifications/find**

2353

)))

2354

2355

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2356

2357

(% style="text-align: left;" %)

2358

Метод запроса **POST**

2359

2360

(% style="text-align: left;" %)

2361

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2362

2363

(% style="text-align: left;" %)

2364

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2365

2366

{

2367

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2375

"name": "string", ~/~/ Название уведомления

2376

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2377

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2378

"userId": "", ~/~/ Пользователь, создавший уведомление

2379

"parentId": "", ~/~/ Идентификатор клиента

2380

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2385

2386

(% class="box infomessage" %)

2387

(((

2388

**GET /api/v3/notifications/{id}**

2389

)))

2390

2391

Метод возвращает данные правил формирования выбранного уведомления.

2392

2393

(% style="text-align: left;" %)

2394

Метод запроса **GET**

2395

2396

(% style="text-align: left;" %)

2397

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2398

2399

(% style="text-align: left;" %)

2400

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2401

2402

(% style="text-align: left;" %)

2403

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2404

2405

(% style="text-align: left;" %)

2406

(% style="color:#000000" %)Ответ:

2407

2408

(% style="text-align: left;" %)

2409

(% style="color:#000000" %){

2410

"id": 0, ~/~/ (%%)id уведомления

2411

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2412

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2413

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2414

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2415

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2416

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2417

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2418

(% style="color:#000000" %) 0

2419

],

2420

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2421

(% style="color:#000000" %) 0

2422

],

2423

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2424

(% style="color:#000000" %) 0

2425

],

2426

"settings": { ~/~/ Список параметров уведомления

2427

"additionalProp1": "string",

2428

"additionalProp2": "string",

2429

"additionalProp3": "string"

2430

},

2431

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2432

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2433

(% style="color:#000000" %) ""

2434

],

2435

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2436

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2437

(% style="color:#000000" %) "string"

2438

],

2439

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2440

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2441

(% style="color:#000000" %) {

2442

"id": 0, ~/~/ (%%)Идентификатор участника чата

2443

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2444

(% style="color:#000000" %) }

2445

],

2446

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2447

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2448

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2449

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2450

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2451

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2452

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2453

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2454

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2455

(% style="color:#000000" %)}

2456

2457

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2458

2459

(% class="box warningmessage" %)

2460

(((

2461

**PUT /api/v3/notifications/**

2462

)))

2463

2464

Метод позволяет отредактировать уведомление.

2465

2466

Метод запроса **PUT**

2467

2468

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2469

2470

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2475

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2476

"userId": "", ~/~/ Пользователь, создавший уведомление

2477

"parentId": "", ~/~/ Идентификатор клиента

2478

"parentName": "string", ~/~/ Имя клиента

2479

"name": "string", ~/~/ Название уведомления

2480

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2481

"vehicleIds": [ ~/~/ Список id объектов для анализа

2482

0

2483

],

2484

"geoids": [ ~/~/ Список id геообъектов для анализа

2485

0

2486

],

2487

"fieldids": [ ~/~/ Список id полей для анализа

2488

0

2489

],

2490

"settings": { ~/~/ Список параметров уведомления

2491

"additionalProp1": "string",

2492

"additionalProp2": "string",

2493

"additionalProp3": "string"

2494

},

2495

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2496

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2497

""

2498

],

2499

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2500

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2501

"string"

2502

],

2503

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2504

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2505

{

2506

"id": 0, ~/~/ Идентификатор участника чата

2507

"info": "string" ~/~/ Дополнительные сведения

2508

}

2509

],

2510

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2511

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2512

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2513

"kind": 0, ~/~/ Определяет вид уведомления

2514

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2515

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2516

"timezone": 0, ~/~/ Сдвиг часового пояса

2517

"validity": 0, ~/~/ Срок действия в днях (1-90)

2518

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==

2527

2528

(% class="box warningmessage" %)

2529

(((

2530

**PUT** /api/v3/notifications/prolongation

2531

)))

2532

2533

Метод позволяет продлить уведомления.

2534

2535

Метод запроса **PUT**

2536

2537

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation

2538

2539

В заголовках запроса: X-Auth: Токен авторизации.

Тело запроса:

[

0

]

где 0 идентификатор ids.

2550

2551

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2552

2553

(% class="box errormessage" %)

2554

(((

2555

**DELETE /api/v3/notifications/{id}**

2556

)))

2557

2558

Метод позволяет удалить выбранное уведомление.

2559

2560

Метод запроса **DELETE**

2561

2562

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2563

2564

Передаваемый параметр: {id} - id уведомления

2565

2566

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2574

2575

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2576

2577

(% class="box infomessage" %)

2578

(((

2579

**POST /api/v3/Drivers/find**

2580

)))

2581

2582

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2589

"description": "string", ~/~/ Определяет описание

2590

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2591

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2592

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2593

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2594

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2595

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2600

2601

(% class="box infomessage" %)

2602

(((

2603

**GET /api/v3/Drivers/{driverGuid}**

2604

)))

2605

2606

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2612

"description": "string", ~/~/ Определяет описание

2613

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2614

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2615

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2616

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2617

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2618

"deleted": true ~/~/ Признак удаления

2619

}

2620

2621

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2622

2623

(% class="box successmessage" %)

2624

(((

2625

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2633

"hiredate": "2023-06-30T12:50:54.020Z",

2634

"chopdate": "2023-06-30T12:50:54.020Z",

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:54.051Z",

2647

"chopdate": "2023-06-30T12:50:54.051Z",

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 warningmessage" %)

2658

(((

2659

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2667

"hiredate": "2023-06-30T12:50:27.910Z",

2668

"chopdate": "2023-06-30T12:50:27.910Z",

2669

"exclusive": true,

2670

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2671

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2680

"hiredate": "2023-06-30T12:50:27.929Z",

2681

"chopdate": "2023-06-30T12:50:27.929Z",

2682

"exclusive": true,

2683

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2684

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2690

2691

(% class="box errormessage" %)

2692

(((

2693

**DELETE /api/v3/Drivers/{driverGuid}**

2694

)))

2695

2696

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2704

2705

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2706

2707

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2708

2709

(% class="box infomessage" %)

2710

(((

2711

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2719

],

2720

"BeginTime": "2023-06-30T12:49:04.365Z",

2721

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2730

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2731

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2732

"BeginTime": "2023-06-30T09:52:31.240Z",

2733

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2739

2740

(% class="box infomessage" %)

2741

(((

2742

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2752

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2761

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2762

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2763

"BeginTime": "2023-06-30T09:54:01.631Z",

2764

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2770

2771

(% class="box successmessage" %)

2772

(((

2773

**POST /api/v3/DriversVehiclesAssignments**

2774

)))

2775

2776

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2783

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2784

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2785

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2786

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2796

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2797

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2798

"BeginTime": "2023-06-30T11:04:46.903Z",

2799

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2805

2806

(% class="box warningmessage" %)

2807

(((

2808

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2817

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2818

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2819

"BeginTime": "2023-06-30T11:14:08.117Z",

2820

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2830

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2831

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2832

"BeginTime": "2023-06-30T11:14:53.349Z",

2833

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2839

2840

(% class="box errormessage" %)

2841

(((

2842

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2857

2858

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2859

2860

(% class="box infomessage" %)

2861

(((

2862

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2870

],

2871

"BeginTime": "2023-06-30T12:47:12.162Z",

2872

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2880

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2881

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2882

"BeginTime": "2023-06-30T11:19:40.703Z",

2883

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2889

2890

(% class="box infomessage" %)

2891

(((

2892

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2900

],

2901

"BeginTime": "2023-06-30T12:47:12.162Z",

2902

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2910

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2911

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2912

"BeginTime": "2023-06-30T11:19:40.703Z",

2913

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2919

2920

(% class="box successmessage" %)

2921

(((

2922

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2930

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2931

"BeginTime": "2023-06-30T11:27:08.635Z",

2932

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2941

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2942

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2943

"BeginTime": "2023-06-30T11:27:08.677Z",

2944

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

2950

2951

(% class="box warningmessage" %)

2952

(((

2953

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2961

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2962

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2963

"BeginTime": "2023-06-30T11:28:43.330Z",

2964

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2973

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2974

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2975

"BeginTime": "2023-06-30T11:28:43.331Z",

2976

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

2982

2983

(% class="box errormessage" %)

2984

(((

2985

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3000

3001

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3002

3003

(% class="box infomessage" %)

3004

(((

3005

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3013

],

3014

"BeginTime": "2023-06-30T12:45:10.852Z",

3015

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3023

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3024

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3025

"BeginTime": "2023-06-30T11:58:04.695Z",

3026

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3032

3033

(% class="box infomessage" %)

3034

(((

3035

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3043

],

3044

"BeginTime": "2023-06-30T12:45:10.852Z",

3045

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3053

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3054

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3055

"BeginTime": "2023-06-30T11:58:04.695Z",

3056

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3062

3063

(% class="box successmessage" %)

3064

(((

3065

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3073

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3074

"BeginTime": "2023-06-30T12:09:53.175Z",

3075

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3084

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3085

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3086

"BeginTime": "2023-06-30T12:09:53.201Z",

3087

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3093

3094

(% class="box warningmessage" %)

3095

(((

3096

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3104

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3105

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3106

"BeginTime": "2023-06-30T12:09:53.201Z",

3107

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3116

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3117

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3118

"BeginTime": "2023-06-30T12:09:53.201Z",

3119

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3125

3126

(% class="box errormessage" %)

3127

(((

3128

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3143

3144

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3145

3146

(% class="box infomessage" %)

3147

(((

3148

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3155

"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);" %)**Описание**

3161

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3162

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3163

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3164

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3171

"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",

3181

"name": "string",

3182

"rid": "string",

3183

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3184

"trailer": {

3185

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3186

"Number": "string",

3187

"Description": "string",

3188

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3189

"ExternalID": "string",

3190

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3191

"CreateTime": "2023-11-14T10:48:03.717Z",

3192

"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);" %)**Описание**

3200

|SD|Дата и время начала события

3201

|ED|Дата и время окончания события

3202

|id|ID объекта

3203

|SLat|Широта начальной координаты

3204

|SLon|Долгота начальной координаты

3205

|ELat|Широта конечной координаты

3206

|ELon|Долгота конечной координаты

3207

|mileage|Пробег

3208

|Duration|Продолжительность

3209

|Address|Адрес начального местоположения

3210

|Address2|Адрес конечного местоположения

3211

|name|Имя радиометки

3212

|rid|Номер радиометки

3213

|rguid|ID радиометки

3214

|trailer|Информация об агрегате

3215

|ModelGuid|ID агрегата

3216

|Number|Название/номер агрегата

3217

|Description|Текст примечания агрегата

3218

3219

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3220

3221

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3222

3223

(% class="box infomessage" %)

3224

(((

3225

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3242

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3247

|parentId|ID клиента

3248

|name|Название карты-метки

3249

|number|Номер

3250

|period|Период запросов в секундах (работает только для агрегатов)

3251

|id|ID карты-метки

3252

3253

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3254

3255

(% class="box infomessage" %)

3256

(((

3257

**GET /api/v3/Rfids/{rfidGuid}**

3258

)))

3259

3260

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3270

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3275

|name|Название карты-метки

3276

|number|Номер

3277

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3282

3283

(% class="box successmessage" %)

3284

(((

3285

**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",

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 warningmessage" %)

3317

(((

3318

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3328

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3338

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3339

}

3340

3341

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3342

|name|Название карты-метки

3343

|number|Номер

3344

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3349

3350

(% class="box errormessage" %)

3351

(((

3352

**DELETE /api/v3/Rfids/{rfidGuid}**

3353

)))

3354

3355

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3363

3364

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3365

3366

(% class="box infomessage" %)

3367

(((

3368

**GET /api/v3/Billing/client/balance/{clientId}**

3369

)))

3370

3371

Параметр запроса: **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);" %)**Описание**

3381

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3382

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3383

3384

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3385

3386

(% class="box infomessage" %)

3387

(((

3388

**GET /api/v3/Billing/client/constraint/{clientId}**

3389

)))

3390

3391

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3397

"CalculationType": 0,

3398

"PermissibleBalance": 0,

3399

"DefermentDays": 0,

3400

"SendUiNotifications": true,

3401

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3406

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3407

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3408

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3409

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3410

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3411

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3412

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3413

3414

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3415

3416

(% class="box infomessage" %)

3417

(((

3418

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3424

3425

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3431

"Plan": { **~/~/ Описание тарифного плана**

3432

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3433

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3438

"PermissibleBalance": 0,

3439

"DefermentDays": 0

3440

},

3441

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3453

"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);" %)**Описание**

3469

|ClientId|Идентификатор клиента

3470

|Id|Идентификатор тарифного плана

3471

|OwnerId|Идентификатор клиента-владельца

3472

|Name|Наименование тарифного плана

3473

|IsArchived|Признак, определяющий архивный тарифный план

3474

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3475

|PermissibleBalance|Допустимый баланс

3476

|DefermentDays|Отсрочка, количество дней

3477

|Feature|Код услуги

3478

|IsEnabled|Признак, определяющий активирована ли услуга

3479

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3480

|IsFactual|Признак, определяющий расчёт по факту

3481

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3482

|Price|Цена за единицу.

3483

|DebitDate|Следующий момент времени списания с баланса за услугу.

3484

|PeriodValue|Значение периода.

3485

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3486

3487

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3488

3489

(% class="box infomessage" %)

3490

(((

3491

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3492

)))

3493

3494

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3501

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3506

"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);" %)**Описание**

3523

|ClientId|Идентификатор клиента

3524

|Id|Идентификатор тарифного плана

3525

|OwnerId|Идентификатор клиента-владельца

3526

|Name|Наименование тарифного плана

3527

|IsArchived|Признак, определяющий архивный тарифный план

3528

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3529

|PermissibleBalance|Допустимый баланс

3530

|DefermentDays|Отсрочка, количество дней

3531

|Feature|Код услуги

3532

|IsFactual|Признак, определяющий расчёт по факту

3533

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3534

|Price|Цена за единицу.

3535

|PeriodValue|Значение периода.

3536

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3537

3538

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3539

3540

(% class="box infomessage" %)

3541

(((

3542

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3543

)))

3544

3545

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3552

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3557

"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);" %)**Описание**

3574

|ClientId|Идентификатор клиента

3575

|Id|Идентификатор тарифного плана

3576

|OwnerId|Идентификатор клиента-владельца

3577

|Name|Наименование тарифного плана

3578

|IsArchived|Признак, определяющий архивный тарифный план

3579

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3580

|PermissibleBalance|Допустимый баланс

3581

|DefermentDays|Отсрочка, количество дней

3582

|Feature|Код услуги

3583

|IsFactual|Признак, определяющий расчёт по факту

3584

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3585

|Price|Цена за единицу.

3586

|PeriodValue|Значение периода.

3587

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3588

3589

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3590

3591

(% class="box warningmessage" %)

3592

(((

3593

**PUT /api/v3/Billing/client/balance**

3594

)))

3595

3596

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3608

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3609

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3610

3611

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3612

3613

(% class="box warningmessage" %)

3614

(((

3615

**PUT /api/v3/billing/client/balance/deposit**

3616

)))

3617

3618

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3630

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3631

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3632

3633

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3634

3635

Создает операцию **Списание **с указанной суммой

3636

3637

(% class="box warningmessage" %)

3638

(((

3639

**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);" %)**Описание**

3652

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3653

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3654

3655

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3656

3657

(% class="box warningmessage" %)

3658

(((

3659

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3666

"CalculationType": 0,

3667

"PermissibleBalance": 0,

3668

"DefermentDays": 0,

3669

"SendUiNotifications": true,

3670

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3677

|ClientId|Идентификатор клиента

3678

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3679

|PermissibleBalance|Допустимый баланс

3680

|DefermentDays|(((

3681

Отсрочка, количество дней

3682

)))

3683

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3684

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3685

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3686

3687

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3688

3689

(% class="box warningmessage" %)

3690

(((

3691

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3698

"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);" %)**Описание**

3716

|ClientId|Идентификатор клиента

3717

|PlanId|Идентификатор тарифного плана

3718

|Feature|Код услуги

3719

|IsEnabled|Признак, определяющий активирована ли услуга

3720

|IsFactual|Признак, определяющий расчёт по факту

3721

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3722

|Price|Цена за единицу.

3723

|DebitDate|Следующий момент времени списания с баланса за услугу.

3724

|PeriodValue|Значение периода.

3725

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3726

3727

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3728

3729

(% class="box warningmessage" %)

3730

(((

3731

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3732

)))

3733

3734

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3735

3736

(% class="box infomessage" %)

3737

(((

3738

**POST /api/v3/vehicles/import/{agentId}**

3739

)))

3740

3741

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

3742

3743

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3752

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3753

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

3754

3755

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3760

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3761

|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);" %)**Описание**

3772

|vehicleId|ID созданного объекта

3773

|name|Имя созданного объекта

3774

|errors|Ошибки и их описание

3775

3776

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3777

3778

(% class="box infomessage" %)

3779

(((

3780

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3781

)))

3782

3783

(% class="wikigeneratedid" %)

3784

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3785

3786

(% class="wikigeneratedid" %)

3787

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3792

3793

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3798

|**history**|В значении передавать файл с историей

3799

3800

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3813

"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);" %)**Описание**

3821

|results|Результаты импорта в разрезе ТС

3822

|vehicleGuid|Guid ТС

3823

|vehicleId|ID ТС

3824

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3825

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3826

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3827

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3828

|msgCount|Кол-во обработанных сообщений всего

3829

3830

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3831

3832

(% class="box infomessage" %)

3833

(((

3834

**GET /api/v3/vehicles/import/history/status**

3835

)))

3836

3837

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3848

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3849

|progress|Guid ТС

3850

3851

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3852

3853

(% class="box infomessage" %)

3854

(((

3855

**POST /api/v3/vehicles/export**

3856

)))

3857

3858

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3867

3868

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3869

3870

(% class="box infomessage" %)

3871

(((

3872

**POST /api/v3/vehicles/export/history**

3873

)))

3874

3875

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3883

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3889

3890

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3891

|vehicleId|ID объекта

3892

|asArchive|true - Архивировать файл, False - не архивировать

3893

|from|Дата и время начала запроса

3894

|to|Дата и время окончания запроса

3895

3896

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3897

3898

(% class="box infomessage" %)

3899

(((

3900

**GET /api/v3/vehicles/export/history/status**

3901

)))

3902

3903

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3914

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3915

|progress|Прогресс экспорта, от 0 до 100%

3916

|message|Текст описывающий статус

3917

3918

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3919

3920

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

3921

3922

(% class="box infomessage" %)

3923

(((

3924

**POST /api/v3/EcoDriving/rating**

3925

)))

3926

3927

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3933

"from": "2023-11-22T09:29:48.051Z",

3934

"to": "2023-11-22T09:29:48.051Z"

3935

}

3936

3937

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3938

|vehicleIds|Массив ID объектов

3939

|from|Дата начала запроса

3940

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

3948

"to": "2023-11-22T09:29:48.052Z",

3949

"vehicleId": 0,

3950

"vehicleName": "string",

3951

"vehicleModel": "string",

3952

"penalty": 0,

3953

"score": 0,

3954

"totalViolations": 0,

3955

"violationsByType": {

3956

"overspeedingViolations": 0,

3957

"accelerationViolations": 0,

3958

"brakingViolations": 0,

3959

"turningViolations": 0,

3960

"dangerousDrivingViolations": 0,

3961

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

3971

"violationsByType": {

3972

"overspeedingViolations": 0,

3973

"accelerationViolations": 0,

3974

"brakingViolations": 0,

3975

"turningViolations": 0,

3976

"dangerousDrivingViolations": 0,

3977

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

3984

"endAddress": "string",

3985

"drivers": [

3986

{

3987

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3988

"driverName": "string",

3989

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3999

|from|Дата начала запроса

4000

|to|Дата окончания

4001

|vehicleId|ID объекта

4002

|vehicleName|Имя объекта

4003

|vehicleModel|Модель объекта

4004

|penalty|Сумма штрафных баллов

4005

|score|Оценка

4006

|totalViolations|Суммарное количество нарушений

4007

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4008

|overspeedingViolations|Превышение скорости

4009

|accelerationViolations|Ускорение

4010

|brakingViolations|Торможение

4011

|turningViolations|Резкий поворот

4012

|dangerousDrivingViolations|Резкое вождение

4013

|sensorViolations|Нарушение по датчику

4014

|moveTime|Время в движении

4015

|mileage|Пробег (км)

4016

|tripsCount|Количество рейсов

4017

|motohours|Моточасы

4018

|maxSpeed|Максимальная скорость

4019

|startAddress|Адрес начала рейса

4020

|endAddress|Адрес окончания рейса

4021

|drivers|Список водителей, которые были на объекте в течениии рейса

4022

|driverGuid|Guid водителя

4023

|driverName|Имя водителя

4024

|driverRfid|Номер Карты-метки

4025

4026

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4027

4028

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4029

4030

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4031

4032

(% class="box infomessage" %)

4033

(((

4034

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4040

\\В заголовках запроса: X-Auth: Токен авторизации

4041

4042

Параметры в теле запроса (JSON):

4043

4044

{

4045

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4046

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4047

"ids": [

4048

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4049

],

4050

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4057

"driver": "string", ~/~/Водители, привязанные к ТК

4058

"object": "string", ~/~/Наименование ТС

4059

"amount": 0, ~/~/Количество топлива

4060

"amountDut": 0, ~/~/Количество по ДУТ

4061

"amountDiff": 0, ~/~/Разница, л

4062

"amountDiffPerc": 0, ~/~/Разница, %

4063

"summa": 0, ~/~/Стоимость, руб

4064

"serviceName": "string", ~/~/Тип топлива

4065

"price": 0, ~/~/Цена за литр, руб

4066

"cardName": "string", ~/~/Наименование ТК

4067

"cardNum": "string", ~/~/Номер ТК

4068

"operator": "string", ~/~/Оператор ТК

4069

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4074

4075

4076

== **Получение полных данных о ретрансляторе** ==

4077

4078

(% class="box infomessage" %)

4079

(((

4080

**GET ** **/api/v3/retranslations/{id}**

4081

)))

4082

4083

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4090

"subscriberId": "", ~/~/ Подписчик

4091

"protocolType": 0, ~/~/ Тип протокола

4092

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4093

"address": "string", ~/~/ Адрес события

4094

"objects": [ ~/~/Объекты для ретрансляции

4095

{

4096

"id": "", ~/~/ Идентификатор объекта ретрансляции

4097

"name": "", ~/~/ Наименование объекта ретрансляции

4098

"imei": "", ~/~/ IMEI объекта

4099

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4100

}

4101

],

4102

"id": "", ~/~/ идентификатор пользователя

4103

"parentId": "", ~/~/Guid родителя

4104

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4109

4110

(% class="box infomessage" %)

4111

(((

4112

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4119

4120

(% class="box infomessage" %)

4121

(((

4122

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4129

"subscriberId": "", ~/~/ Подписчик

4130

"protocolType": 0, ~/~/ Тип протокола

4131

"address": "", ~/~/ Адрес ретрансляции

4132

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4133

"objects": [ ~/~/Объекты для ретрансляции

4134

{

4135

"id": "", ~/~/ идентификатор пользователя

4136

"imei": "", ~/~/IMEI объекта

4137

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4147

"subscriberId": "", ~/~/ идентификатор запроса

4148

"protocolType": 0, ~/~/ Тип протокола

4149

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4150

"address": "", ~/~/ Адрес события

4151

"objects": [ ~/~/Объекты для ретрансляции

4152

{

4153

"id": "", ~/~/ идентификатор пользователя

4154

"name": "string", ~/~/ Название уведомления

4155

"imei": "string", ~/~/IMEI объекта

4156

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4157

}

4158

],

4159

"id": "", ~/~/ идентификатор пользователя

4160

"parentId": "", ~/~/ Guid идентификатор родителя

4161

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4166

4167

(% class="box infomessage" %)

4168

(((

4169

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4176

"description": "string", ~/~/ Определяет описание

4177

"subscriberId": "", ~/~/ идентификатор запроса

4178

"protocolType": 0, ~/~/ Тип протокола

4179

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4180

"address": "string", ~/~/ Адрес события

4181

"objects": ~/~/Объекты для ретрансляции

4182

[

4183

{

4184

"id": "", ~/~/ идентификатор пользователя

4185

"imei": "", ~/~/IMEI объекта

4186

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4196

"subscriberId": "", ~/~/ идентификатор запроса

4197

"protocolType": 0, ~/~/ Тип протокола

4198

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4199

"address": "string", ~/~/ Адрес события

4200

"objects": [ ~/~/Объекты для ретрансляции

4201

{

4202

"id": "", ~/~/ идентификатор пользователя

4203

"name": "string", ~/~/ Название уведомления

4204

"imei": "", ~/~/IMEI объекта

4205

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4206

}

4207

],

4208

"id": "", ~/~/ идентификатор пользователя

4209

"parentId": "", ~/~/ Guid идентификатор родителя

4210

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4215

4216

(% class="box infomessage" %)

4217

(((

4218

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4225

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4226

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4234

"subscriberId": "", ~/~/ идентификатор запроса

4235

"protocolType": 0, ~/~/ Тип протокола

4236

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4237

"address": "string", ~/~/ Адрес события

4238

"id": "", ~/~/ идентификатор пользователя

4239

"parentId": "", ~/~/ Guid идентификатор родителя

4240

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4246

4247

== **API для отчета по выгрузке комбайнов** ==

4248

4249

(% class="box infomessage" %)

4250

(((

4251

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4258

"byDist": 0, ~/~/ Объединение событий по расстоянию

4259

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4260

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4261

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4262

"vehicleIds": [ ~/~/ Список id объектов для анализа

4263

0

4264

],

4265

"from": "", ~/~/ Дата и время начало запроса

4266

"to": "", ~/~/ Дата и время окончания запроса

4267

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4275

"harvesterId": 0, ~/~/Комбайн, id

4276

"harvesterModel": "", ~/~/ Модель комбайна

4277

"hopperCapacity": 0, ~/~/ Объем бункера м3

4278

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4279

"events": [ ~/~/Список событий в разрезе комбайна

4280

{

4281

"driverId": "", ~/~/Идентификатор водителя

4282

"driverName": "", ~/~/Водитель комбайна, ФИО

4283

"RFID": "", ~/~/ идентификатор карты-метки

4284

"rfidName": "", ~/~/Водитель комбайна, имя метки

4285

"vehicleId": 0, ~/~/идентификатор объекта

4286

"vehicleName": "string", ~/~/ Имя объекта

4287

"modelName": "string", ~/~/ Имя модели объекта

4288

"nearestVehicles": [ ~/~/Объекты рядом

4289

{

4290

"vehicleId": 0, ~/~/идентификатор объекта

4291

"vehicleName": "string" ~/~/ Имя объекта

4292

}

4293

],

4294

"fields": [ ~/~/Поля, где происходила выгрузка

4295

{

4296

"id": 0, ~/~/ идентификатор пользователя

4297

"name": "string" ~/~/ имя пользователя

4298

}

4299

],

4300

"event": "string", ~/~/Событие

4301

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4302

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4303

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4304

"cultureName": "string", ~/~/ название культуры

4305

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4306

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4307

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4308

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4309

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4310

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4311

"issued": 0, ~/~/Выдано, бункеров

4312

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4313

"latitude": 0, ~/~/Широта

4314

"longitude": 0, ~/~/ Долгота

4315

"litresAway": 0, ~/~/Отдано, л

4316

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4324

4325

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4326

4327

4328

(% class="box infomessage" %)

4329

(((

4330

GET api/v3/Vehicles/recyclebin/all

4331

)))

4332

4333

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4334

4335

Параметр запроса: {parentId} - идентификатор агента

4336

4337

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4344

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4345

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4346

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4347

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4348

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4349

"details": { ~/~/Список деталей объекта, помещённого в корзину

4350

"items": [ ~/~/

4351

nullable: true ~/~/Детали

4352

{

4353

"name": "string", ~/~/наименование столбца

4354

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4366

4367

(% class="box infomessage" %)

4368

(((

4369

POST/api/v3/Vehicles/recyclebin/erase

4370

)))

4371

4372

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4386

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4387

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4388

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4389

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4390

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4391

"details": { ~/~/Список деталей объекта, помещённого в корзину

4392

"items": [ ~/~/Детали

4393

{

4394

"name": "", ~/~/Имя свойства

4395

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4406

4407

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4408

4409

(% class="box infomessage" %)

4410

(((

4411

POST/api/v3/Vehicles/recyclebin/restore

4412

)))

4413

4414

В заголовках запроса: X-Auth: Токен авторизации

4415

4416

Параметры в теле запроса (JSON):

4417

4418

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4419

4420

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4443

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4444

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4445

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4446

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4447

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4448

"details": { ~/~/Список деталей объекта, помещённого в корзину

4449

"items": [ ~/~/Детали

4450

{

4451

"name": "string", ~/~/Имя свойства

4452

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4465

(((

4466

(% 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]] **

4467

)))

Исходный код вики Методы API для работы с ГЛОНАССSoft