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

1

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

2

(((

3

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

)))

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

10

11

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

12

13

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

14

15

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

16

17

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

18

19

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

20

21

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

22

23

(% class="box successmessage" %)

24

(((

25

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

26

)))

27

28

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

29

30

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

31

32

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

33

34

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

35

36

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

37

38

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

39

"login": "testuser",

40

"password": "testuser"

41

}

42

43

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

44

45

(% lang="en-US" %)

46

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

47

48

(% lang="en-US" %)

49

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

50

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

(% lang="en-US" %)

}

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

56

57

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

58

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

59

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

60

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

61

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

62

63

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

64

65

(% class="box infomessage" %)

66

(((

67

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

68

)))

69

70

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

71

72

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

73

74

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

75

76

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

77

78

(% lang="en-US" %)

79

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

80

81

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

82

83

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

84

85

(% class="box infomessage" %)

86

(((

87

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

88

)))

89

90

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

91

92

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

93

94

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

95

96

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

97

98

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

99

100

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

105

"name": "string",

106

"fullName": "string",

107

"agentInfoType": 0,

108

"isForeign": true/false,

109

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

116

"email": "string",

117

"director": "string",

118

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

146

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

147

148

(% class="box infomessage" %)

149

(((

150

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

151

)))

152

153

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

154

155

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

156

157

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

158

159

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

160

161

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

162

163

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

164

165

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

166

167

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

"parentId": "string"

}

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

172

173

{

174

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

175

"parentId": "",

176

"name": "string",

177

"fullName": "string",

178

"agentInfoType": 0,

179

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

}

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

184

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

185

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

186

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

187

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

188

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

189

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

190

191

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

192

193

(% class="box successmessage" %)

194

(((

195

**POST /api/v3/agents **

196

)))

197

198

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

199

200

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

201

202

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

203

204

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

205

206

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

207

208

{

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

}

Ответ:

{

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

}

253

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

276

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

277

278

(% class="box warningmessage" %)

279

(((

280

**PUT /api/v3/agents**

281

)))

282

283

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

284

285

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

286

287

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

288

289

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

290

291

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

292

293

{

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

}

Ответ:

{

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

}

337

338

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

339

340

(% class="box errormessage" %)

341

(((

342

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

343

)))

344

345

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

346

347

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

348

349

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

350

351

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

352

353

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

354

355

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

356

357

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

358

359

(% class="box warningmessage" %)

360

(((

361

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

362

)))

363

364

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

365

366

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

367

368

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

Ответ: Code 204

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

373

374

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

375

376

(% class="box successmessage" %)

377

(((

378

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

379

)))

380

381

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

382

383

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

384

385

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

386

387

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

388

389

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

390

391

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

392

{

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

"doubleAuth":

409

{

410

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

411

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

},

"groups":

[

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

],

"customGroups":

[

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

420

],

421

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

}

{

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

426

"lastName": "string",

427

"firstName": "string",

428

"position": "string",

429

"phone": "string",

430

"organization": "string",

431

"login": "string",

432

"password": "string",

433

"email": "string",

434

435

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

436

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

437

438

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

439

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

440

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

460

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

461

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

462

463

464

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

465

466

(% class="box infomessage" %)

467

(((

468

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

469

)))

470

471

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

472

473

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

474

475

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

476

477

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

478

479

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

480

481

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

482

483

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

484

485

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

486

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

487

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

488

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

489

490

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

491

492

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

493

494

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

495

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

510

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

511

512

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

513

514

(% class="box infomessage" %)

515

(((

516

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

517

)))

518

519

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

520

521

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

522

523

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

524

525

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

526

527

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

(((

(((

{

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

"doubleAuth":

547

{

548

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

549

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

550

},

551

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

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

}

)))

)))

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

565

566

(% class="box warningmessage" %)

567

(((

568

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

569

)))

570

571

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

572

573

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

574

575

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

576

577

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

578

579

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

580

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

581

582

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

583

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

584

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

"doubleAuth":

603

{

604

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

605

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

606

},

607

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

608

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

609

610

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

611

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

612

613

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

614

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

615

616

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

617

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

618

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

"doubleAuth":

634

{

635

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

636

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

637

},

638

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

639

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

640

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

641

642

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

643

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

644

645

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

646

647

(% class="box warningmessage" %)

648

(((

649

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

650

)))

651

652

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

653

654

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

655

656

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

657

658

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

659

660

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

661

662

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

663

664

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

665

666

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

667

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

668

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

669

670

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

671

672

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

673

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

674

675

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

676

677

(% class="box warningmessage" %)

678

(((

679

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

680

)))

681

682

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

683

684

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

685

686

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

687

688

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

689

690

[

691

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

692

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

693

]

694

695

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

696

697

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

698

699

(% class="box warningmessage" %)

700

(((

701

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

702

)))

703

704

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

705

706

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

707

708

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

709

710

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

711

712

[

713

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

714

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

715

]

716

717

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

718

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

(((

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

{

"errorMessages": [

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

725

],

726

"users": [

727

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

728

]

729

}

730

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

731

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

732

)))

733

734

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

735

736

(% class="box errormessage" %)

737

(((

738

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

739

)))

740

741

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

742

743

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

744

745

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

746

747

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

748

749

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

750

751

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

752

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

753

754

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

755

756

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

757

758

(% class="box infomessage" %)

759

(((

760

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

761

)))

762

763

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

764

765

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

766

767

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

768

769

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

770

771

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

772

773

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

774

775

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

776

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

783

"hoppercapacity": 0,

784

"hopperdischargespeed": 0,

785

"modelType": 0,

786

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

787

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

806

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

807

808

(% class="box successmessage" %)

809

(((

810

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

811

)))

812

813

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

814

815

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

816

817

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

818

819

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

820

821

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

822

823

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

824

}

825

826

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

827

828

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

829

{

830

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

831

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

832

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

839

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

840

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

841

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

842

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

843

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

844

845

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

846

847

(% class="box successmessage" %)

848

(((

849

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

850

)))

851

852

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

853

854

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

855

856

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

857

858

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

859

860

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

861

862

{

863

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

864

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

873

"fueloutlay": 0,

874

"hoppercapacity": 0,

875

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

883

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

892

"hoppercapacity": 0,

893

"hopperdischargespeed": 0,

"modelType": 0

}

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

911

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

912

913

(% class="box warningmessage" %)

914

(((

915

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

916

)))

917

918

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

919

920

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

921

922

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

923

924

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

925

926

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

927

928

{

929

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

930

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

939

"fueloutlay": 0,

940

"hoppercapacity": 0,

941

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

949

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

958

"fueloutlay": 0,

959

"hoppercapacity": 0,

960

"hopperdischargespeed": 0,

"modelType": 0

}

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

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

977

978

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

979

980

(% class="box errormessage" %)

981

(((

982

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

983

)))

984

985

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

986

987

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

988

989

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

990

991

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

992

993

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

994

995

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

996

997

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

998

999

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

1000

1001

(% class="box infomessage" %)

1002

(((

1003

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

1004

)))

1005

1006

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

1007

1008

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

1009

1010

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

1011

1012

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

1013

1014

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

1015

1016

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

1017

1018

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

1019

1020

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

1021

1022

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

(((

{

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

1034

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

1035

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

1036

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

1037

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

1038

1039

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

1040

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

1041

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

1042

1043

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

1044

},

1045

1046

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

1047

{

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

}

1055

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

},

1082

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

},

1090

1091

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

1092

{

1093

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

1094

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

1095

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

1096

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

}

],

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

1101

{

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

{

1115

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

1116

{

1117

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

1118

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

1119

}

1120

],

1121

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

1122

}

1123

],

1124

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

1125

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

1126

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

1127

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

1128

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

1129

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

1130

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

1131

"string"

1132

],

1133

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

1134

"additionalProp1": "string",

1135

"additionalProp2": "string",

1136

"additionalProp3": "string"

1137

},

1138

1139

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

1140

1141

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

1142

1143

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

1144

1145

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

1146

1147

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

1148

1149

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

1150

1151

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

1152

1153

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

1154

1155

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

1156

1157

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

1158

1159

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

1160

1161

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

1162

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

1163

}

1164

1165

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

1166

{

1167

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

1168

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

1169

"description": "string",

1170

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

}

],

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

1175

{

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

}

],

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

1192

{

1193

"status": 0,

1194

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

1195

"description": "string",

1196

"additionalInfo": "string"

}

]

}

)))

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

1204

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

1205

1206

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

1207

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

1208

1209

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

1210

1211

(% class="box successmessage" %)

1212

(((

1213

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

1214

)))

1215

1216

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

1217

1218

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

1219

1220

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

1221

1222

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

1223

1224

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

1225

1226

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

1227

1228

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

1229

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

1230

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

1231

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

1232

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

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

1249

"mileageCalcMethod": 0,

1250

"mileageCoeff": 0,

1251

"locationByCellId": true,

1252

"dottedLineTrackWhenNoCoords": true,

1253

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

1254

{

1255

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

1256

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

1257

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

1258

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

1259

},

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

},

1267

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

1268

{

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

}

1281

1282

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

1283

{

1284

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

"isDefault": true

}

],

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

1289

{

1290

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1298

{

1299

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

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

{

1312

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

1313

{

1314

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

1315

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

1316

}

1317

],

1318

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

1319

}

1320

],

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

"string"

1329

],

1330

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

1331

"additionalProp1": "string",

1332

"additionalProp2": "string",

1333

"additionalProp3": "string"

1334

},

1335

1336

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

1337

1338

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

1339

1340

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

1341

1342

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

1343

1344

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

1345

1346

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

1347

1348

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

1349

1350

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

1351

1352

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

1353

1354

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

1355

1356

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

1357

1358

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

1359

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

1360

}

1361

],

1362

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

1363

{

1364

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1375

1376

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

1377

1378

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

1379

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

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

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

1387

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

1388

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

1389

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

1390

"mileageEnabled": true,

1391

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1396

"id": null,

1397

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

1398

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

1399

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

1400

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

1401

},

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

}

1415

1416

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

1417

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

1418

1419

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

1420

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

1421

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

1422

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

1423

1424

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

1425

1426

(% class="box infomessage" %)

1427

(((

1428

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

1429

)))

1430

1431

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

1432

1433

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

1434

1435

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

1436

1437

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

1438

1439

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

1440

1441

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

1442

1443

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

1444

1445

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

1446

1447

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

1448

1449

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

1450

1451

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

1452

1453

(% style="color:#000000" %)− X-Auth: Токен авторизации

1454

1455

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1456

1457

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1458

1459

{

1460

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1461

"name": null, ~/~/ Имя ТС (string, опционально)

1462

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1463

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1464

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1465

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1466

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1467

"customFields": null ~/~/ значение любого из произвольных полей ТС

1468

}

1469

1470

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1471

1472

(% style="color:#000000" %)Ответ:

1473

1474

(% style="color:#000000" %){

1475

1476

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1477

"name": "" ~/~/ наименование объекта

1478

"imei": "" ~/~/ IMEI объекта

1479

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1480

"deviceTypeName": "" ~/~/ наименование типа устройства

1481

"sim1": "" ~/~/ первый номер телефона

1482

"sim2": "" ~/~/ второй номер телефона

1483

"parentId": "" ~/~/ идентификатор клиента-родителя

1484

"parentName": "" ~/~/ наименование клиента-родителя

1485

"modelId": "" ~/~/ идентификатор модели объекта

1486

"modelName": "" ~/~/ наименование модели объекта

1487

"unitId": "" ~/~/ идентификатор подразделения

1488

"unitName": "" ~/~/ наименование подразделения

1489

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1490

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1491

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1492

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1493

"customFields": [

1494

{

1495

"id": "", ~/~/ идентификатор произвольного поля

1496

"name": "", ~/~/ имя произвольного поля

1497

"value": "", ~/~/ значение произвольного поля

1498

"forClient": true, ~/~/ право на отображение у клиента

1499

"forTooltip": false, ~/~/ право на отображение в подсказке

1500

"forReport": false ~/~/ право на отображение в отчетах

1501

}(%%)

1502

(% style="color:#000000" %)}

1503

1504

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1505

1506

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1507

1508

(% class="box successmessage" %)

1509

(((

1510

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1511

)))

1512

1513

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1514

1515

(% style="color:#000000" %)Метод запроса: **POST**

1516

1517

(% 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}

1518

1519

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1520

1521

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1522

1523

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1524

1525

(% style="color:#000000" %){

1526

1527

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1528

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1529

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1530

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1531

"description": "", ~/~/ Описание

1532

"data": "", ~/~/ Данные

1533

"overwrite": false, ~/~/ Флаг перезаписи

1534

"stage": "", ~/~/ Состояние, может быть null

1535

1536

(% style="color:#000000" %)}

1537

1538

(% style="color:#000000" %)Ответ:

1539

1540

(% style="color:#000000" %){

1541

1542

"status": "", ~/~/ значение статуса

1543

"date": "", ~/~/ Дата смены статуса

1544

"description": "", ~/~/ Описание

1545

"data": "", ~/~/ Данные

1546

"overwrite": false, ~/~/ Флаг перезаписи

1547

"stage": "", ~/~/ Состояние

1548

1549

(% style="text-align:left" %)

1550

(% style="color:#000000" %) }

1551

1552

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1553

1554

(% class="box warningmessage" %)

1555

(((

1556

(% lang="en-US" %)**PUT /api/v3/vehicles**

1557

)))

1558

1559

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1560

1561

(% style="color:#000000" %)Метод запроса: **PUT**

1562

1563

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1564

1565

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1566

1567

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1568

1569

(% style="color:#000000" %){

1570

"vehicleId": , ~/~/ ID объекта

1571

"parentId": "" , ~/~/ ID клиента

1572

"name": "" , ~/~/ имя ТС

1573

"imei": "" , ~/~/ IMEI

1574

"deviceTypeId": "" , ~/~/ ID типа устройства

1575

"modelId": "" , ~/~/ ID модели

1576

"unitId": "" , ~/~/ ID подразделения

1577

"sim1": "" , ~/~/ Номер SIM 1

1578

"sim2": "" , ~/~/ Номер SIM2

1579

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1580

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1581

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1582

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1583

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1584

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1585

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1586

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1587

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1588

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1589

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1590

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1591

1592

"mileageCalcMethod": 0,

1593

"mileageCoeff": 0,

1594

"locationByCellId": true,

1595

"dottedLineTrackWhenNoCoords": true,

1596

"counters": ~/~/ счетчики

1597

{

1598

"mileage": "" , ~/~/ пробег

1599

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1600

"motohours": "" , ~/~/ моточасы

1601

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1602

},

1603

"cmsv6Parameters": { ~/~/ параметры CMSv6

1604

"enabled": true, ~/~/ флаг включения

1605

"id": "" , ~/~/ идентификатор

1606

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1607

"login": "" , ~/~/ имя учетной записи

1608

"password": "" ~/~/ пароль учетной записи

1609

},

1610

"inspectionTasks": ~/~/ задания на ТО

1611

{

1612

"enabled": "" , ~/~/ Признак включения

1613

"name": "" , ~/~/ Имя задания

1614

"description": "" , ~/~/ Описание задания

1615

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1616

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1617

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1618

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1619

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1620

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1621

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1622

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1623

}

1624

1625

"drivers": [ ~/~/ Водители

1626

{

1627

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1632

{

1633

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1641

{

1642

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1643

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1644

"type": 0, ~/~/ Тип датчика

1645

"name": "string", ~/~/ Имя датчика

1646

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1647

"inputNumber": 0, ~/~/ Номер входа

1648

"pseudonym": "string", ~/~/ Псевдоним

1649

"medianDegree": 0, ~/~/ Медианная фильтрация

1650

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1651

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1652

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1653

"gradesTables": [ ~/~/ Массив таблиц тарировки

1654

{

1655

"grades": [ ~/~/ Таблица тарировки 1

1656

{

1657

"input": 0, ~/~/ Входящее значение

1658

"output": 0 ~/~/ Выходящее значение

1659

}

1660

],

1661

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1662

}

1663

],

1664

"showInTooltip": true, ~/~/ Отображать в подсказке

1665

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1666

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1667

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1668

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1669

"expr": "string", ~/~/ Формула

1670

"children": [ ~/~/ массив дочерних датчиков

1671

"string"

1672

],

1673

"customParams": { ~/~/ прочие произвольные параметры

1674

"additionalProp1": "string",

1675

"additionalProp2": "string",

1676

"additionalProp3": "string"

1677

},

1678

1679

~/~/ Характерные для произвольного:

1680

1681

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1682

1683

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1684

1685

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1686

1687

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1688

1689

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1690

1691

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1692

1693

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1694

1695

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1696

1697

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1698

1699

~/~/ "ValueOn": "Вкл.",

1700

1701

~/~/ "ValueOff": "Выкл."

1702

"summaryMaxValue": 0 ~/~/ Макс. значение

1703

}

1704

],

1705

"customFields": [ ~/~/ Произвольные поля

1706

{

1707

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

(% style="color:#000000" %)Ответ:

1718

1719

(% lang="en-US" style="text-align:left" %)

1720

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1721

1722

(% lang="en-US" style="text-align:left" %)

1723

"vehicleId": "", ~/~/ ID ТС

1724

"parentId": "", ~/~/ ID клиента

1725

"name": "", ~/~/ имя ТС

1726

"imei": "", ~/~/ IMEI

1727

"deviceTypeId": "", ~/~/ типа устройства

1728

"modelId": "", ~/~/ ID модели

1729

"unitId": "", ~/~/ ID подразделения

1730

"sim1": "", ~/~/ SIM 1

1731

"sim2": "", ~/~/ SIM2

1732

"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км

1733

"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу

1734

"counters":

1735

{

1736

"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»

1737

"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»

1738

"mileage": "", ~/~/ пробег

1739

"motohours": "", ~/~/ моточасы

1740

}

1741

"cmsv6Parameters": ~/~/ параметры CMSv6

1742

{

1743

"id": ~/~/ идентификатор

1744

"enabled": true, ~/~/ флаг включения

1745

"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1746

"login": "", ~/~/ имя учетной записи

1747

"password": "", ~/~/ пароль учетной записи

1748

}

1749

"inspectionTasks": ~/~/ задания на ТО

1750

{

1751

"id": "", ~/~/ ID задания

1752

"enabled": false, ~/~/ Признак включения

1753

"name": "", ~/~/ Имя задания

1754

"description": "", ~/~/ Описание задания

1755

"mileageCondition": "", ~/~/ Условие по пробегу

1756

"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО

1757

"motohoursCondition": "", ~/~/ Условие по моточасам

1758

"lastMotohours": "", ~/~/ Моточасы

1759

"periodicCondition": "", ~/~/ Условие периодичности по времени

1760

"kind": "", ~/~/ Вид периодичности по времени

1761

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1762

}

1763

1764

(% lang="en-US" style="text-align:left" %)

1765

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1766

1767

**Валидация:**

1768

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1769

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1770

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1771

1772

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1773

1774

(% class="box errormessage" %)

1775

(((

1776

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1777

)))

1778

1779

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

1780

1781

(% style="color:#000000" %)Метод запроса: **DELETE**

1782

1783

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1784

1785

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1786

1787

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1788

1789

(% style="text-align:left" %)

1790

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1791

1792

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1793

1794

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1795

1796

(% class="box infomessage" %)

1797

(((

1798

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1799

)))

1800

1801

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

1802

1803

(% style="color:#000000" %)Метод запроса: **GET**

1804

1805

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

1806

1807

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1808

1809

(% style="color:#000000" %)Ответ:

1810

1811

(% style="color:#000000" %){

1812

1813

"deviceTypeId" : "", ~/~/ ID типа устройства

1814

"deviceTypeName" : "" ~/~/ Название типа устройства

1815

1816

(% style="text-align:left" %)

1817

(% style="color:#000000" %)}

1818

1819

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1820

1821

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1822

1823

(% class="box infomessage" %)

1824

(((

1825

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1826

)))

1827

1828

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

1829

1830

(% style="color:#000000" %)Метод запроса: **GET**

1831

1832

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1833

1834

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1835

1836

(% style="color:#000000" %)Ответ:

1837

1838

(% style="color:#000000" %){

1839

1840

"id": "", ~/~/ ID типа датчика

1841

"name": "", ~/~/ Название

1842

"description": "", ~/~/ Описание

1843

1844

(% style="text-align:left" %)

1845

(% style="color:#000000" %)}

1846

1847

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

1848

1849

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1850

1851

(% class="box infomessage" style="text-align: left;" %)

1852

(((

1853

**POST /api/v3/terminalMessages/count**

1854

)))

1855

1856

(% style="text-align: left;" %)

1857

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

1858

1859

(% style="text-align: left;" %)

1860

Метод запроса **POST**

1861

1862

(% style="text-align: left;" %)

1863

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1864

1865

(% style="text-align: left;" %)

1866

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1867

1868

(% style="text-align: left;" %)

1869

{

1870

"vehicleIds": [

1871

id ~/~/ здесь передается список идентификаторов объектов

1872

],

1873

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1874

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1875

}

1876

1877

(% style="text-align: left;" %)

1878

Ответ:

1879

1880

(% style="text-align: left;" %)

1881

[

1882

{

1883

"vehicleId": 0, ~/~/ идентификатор объекта

1884

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

1889

1890

(% class="box infomessage" style="text-align: left;" %)

1891

(((

1892

**POST /api/v3/terminalMessages/mapping**

1893

)))

1894

1895

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

1896

1897

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

1898

1899

(% 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);" %)**Описание**

1907

|protocolType|ID типа протокола

1908

|params|(((

1909

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

1929

|protocolType|Тип протокола

1930

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

1936

Перечень 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/]]

1937

1938

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

1939

1940

(% class="box infomessage" %)

1941

(((

1942

**POST /api/v3/terminalMessages**

1943

)))

1944

1945

Метод возвращает список сообщений терминала объекта за выбранный период.

1946

1947

(% style="text-align: left;" %)

1948

Метод запроса **POST**

1949

1950

(% style="text-align: left;" %)

1951

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

1952

1953

(% style="text-align: left;" %)

1954

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1955

1956

{

1957

"vehicleId": 0, ~/~/ id объекта

1958

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

1959

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

1960

}

1961

1962

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1963

|vehicleId|ID объекта

1964

|from|Дата и время начала периода запроса

1965

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

1974

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

1984

"additionalProp2": "string",

1985

"additionalProp3": "string"

1986

},

1987

"photoCount": 0,

1988

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

1996

|deviceTime|Время сообщения терминала

1997

|serverTime|Время когда сообщение поступило на сервер

1998

|speed|Скорость

1999

|altitude|Высота над уровнем моря

2000

|latitude|Широта

2001

|longitude|Долгота

2002

|satellites|Кол-во спутников

2003

|course|Курс

2004

|voltage|Бортовое напряжение

2005

|parameters|Список параметров и их значений

2006

|photoCount|Количество фото

2007

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2008

|protocolType|ID типа протокола

2009

2010

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2011

2012

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2013

2014

(% class="box infomessage" %)

2015

(((

2016

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2017

)))

2018

2019

(% style="color:#000000" %)Метод запроса: **POST**

2020

2021

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2022

2023

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2024

2025

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2030

"vehicleIds": [0], ~/~/ Список ID объектов

2031

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2032

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2033

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2041

"name": "string", ~/~/ Имя ТС

2042

"periods": [ ~/~/ Периоды

2043

{

2044

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2045

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2046

"mileageBegin": 0, ~/~/ Пробег на начало периода

2047

"mileageEnd": 0, ~/~/ Пробег на окончание периода

2048

"motohoursBegin": 0, ~/~/ Моточасы на начало периода

2049

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2056

2057

(% class="box infomessage" %)

2058

(((

2059

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2060

)))

2061

2062

(% style="color:#000000" %)Метод запроса: **POST**

2063

2064

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2065

2066

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2067

2068

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2073

"vehicleIds": [0], ~/~/ Список ID объектов

2074

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2075

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2076

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2084

"name": "string", ~/~/ Имя ТС

2085

"periods": [ ~/~/ Периоды

2086

{

2087

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2088

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2089

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2090

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2091

"fuelConsumption": 0, ~/~/ Расход топлива

2092

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2099

2100

(% class="box infomessage" %)

2101

(((

2102

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2103

)))

2104

2105

(% style="color:#000000" %)Метод запроса: **POST**

2106

2107

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2108

2109

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2110

2111

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2116

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2117

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2118

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2126

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2127

"vehicleId": 0, ~/~/ ID объекта

2128

"name": "string", ~/~/ Имя объекта

2129

"model": "string", ~/~/ Модель объекта

2130

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2131

{

2132

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2133

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2134

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2135

"valueFuel": 0, ~/~/ Количество

2136

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2137

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2145

2146

(% class="box infomessage" %)

2147

(((

2148

**POST /api/v3/vehicles/moveStop**

2149

)))

2150

2151

Метод запроса: **POST**

2152

2153

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2154

2155

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2163

2164

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2165

2166

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2167

2168

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2179

2180

"vehicleName": "string", ~/~/ Имя объекта

2181

2182

"moves": [ ~/~/ Событие движения

{

"mileage": 0, ~/~/ Пробег, км

2187

2188

"eventId": 0, ~/~/ Идентификатор события

2189

2190

"eventName": "string", ~/~/ Название события

2191

2192

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2193

2194

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2195

2196

"duration": 0 ~/~/ Продолжительность события, секунд

}

],

"stops": [ ~/~/ События стоянок

{

"address": "string", ~/~/ Адрес события

2207

2208

"eventId": 0, ~/~/ Идентификатор события

2209

2210

"eventName": "string", ~/~/ Название события

2211

2212

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2213

2214

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2215

2216

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2230

2231

(% class="box infomessage" %)

2232

(((

2233

**POST /api/v3/vehicles/getlastdata**

2234

)))

2235

2236

Метод запроса: **POST**

2237

2238

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2239

2240

В заголовках запроса: X-Auth: Токен авторизации

2241

2242

2243

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2248

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2249

"vehicleNumber": "string",~/~/Номер объекта.

2250

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2251

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2252

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2253

"speed": 0,~/~/Скорость объекта.

2254

"course": 0,~/~/Курс движения [0;360]

2255

"latitude": 0,~/~/Широта [-90°;90°].

2256

"longitude": 0,~/~/Долгота [-180°;180°].

2257

"address": "string",~/~/Адрес.

2258

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2267

2268

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2269

2270

(% class="box infomessage" %)

2271

(((

2272

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2273

)))

2274

2275

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2276

2277

(% style="color:#000000" %)Метод запроса: **POST**

2278

2279

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2280

2281

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2282

2283

(% style="text-align:left" %)

2284

Тело запроса:

2285

2286

(% style="text-align:left" %)

2287

{

2288

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2289

}

2290

2291

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2297

"name": "string", ~/~/ Название объекта геозоны

2298

"type": 0, ~/~/ Тип объекта геозоны

2299

"fname": "string", ~/~/ Имя файла

2300

"parentId": "string", ~/~/ Идентификатор клиента

2301

"radius": 0, ~/~/ Радиус геообъекта

2302

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2303

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2304

"description": "string", ~/~/ Описание

2305

"area": 0, ~/~/ Площадь, м^^2^^

2306

"perimetr": 0, ~/~/ Периметр, м

2307

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2312

2313

(% class="box infomessage" %)

2314

(((

2315

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2316

)))

2317

2318

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2319

2320

(% style="color:#000000" %)Метод запроса: **POST**

2321

2322

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2323

2324

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2325

2326

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2331

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2332

"ids": [ ], ~/~/ Массив id объектов

2333

"byTime": 0, ~/~/ Объединение событий по времени

2334

"byDist": 0, ~/~/ Объединение событий по расстоянию

2335

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2336

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2343

"geozoneName": "string", ~/~/ Название геообъекта

2344

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2345

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2346

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2347

"vehicleId": 0, ~/~/ ID объекта

2348

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2353

2354

(% class="box infomessage" %)

2355

(((

2356

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2357

)))

2358

2359

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2360

2361

(% style="color:#000000" %)Метод запроса: **POST**

2362

2363

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2364

2365

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2366

2367

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2372

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2373

"ids": [ ], ~/~/ Массив id геообъектов

2374

"byTime": 0, ~/~/ Объединение событий по времени

2375

"byDist": 0, ~/~/ Объединение событий по расстоянию

2376

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2377

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2385

"geozoneName": "string", ~/~/ Название геообъекта

2386

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2387

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2388

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2389

"vehicleId": 0, ~/~/ ID объекта

2390

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2395

2396

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2397

2398

(% class="box infomessage" %)

2399

(((

2400

**POST /api/v3/notifications/find**

2401

)))

2402

2403

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2404

2405

(% style="text-align: left;" %)

2406

Метод запроса **POST**

2407

2408

(% style="text-align: left;" %)

2409

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2410

2411

(% style="text-align: left;" %)

2412

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2413

2414

{

2415

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2423

"name": "string", ~/~/ Название уведомления

2424

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2425

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2426

"userId": "", ~/~/ Пользователь, создавший уведомление

2427

"parentId": "", ~/~/ Идентификатор клиента

2428

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2433

2434

(% class="box infomessage" %)

2435

(((

2436

**GET /api/v3/notifications/{id}**

2437

)))

2438

2439

Метод возвращает данные правил формирования выбранного уведомления.

2440

2441

(% style="text-align: left;" %)

2442

Метод запроса **GET**

2443

2444

(% style="text-align: left;" %)

2445

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2446

2447

(% style="text-align: left;" %)

2448

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2449

2450

(% style="text-align: left;" %)

2451

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2452

2453

(% style="text-align: left;" %)

2454

(% style="color:#000000" %)Ответ:

2455

2456

(% style="text-align: left;" %)

2457

(% style="color:#000000" %){

2458

"id": 0, ~/~/ (%%)id уведомления

2459

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2460

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2461

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2462

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2463

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2464

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2465

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2466

(% style="color:#000000" %) 0

2467

],

2468

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2469

(% style="color:#000000" %) 0

2470

],

2471

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2472

(% style="color:#000000" %) 0

2473

],

2474

"settings": { ~/~/ Список параметров уведомления

2475

"additionalProp1": "string",

2476

"additionalProp2": "string",

2477

"additionalProp3": "string"

2478

},

2479

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2480

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2481

(% style="color:#000000" %) ""

2482

],

2483

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2484

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2485

(% style="color:#000000" %) "string"

2486

],

2487

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2488

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2489

(% style="color:#000000" %) {

2490

"id": 0, ~/~/ (%%)Идентификатор участника чата

2491

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2492

(% style="color:#000000" %) }

2493

],

2494

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2495

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2496

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2497

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2498

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2499

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2500

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2501

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2502

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2503

(% style="color:#000000" %)}

2504

2505

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2506

2507

(% class="box warningmessage" %)

2508

(((

2509

**PUT /api/v3/notifications/**

2510

)))

2511

2512

Метод позволяет отредактировать уведомление.

2513

2514

Метод запроса **PUT**

2515

2516

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2517

2518

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2523

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2524

"userId": "", ~/~/ Пользователь, создавший уведомление

2525

"parentId": "", ~/~/ Идентификатор клиента

2526

"parentName": "string", ~/~/ Имя клиента

2527

"name": "string", ~/~/ Название уведомления

2528

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2529

"vehicleIds": [ ~/~/ Список id объектов для анализа

2530

0

2531

],

2532

"geoids": [ ~/~/ Список id геообъектов для анализа

2533

0

2534

],

2535

"fieldids": [ ~/~/ Список id полей для анализа

2536

0

2537

],

2538

"settings": { ~/~/ Список параметров уведомления

2539

"additionalProp1": "string",

2540

"additionalProp2": "string",

2541

"additionalProp3": "string"

2542

},

2543

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2544

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2545

""

2546

],

2547

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2548

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2549

"string"

2550

],

2551

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2552

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2553

{

2554

"id": 0, ~/~/ Идентификатор участника чата

2555

"info": "string" ~/~/ Дополнительные сведения

2556

}

2557

],

2558

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2559

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2560

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2561

"kind": 0, ~/~/ Определяет вид уведомления

2562

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2563

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2564

"timezone": 0, ~/~/ Сдвиг часового пояса

2565

"validity": 0, ~/~/ Срок действия в днях (1-90)

2566

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2574

2575

(% class="box errormessage" %)

2576

(((

2577

**DELETE /api/v3/notifications/{id}**

2578

)))

2579

2580

Метод позволяет удалить выбранное уведомление.

2581

2582

Метод запроса **DELETE**

2583

2584

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2585

2586

Передаваемый параметр: {id} - id уведомления

2587

2588

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2596

2597

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2598

2599

(% class="box infomessage" %)

2600

(((

2601

**POST /api/v3/Drivers/find**

2602

)))

2603

2604

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2611

"description": "string", ~/~/ Определяет описание

2612

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2613

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2614

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2615

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2616

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2617

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2622

2623

(% class="box infomessage" %)

2624

(((

2625

**GET /api/v3/Drivers/{driverGuid}**

2626

)))

2627

2628

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2634

"description": "string", ~/~/ Определяет описание

2635

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2636

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2637

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2638

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2639

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2640

"deleted": true ~/~/ Признак удаления

2641

}

2642

2643

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2644

2645

(% class="box successmessage" %)

2646

(((

2647

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2655

"hiredate": "2023-06-30T12:50:54.020Z",

2656

"chopdate": "2023-06-30T12:50:54.020Z",

2657

"exclusive": true,

2658

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2659

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2668

"hiredate": "2023-06-30T12:50:54.051Z",

2669

"chopdate": "2023-06-30T12:50:54.051Z",

2670

"exclusive": true,

2671

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2672

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2678

2679

(% class="box warningmessage" %)

2680

(((

2681

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2689

"hiredate": "2023-06-30T12:50:27.910Z",

2690

"chopdate": "2023-06-30T12:50:27.910Z",

2691

"exclusive": true,

2692

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2693

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2702

"hiredate": "2023-06-30T12:50:27.929Z",

2703

"chopdate": "2023-06-30T12:50:27.929Z",

2704

"exclusive": true,

2705

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2706

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2712

2713

(% class="box errormessage" %)

2714

(((

2715

**DELETE /api/v3/Drivers/{driverGuid}**

2716

)))

2717

2718

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2726

2727

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2728

2729

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2730

2731

(% class="box infomessage" %)

2732

(((

2733

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2741

],

2742

"BeginTime": "2023-06-30T12:49:04.365Z",

2743

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2752

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2753

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2754

"BeginTime": "2023-06-30T09:52:31.240Z",

2755

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2761

2762

(% class="box infomessage" %)

2763

(((

2764

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

2774

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

2783

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2784

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2785

"BeginTime": "2023-06-30T09:54:01.631Z",

2786

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

2792

2793

(% class="box successmessage" %)

2794

(((

2795

**POST /api/v3/DriversVehiclesAssignments**

2796

)))

2797

2798

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

2805

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

2806

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2807

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

2808

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

2818

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2819

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2820

"BeginTime": "2023-06-30T11:04:46.903Z",

2821

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

2827

2828

(% class="box warningmessage" %)

2829

(((

2830

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

2839

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2840

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2841

"BeginTime": "2023-06-30T11:14:08.117Z",

2842

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

2852

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2853

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2854

"BeginTime": "2023-06-30T11:14:53.349Z",

2855

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

2861

2862

(% class="box errormessage" %)

2863

(((

2864

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

2879

2880

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

2881

2882

(% class="box infomessage" %)

2883

(((

2884

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2892

],

2893

"BeginTime": "2023-06-30T12:47:12.162Z",

2894

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2902

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2903

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2904

"BeginTime": "2023-06-30T11:19:40.703Z",

2905

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

2911

2912

(% class="box infomessage" %)

2913

(((

2914

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2922

],

2923

"BeginTime": "2023-06-30T12:47:12.162Z",

2924

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

2932

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

2933

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

2934

"BeginTime": "2023-06-30T11:19:40.703Z",

2935

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

2941

2942

(% class="box successmessage" %)

2943

(((

2944

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2952

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2953

"BeginTime": "2023-06-30T11:27:08.635Z",

2954

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2963

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2964

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2965

"BeginTime": "2023-06-30T11:27:08.677Z",

2966

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

2972

2973

(% class="box warningmessage" %)

2974

(((

2975

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2983

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2984

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2985

"BeginTime": "2023-06-30T11:28:43.330Z",

2986

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2995

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2996

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2997

"BeginTime": "2023-06-30T11:28:43.331Z",

2998

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3004

3005

(% class="box errormessage" %)

3006

(((

3007

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3022

3023

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3024

3025

(% class="box infomessage" %)

3026

(((

3027

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3035

],

3036

"BeginTime": "2023-06-30T12:45:10.852Z",

3037

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3045

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3046

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3047

"BeginTime": "2023-06-30T11:58:04.695Z",

3048

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3054

3055

(% class="box infomessage" %)

3056

(((

3057

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3065

],

3066

"BeginTime": "2023-06-30T12:45:10.852Z",

3067

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3075

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3076

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3077

"BeginTime": "2023-06-30T11:58:04.695Z",

3078

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3084

3085

(% class="box successmessage" %)

3086

(((

3087

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3095

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3096

"BeginTime": "2023-06-30T12:09:53.175Z",

3097

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3106

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3107

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3108

"BeginTime": "2023-06-30T12:09:53.201Z",

3109

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3115

3116

(% class="box warningmessage" %)

3117

(((

3118

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3126

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3127

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3128

"BeginTime": "2023-06-30T12:09:53.201Z",

3129

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3138

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3139

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3140

"BeginTime": "2023-06-30T12:09:53.201Z",

3141

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3147

3148

(% class="box errormessage" %)

3149

(((

3150

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3165

3166

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3167

3168

(% class="box infomessage" %)

3169

(((

3170

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3177

"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);" %)**Описание**

3183

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3184

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3185

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3186

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3193

"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",

3203

"name": "string",

3204

"rid": "string",

3205

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3206

"trailer": {

3207

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3208

"Number": "string",

3209

"Description": "string",

3210

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3211

"ExternalID": "string",

3212

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3213

"CreateTime": "2023-11-14T10:48:03.717Z",

3214

"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);" %)**Описание**

3222

|SD|Дата и время начала события

3223

|ED|Дата и время окончания события

3224

|id|ID объекта

3225

|SLat|Широта начальной координаты

3226

|SLon|Долгота начальной координаты

3227

|ELat|Широта конечной координаты

3228

|ELon|Долгота конечной координаты

3229

|mileage|Пробег

3230

|Duration|Продолжительность

3231

|Address|Адрес начального местоположения

3232

|Address2|Адрес конечного местоположения

3233

|name|Имя радиометки

3234

|rid|Номер радиометки

3235

|rguid|ID радиометки

3236

|trailer|Информация об агрегате

3237

|ModelGuid|ID агрегата

3238

|Number|Название/номер агрегата

3239

|Description|Текст примечания агрегата

3240

3241

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3242

3243

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3244

3245

(% class="box infomessage" %)

3246

(((

3247

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3264

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3269

|parentId|ID клиента

3270

|name|Название карты-метки

3271

|number|Номер

3272

|period|Период запросов в секундах (работает только для агрегатов)

3273

|id|ID карты-метки

3274

3275

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3276

3277

(% class="box infomessage" %)

3278

(((

3279

**GET /api/v3/Rfids/{rfidGuid}**

3280

)))

3281

3282

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3292

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3297

|name|Название карты-метки

3298

|number|Номер

3299

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3304

3305

(% class="box successmessage" %)

3306

(((

3307

**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",

3326

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3327

}

3328

3329

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3330

|name|Название карты-метки

3331

|number|Номер

3332

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3337

3338

(% class="box warningmessage" %)

3339

(((

3340

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3350

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3360

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3361

}

3362

3363

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3364

|name|Название карты-метки

3365

|number|Номер

3366

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3371

3372

(% class="box errormessage" %)

3373

(((

3374

**DELETE /api/v3/Rfids/{rfidGuid}**

3375

)))

3376

3377

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3385

3386

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3387

3388

(% class="box infomessage" %)

3389

(((

3390

**GET /api/v3/Billing/client/balance/{clientId}**

3391

)))

3392

3393

Параметр запроса: **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);" %)**Описание**

3403

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3404

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3405

3406

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3407

3408

(% class="box infomessage" %)

3409

(((

3410

**GET /api/v3/Billing/client/constraint/{clientId}**

3411

)))

3412

3413

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3419

"CalculationType": 0,

3420

"PermissibleBalance": 0,

3421

"DefermentDays": 0,

3422

"SendUiNotifications": true,

3423

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3428

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3429

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3430

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3431

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3432

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3433

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3434

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3435

3436

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3437

3438

(% class="box infomessage" %)

3439

(((

3440

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3446

3447

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3453

"Plan": { **~/~/ Описание тарифного плана**

3454

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3455

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3460

"PermissibleBalance": 0,

3461

"DefermentDays": 0

3462

},

3463

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3475

"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);" %)**Описание**

3491

|ClientId|Идентификатор клиента

3492

|Id|Идентификатор тарифного плана

3493

|OwnerId|Идентификатор клиента-владельца

3494

|Name|Наименование тарифного плана

3495

|IsArchived|Признак, определяющий архивный тарифный план

3496

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3497

|PermissibleBalance|Допустимый баланс

3498

|DefermentDays|Отсрочка, количество дней

3499

|Feature|Код услуги

3500

|IsEnabled|Признак, определяющий активирована ли услуга

3501

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3502

|IsFactual|Признак, определяющий расчёт по факту

3503

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3504

|Price|Цена за единицу.

3505

|DebitDate|Следующий момент времени списания с баланса за услугу.

3506

|PeriodValue|Значение периода.

3507

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3508

3509

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3510

3511

(% class="box infomessage" %)

3512

(((

3513

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3514

)))

3515

3516

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3523

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3528

"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);" %)**Описание**

3545

|ClientId|Идентификатор клиента

3546

|Id|Идентификатор тарифного плана

3547

|OwnerId|Идентификатор клиента-владельца

3548

|Name|Наименование тарифного плана

3549

|IsArchived|Признак, определяющий архивный тарифный план

3550

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3551

|PermissibleBalance|Допустимый баланс

3552

|DefermentDays|Отсрочка, количество дней

3553

|Feature|Код услуги

3554

|IsFactual|Признак, определяющий расчёт по факту

3555

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3556

|Price|Цена за единицу.

3557

|PeriodValue|Значение периода.

3558

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3559

3560

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3561

3562

(% class="box infomessage" %)

3563

(((

3564

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3565

)))

3566

3567

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3574

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3579

"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);" %)**Описание**

3596

|ClientId|Идентификатор клиента

3597

|Id|Идентификатор тарифного плана

3598

|OwnerId|Идентификатор клиента-владельца

3599

|Name|Наименование тарифного плана

3600

|IsArchived|Признак, определяющий архивный тарифный план

3601

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3602

|PermissibleBalance|Допустимый баланс

3603

|DefermentDays|Отсрочка, количество дней

3604

|Feature|Код услуги

3605

|IsFactual|Признак, определяющий расчёт по факту

3606

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3607

|Price|Цена за единицу.

3608

|PeriodValue|Значение периода.

3609

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3610

3611

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3612

3613

(% class="box warningmessage" %)

3614

(((

3615

**PUT /api/v3/Billing/client/balance**

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

(% class="box warningmessage" %)

3636

(((

3637

**PUT /api/v3/billing/client/balance/deposit**

3638

)))

3639

3640

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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

Создает операцию **Списание **с указанной суммой

3658

3659

(% class="box warningmessage" %)

3660

(((

3661

**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);" %)**Описание**

3674

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3675

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3676

3677

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3678

3679

(% class="box warningmessage" %)

3680

(((

3681

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3688

"CalculationType": 0,

3689

"PermissibleBalance": 0,

3690

"DefermentDays": 0,

3691

"SendUiNotifications": true,

3692

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3699

|ClientId|Идентификатор клиента

3700

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3701

|PermissibleBalance|Допустимый баланс

3702

|DefermentDays|(((

3703

Отсрочка, количество дней

3704

)))

3705

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3706

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3707

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3708

3709

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3710

3711

(% class="box warningmessage" %)

3712

(((

3713

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3720

"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);" %)**Описание**

3738

|ClientId|Идентификатор клиента

3739

|PlanId|Идентификатор тарифного плана

3740

|Feature|Код услуги

3741

|IsEnabled|Признак, определяющий активирована ли услуга

3742

|IsFactual|Признак, определяющий расчёт по факту

3743

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3744

|Price|Цена за единицу.

3745

|DebitDate|Следующий момент времени списания с баланса за услугу.

3746

|PeriodValue|Значение периода.

3747

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3748

3749

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3750

3751

(% class="box warningmessage" %)

3752

(((

3753

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3754

)))

3755

3756

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3757

3758

(% class="box infomessage" %)

3759

(((

3760

**POST /api/v3/vehicles/import/{agentId}**

3761

)))

3762

3763

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**

3764

3765

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3774

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3775

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление

3776

3777

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3782

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3783

|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);" %)**Описание**

3794

|vehicleId|ID созданного объекта

3795

|name|Имя созданного объекта

3796

|errors|Ошибки и их описание

3797

3798

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3799

3800

(% class="box infomessage" %)

3801

(((

3802

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3803

)))

3804

3805

(% class="wikigeneratedid" %)

3806

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3807

3808

(% class="wikigeneratedid" %)

3809

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3814

3815

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3820

|**history**|В значении передавать файл с историей

3821

3822

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3835

"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);" %)**Описание**

3843

|results|Результаты импорта в разрезе ТС

3844

|vehicleGuid|Guid ТС

3845

|vehicleId|ID ТС

3846

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3847

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3848

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3849

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3850

|msgCount|Кол-во обработанных сообщений всего

3851

3852

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3853

3854

(% class="box infomessage" %)

3855

(((

3856

**GET /api/v3/vehicles/import/history/status**

3857

)))

3858

3859

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3870

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3871

|progress|Guid ТС

3872

3873

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3874

3875

(% class="box infomessage" %)

3876

(((

3877

**POST /api/v3/vehicles/export**

3878

)))

3879

3880

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3889

3890

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3891

3892

(% class="box infomessage" %)

3893

(((

3894

**POST /api/v3/vehicles/export/history**

3895

)))

3896

3897

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3905

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3911

3912

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3913

|vehicleId|ID объекта

3914

|asArchive|true - Архивировать файл, False - не архивировать

3915

|from|Дата и время начала запроса

3916

|to|Дата и время окончания запроса

3917

3918

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3919

3920

(% class="box infomessage" %)

3921

(((

3922

**GET /api/v3/vehicles/export/history/status**

3923

)))

3924

3925

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3936

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3937

|progress|Прогресс экспорта, от 0 до 100%

3938

|message|Текст описывающий статус

3939

3940

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3941

3942

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

3943

3944

(% class="box infomessage" %)

3945

(((

3946

**POST /api/v3/EcoDriving/rating**

3947

)))

3948

3949

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3955

"from": "2023-11-22T09:29:48.051Z",

3956

"to": "2023-11-22T09:29:48.051Z"

3957

}

3958

3959

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3960

|vehicleIds|Массив ID объектов

3961

|from|Дата начала запроса

3962

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

3970

"to": "2023-11-22T09:29:48.052Z",

3971

"vehicleId": 0,

3972

"vehicleName": "string",

3973

"vehicleModel": "string",

3974

"penalty": 0,

3975

"score": 0,

3976

"totalViolations": 0,

3977

"violationsByType": {

3978

"overspeedingViolations": 0,

3979

"accelerationViolations": 0,

3980

"brakingViolations": 0,

3981

"turningViolations": 0,

3982

"dangerousDrivingViolations": 0,

3983

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

3993

"violationsByType": {

3994

"overspeedingViolations": 0,

3995

"accelerationViolations": 0,

3996

"brakingViolations": 0,

3997

"turningViolations": 0,

3998

"dangerousDrivingViolations": 0,

3999

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4006

"endAddress": "string",

4007

"drivers": [

4008

{

4009

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4010

"driverName": "string",

4011

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4021

|from|Дата начала запроса

4022

|to|Дата окончания

4023

|vehicleId|ID объекта

4024

|vehicleName|Имя объекта

4025

|vehicleModel|Модель объекта

4026

|penalty|Сумма штрафных баллов

4027

|score|Оценка

4028

|totalViolations|Суммарное количество нарушений

4029

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4030

|overspeedingViolations|Превышение скорости

4031

|accelerationViolations|Ускорение

4032

|brakingViolations|Торможение

4033

|turningViolations|Резкий поворот

4034

|dangerousDrivingViolations|Резкое вождение

4035

|sensorViolations|Нарушение по датчику

4036

|moveTime|Время в движении

4037

|mileage|Пробег

4038

|tripsCount|Количество рейсов

4039

|motohours|Моточасы

4040

|maxSpeed|Максимальная скорость

4041

|startAddress|Адрес начала рейса

4042

|endAddress|Адрес окончания рейса

4043

|drivers|Список водителей, которые были на объекте в течениии рейса

4044

|driverGuid|Guid водителя

4045

|driverName|Имя водителя

4046

|driverRfid|Номер Карты-метки

4047

4048

4049

(% style="color:#000000; font-size:18.6667px" %)Раздел: Топливные карты

4050

4051

===== **Запрос транзакций по топливным картам** =====

4052

4053

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»

4054

4055

(% class="box infomessage" %)

4056

(((

4057

**POST**/api/v3/fuelcards/transactions

4058

)))

4059

4060

Запрос должен содержать параметры:

{

"startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения

4065

4066

"endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения

"ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт

],

"timezone": 0, ~/~/ Часовой пояс

4075

4076

"agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца

}

Ответ:

{

"date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции

4085

4086

" driver ": "string", ~/~/ Имя водителя

4087

4088

"amount": 0, ~/~/ Количество топлива

4089

4090

"amountDut": 0, ~/~/ Количество топлива по ДУТ

4091

4092

"amountDiff": 0, ~/~/ Разница в литрах

4093

4094

"amountDiffPerc": 0, ~/~/ Разница в %

4095

4096

"summa": 0, ~/~/ Стоимость в руб.

4097

4098

"serviceName": "string", ~/~/ Тип топлива

4099

4100

"price": 0, ~/~/ Цена за литр в руб.

4101

4102

"cardName": "string", ~/~/ Наименование ТК

4103

4104

"cardNum": "string", ~/~/ Номер ТК

4105

4106

"operator": "string", ~/~/ Оператор ТК

4107

4108

"address": "string", ~/~/ Адрес АЗС

4109

4110

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid топливной карты

}

(% class="box" lang="en-US" style="text-align: center;" %)

4116

(((

4117

(% 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]] **

4118

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft