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

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

24

25

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

26

27

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

28

29

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

30

31

32

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

33

34

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

35

36

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

37

38

(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)

39

(((

40

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

41

(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)

42

)))

43

44

(% class="box successmessage" %)

45

(((

46

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

47

)))

48

49

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

50

51

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

52

53

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

54

55

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

56

57

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

58

59

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

60

"login": "testuser",

61

"password": "testuser"

62

}

63

64

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

65

66

(% lang="en-US" %)

67

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

68

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

69

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

70

}

71

72

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

73

74

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

75

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

76

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

77

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

78

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

79

80

(% class="wikigeneratedid" %)

81

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

82

83

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

84

85

(% class="box infomessage" %)

86

(((

87

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

88

)))

89

90

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

91

92

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

93

94

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

95

96

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

97

98

(% lang="en-US" %)

99

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

100

101

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

102

103

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

104

105

(% class="box infomessage" %)

106

(((

107

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

108

)))

109

110

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

111

112

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

113

114

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

115

116

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

117

118

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

119

120

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

125

"name": "string",

126

"fullName": "string",

127

"agentInfoType": 0,

128

"isForeign": true/false,

129

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

136

"email": "string",

137

"director": "string",

138

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

166

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

167

168

(% class="box infomessage" %)

169

(((

170

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

171

)))

172

173

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

174

175

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

176

177

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

178

179

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

180

181

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

182

183

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

184

185

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

186

187

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

"parentId": "string"

}

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

192

193

{

194

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

195

"parentId": "",

196

"name": "string",

197

"fullName": "string",

198

"agentInfoType": 0,

199

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

}

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

204

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

205

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

206

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

207

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

208

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

209

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

210

211

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

212

213

(% class="box successmessage" %)

214

(((

215

**POST /api/v3/agents **

216

)))

217

218

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

219

220

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

221

222

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

223

224

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

225

226

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

227

228

{

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

}

Ответ:

{

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

}

272

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

295

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

296

297

(% class="box warningmessage" %)

298

(((

299

**PUT /api/v3/agents**

300

)))

301

302

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

303

304

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

305

306

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

307

308

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

309

310

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

311

312

{

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

}

Ответ:

{

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

}

356

357

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

358

359

(% class="box errormessage" %)

360

(((

361

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

362

)))

363

364

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

365

366

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

367

368

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

369

370

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

371

372

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

373

374

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

375

376

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

377

378

(% class="box warningmessage" %)

379

(((

380

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

381

)))

382

383

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

384

385

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

386

387

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

Ответ: Code 204

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

392

393

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

394

395

(% class="box successmessage" %)

396

(((

397

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

398

)))

399

400

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

401

402

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

403

404

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

405

406

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

407

408

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

409

410

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

411

{

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

"doubleAuth":

428

{

429

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

430

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

},

"groups":

[

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

],

"customGroups":

[

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

439

],

440

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

441

}

442

{

443

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

444

"lastName": "string",

445

"firstName": "string",

446

"position": "string",

447

"phone": "string",

448

"organization": "string",

449

"login": "string",

450

"password": "string",

451

"email": "string",

452

453

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

454

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

455

{

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

}

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

477

478

(% class="box infomessage" %)

479

(((

480

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

481

)))

482

483

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

484

485

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

486

487

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

488

489

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

490

491

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

492

493

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

494

495

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

496

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

497

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

498

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

499

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

500

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

501

502

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

503

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

520

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

521

522

(% class="box infomessage" %)

523

(((

524

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

525

)))

526

527

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

528

529

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

530

531

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

532

533

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

534

535

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

(((

(((

{

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

"doubleAuth":

555

{

556

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

557

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

558

},

559

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

560

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

561

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

562

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

563

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

564

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

565

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

566

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

567

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

}

)))

)))

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

573

574

(% class="box warningmessage" %)

575

(((

576

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

577

)))

578

579

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

580

581

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

582

583

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

584

585

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

586

587

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

588

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

589

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

"doubleAuth":

609

{

610

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

611

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

612

},

613

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

614

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

615

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

616

617

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

618

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

619

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

"doubleAuth":

636

{

637

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

638

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

639

},

640

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

641

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

642

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

643

}

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

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

666

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

667

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

668

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

669

670

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

671

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

672

673

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

674

675

(% class="box warningmessage" %)

676

(((

677

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

678

)))

679

680

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

681

682

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

683

684

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

685

686

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

687

688

[

689

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

690

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

691

]

692

693

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

694

695

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

696

697

(% class="box warningmessage" %)

698

(((

699

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

700

)))

701

702

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

703

704

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

705

706

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

707

708

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

709

710

[

711

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

712

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

713

]

714

715

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

716

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

(((

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

{

"errorMessages": [

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

723

],

724

"users": [

725

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

726

]

727

}

728

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

729

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

730

)))

731

732

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

733

734

(% class="box errormessage" %)

735

(((

736

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

737

)))

738

739

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

740

741

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

742

743

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

744

745

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

746

747

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

748

749

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

750

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

751

752

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

753

754

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

755

756

(% class="box infomessage" %)

757

(((

758

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

759

)))

760

761

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

762

763

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

764

765

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

766

767

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

768

769

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

770

771

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

772

773

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

774

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

781

"hoppercapacity": 0,

782

"hopperdischargespeed": 0,

783

"modelType": 0,

784

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

785

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

804

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

805

806

(% class="box successmessage" %)

807

(((

808

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

809

)))

810

811

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

812

813

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

814

815

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

816

817

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

818

819

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

820

821

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

822

}

823

824

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

825

826

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

827

{

828

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

829

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

830

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

837

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

838

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

839

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

840

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

841

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

842

843

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

844

845

(% class="box successmessage" %)

846

(((

847

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

848

)))

849

850

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

851

852

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

853

854

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

855

856

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

857

858

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

859

860

{

861

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

862

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

871

"fueloutlay": 0,

872

"hoppercapacity": 0,

873

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

881

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

890

"hoppercapacity": 0,

891

"hopperdischargespeed": 0,

"modelType": 0

}

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

909

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

910

911

(% class="box warningmessage" %)

912

(((

913

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

914

)))

915

916

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

917

918

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

919

920

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

921

922

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

923

924

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

925

926

{

927

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

928

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

937

"fueloutlay": 0,

938

"hoppercapacity": 0,

939

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

947

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

956

"fueloutlay": 0,

957

"hoppercapacity": 0,

958

"hopperdischargespeed": 0,

"modelType": 0

}

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

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

976

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

977

978

(% class="box errormessage" %)

979

(((

980

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

981

)))

982

983

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

984

985

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

986

987

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

988

989

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

990

991

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

992

993

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

994

995

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

996

997

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

998

999

(% class="box infomessage" %)

1000

(((

1001

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

1002

)))

1003

1004

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

1005

1006

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

1007

1008

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

1009

1010

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

1011

1012

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

1013

1014

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

1015

1016

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

1017

1018

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

1019

1020

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

(((

{

(((

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

1027

"IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства

)))

(((

~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink

1032

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC

1033

)))

1034

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

},

1051

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

1052

{

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

}

1060

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

},

1086

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

},

1094

1095

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

1096

{

1097

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

1098

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

1099

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

1100

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

1101

}

1102

],

1103

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

1104

{

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

{

1118

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

1119

{

1120

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

1121

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

1122

}

1123

],

1124

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

1125

}

1126

],

1127

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

1128

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

1129

"color": "string", ~/~/ Код цвета датчиков

1130

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

1131

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

1132

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

1133

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

1134

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

1135

"string"

1136

],

1137

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

1138

"additionalProp1": "string",

1139

"additionalProp2": "string",

1140

"additionalProp3": "string"

1141

},

1142

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

1155

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

1156

}

1157

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

1158

{

1159

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

1160

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

1161

"description": "string",

1162

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

1163

}

1164

],

1165

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

1166

{

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

}

1180

],

1181

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

1182

{

1183

"status": 0,

1184

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

1185

"description": "string",

1186

"additionalInfo": "string"

(((

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1192

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.

)))

(((

~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов

}

)))

)))

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

1203

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

1204

1205

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

1206

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

1207

1208

1209

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

1210

1211

(% class="box successmessage" %)

1212

(((

1213

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

1214

)))

1215

1216

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

1217

1218

{

1219

"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)

1220

"command": "", ~/~/ Текст отправляемой команды

1221

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

1222

"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов).

1223

}

1224

1225

В ответ получаем cmdid

1226

1227

1228

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

1229

1230

(% class="box infomessage" %)

1231

(((

1232

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

1233

)))

1234

1235

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

1236

1237

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

1238

1239

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

1240

1241

ID= "" ~/~/ идентификатор объекта

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

1250

(((

1251

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

1252

1253

(% class="box infomessage" %)

1254

(((

1255

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

1256

)))

1257

1258

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

1259

1260

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

1261

1262

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

[

{

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

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

}

]

)))

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

1278

1279

(% class="box successmessage" %)

1280

(((

1281

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

1282

)))

1283

1284

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

1285

1286

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

1287

1288

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

1289

1290

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

1291

1292

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

1293

1294

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

(((

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

1299

)))

1300

1301

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

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

"mileageCalcMethod": 0,

1322

"mileageCoeff": 0,

1323

"locationByCellId": true,

1324

"dottedLineTrackWhenNoCoords": true,

1325

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

1326

{

1327

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

1328

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

1329

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

1330

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

1331

},

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

},

1339

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

1340

{

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

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

1351

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

1352

}

1353

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

1354

{

1355

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

"isDefault": true

}

],

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

1360

{

1361

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1368

{

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

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

1376

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

1377

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

1378

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

1379

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

1380

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

1381

{

1382

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

1383

{

1384

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

1385

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

1386

}

1387

],

1388

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

1389

}

1390

],

1391

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

1392

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

1393

"color": "string", ~/~/ код цвета датчиков

1394

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

1395

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

1396

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

1397

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

1398

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

1399

"string"

1400

],

1401

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

1402

"additionalProp1": "string",

1403

"additionalProp2": "string",

1404

"additionalProp3": "string"

1405

},

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

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

1415

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

1416

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

1417

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

1418

"summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.

1419

1420

(((

1421

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1422

{

1423

"from": 0, ~/~/ С какого значения

1424

"color": "string", ~/~/ Каким цветом

1425

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

)))

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1433

1434

1435

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

1436

{

1437

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1438

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

1439

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

1440

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

1441

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

1442

"forReport": true ~/~/ Отобразить произвольное поле в отчете

(((

}

],

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.

)))

(((

~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов

}

)))

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

(((

(((

(((

{

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

1464

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС

1465

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

1466

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

1467

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

1468

"modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели

1469

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

1470

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

1471

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

1472

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

1473

"consumptionPerHour": 0, ~/~/ Расход топлива на моточас

1474

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

1475

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

1476

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

1477

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

1478

"consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1479

"consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1480

"consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1481

"consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1482

"consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1483

"consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1484

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)

1485

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

1486

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

1487

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

1488

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

1489

"counters": { ~/~/ Dto для состояний счётчиков

1490

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

1491

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

1492

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

1493

"motohours": 0 ~/~/ Моточасы

1494

},

1495

"cmsv6Parameters": { ~/~/ Dto для CMSv6

1496

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

1497

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

1498

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1499

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

1500

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

1501

},

1502

"inspectionTasks": [ ~/~/ Dto для описания задачи на ТО

1503

{

1504

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

1505

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

1506

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

1507

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

1508

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

1509

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

1510

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

1511

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

1512

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

1513

"kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)

1514

"lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО

1515

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

1516

}

1517

],

1518

"drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.

1519

{

1520

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

1521

"inputNumber": 0, ~/~/ № входа.

1522

"createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.

1523

"comment": "string", ~/~/ Комментарий

1524

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

1525

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

1526

"beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.

1527

"endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.

1528

}

1529

],

1530

"commandTemplates": [ ~/~/ Список шаблонов команд

1531

{

1532

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

1533

"name": "string", ~/~/ Название шаблона команд

1534

"command": "string", ~/~/ Команда на выполнение

1535

"retries": 0 ~/~/ Лимит попыток отправки

1536

}

1537

],

1538

"sensors": [ ~/~/ Список датчиков

1539

{

1540

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

1541

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

1542

"type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed

1543

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

1544

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

1545

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

1546

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

1547

"medianDegree": 0, ~/~/ Степень медианной фильтрации

1548

"isInverted": true, ~/~/ Признак инверсии

1549

"disabled": true, ~/~/ Датчик не участвует в обработке

1550

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1551

"gradesTables": [ ~/~/ Тарировка

1552

{

1553

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

1554

{

1555

"input": 0, ~/~/ Вход

1556

"output": 0 ~/~/ Выход

1557

}

1558

],

1559

"relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

1560

}

1561

],

1562

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

1563

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

1564

"color": "string", ~/~/ код цвета датчиков

1565

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

1566

"showWithoutIgn": true, ~/~/ Отображать без включенного зажигания

1567

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

1568

"expr": "string", ~/~/ Выражение

1569

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

"string"

],

"customParams": {

"additionalProp1": "string",

1574

"additionalProp2": "string",

1575

"additionalProp3": "string"

1576

},

1577

"summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.

1578

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1579

{

1580

"from": 0, ~/~/ С какого значения

1581

"color": "string", ~/~/ Каким цветом

)))

(((

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1591

"customFields": [ ~/~/ Список произвольных полей

1592

{

1593

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1594

"name": "string", ~/~/ Наименование произвольного поля

1595

"value": "string", ~/~/ Значение произвольного поля

1596

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

1597

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

1598

"forReport": true ~/~/ Отобразить произвольное поле в отчете

1599

}

1600

],

1601

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов

}

)))

)))

)))

**Валидация:**

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1610

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1611

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1612

1613

1614

== **Импортировать историю ТС (Асинхронный запрос)** ==

1615

1616

(% class="box successmessage" %)

1617

(((

1618

**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **

1619

)))

1620

1621

Метод запроса: **POST**

1622

1623

URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **

1624

1625

Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства

Ответ:

{

"RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса

1633

1634

"Status": 0, ~/~/ Перечисление состояний выполнения запроса

1635

1636

~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)

1637

1638

"Message": "string", ~/~/ Информация о выполнении запроса

1639

1640

"ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)

1641

1642

"ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress

1643

1644

"Data": "string" ~/~/ Данные

}

== **Возвращает статус асинхронного запроса импорта истории ТС** ==

1650

1651

(% class="box infomessage" %)

1652

(((

1653

**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**

1654

)))

1655

1656

Метод запроса: **GET**

1657

1658

URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**

1659

1660

Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса

Ответ:

{

"RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса

1668

1669

"Status": 0, ~/~/ Перечисление состояний выполения запроса

1670

~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest

1671

1672

"Message": "string", ~/~/ Информация о выполнении запроса

1673

1674

"ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса

1675

1676

~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None

1677

1678

"ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress

1679

1680

"Data": "string" ~/~/ Данные

}

== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==

1686

1687

(% class="box infomessage" %)

1688

(((

1689

(% lang="en-US" %)**POST /api/v3/vehicles/find**

1690

)))

1691

1692

(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

1693

1694

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:

1695

1696

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

1697

1698

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

1699

1700

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

1701

1702

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

1703

1704

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

1705

1706

(% style="color:#000000" %)Метод запроса: **POST**

1707

1708

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

1709

1710

(% style="color:#000000" %)В заголовках запроса:

1711

1712

(% style="color:#000000" %)− Content-Type: __**application/json**__

1713

1714

(% style="color:#000000" %)− X-Auth: Токен авторизации

1715

1716

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1717

1718

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1719

1720

{

1721

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1722

"name": null, ~/~/ Имя ТС (string, опционально)

1723

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1724

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1725

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1726

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)

1727

"unitName": "string", ~/~/ Название подразделения (опционально)

1728

"customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)

1729

"vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)

1730

"vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)

1731

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные

1732

}

1733

1734

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1735

1736

(% style="color:#000000" %)Ответ:

1737

1738

(% style="color:#000000" %)[

{

(((

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC

)))

(((

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1747

"name": "" ~/~/ наименование объекта

1748

"imei": "" ~/~/ IMEI объекта

1749

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1750

"deviceTypeName": "" ~/~/ наименование типа устройства

1751

"sim1": "" ~/~/ первый номер телефона

1752

"sim2": "" ~/~/ второй номер телефона

1753

"parentId": "" ~/~/ идентификатор клиента-родителя

1754

"parentName": "" ~/~/ наименование клиента-родителя

1755

"modelId": "" ~/~/ идентификатор модели объекта

1756

"modelName": "" ~/~/ наименование модели объекта

1757

"unitId": "" ~/~/ идентификатор подразделения

1758

"unitName": "" ~/~/ наименование подразделения

1759

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1760

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1761

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1762

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1763

"customFields": [

1764

{

1765

"id": "", ~/~/ идентификатор произвольного поля

1766

"name": "", ~/~/ имя произвольного поля

1767

"value": "", ~/~/ значение произвольного поля

1768

"forClient": true, ~/~/ право на отображение у клиента

1769

"forTooltip": false, ~/~/ право на отображение в подсказке

1770

"forReport": false ~/~/ право на отображение в отчетах

)))

(((

}

],

"vehicleGroups": [ ~/~/ Группы ТС

1777

{

1778

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1779

"name": "string" ~/~/ Наименование группы ТС

}

]

}

]

)))

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1787

1788

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1789

1790

(% class="box successmessage" %)

1791

(((

1792

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1793

)))

1794

1795

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1796

1797

(% style="color:#000000" %)Метод запроса: **POST**

1798

1799

(% 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}

1800

1801

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1802

1803

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1804

1805

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1806

1807

(% style="color:#000000" %){

1808

1809

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1810

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1811

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1812

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1813

"description": "", ~/~/ Описание

1814

"data": "", ~/~/ Данные

1815

"overwrite": false, ~/~/ Флаг перезаписи

1816

"stage": "", ~/~/ Состояние, может быть null

1817

(% style="color:#000000" %)}

1818

1819

(% style="color:#000000" %)Ответ:

1820

1821

(% style="color:#000000" %){(%%)

1822

"status": "", ~/~/ значение статуса

1823

"date": "", ~/~/ Дата смены статуса

1824

"description": "", ~/~/ Описание

1825

"data": "", ~/~/ Данные

1826

"overwrite": false, ~/~/ Флаг перезаписи

1827

"stage": "", ~/~/ Состояние

1828

(% style="color:#000000" %) }

== ==

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1833

1834

(% class="box warningmessage" %)

1835

(((

1836

(% lang="en-US" %)**PUT /api/v3/vehicles**

1837

)))

1838

1839

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1840

1841

(% style="color:#000000" %)Метод запроса: **PUT**

1842

1843

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1844

1845

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1846

1847

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1848

1849

(% style="color:#000000" %){

1850

"vehicleId": , ~/~/ ID объекта

1851

"parentId": "" , ~/~/ ID клиента

1852

"name": "" , ~/~/ имя ТС

1853

"imei": "" , ~/~/ IMEI

1854

"deviceTypeId": "" , ~/~/ ID типа устройства

1855

"modelId": "" , ~/~/ ID модели

1856

"unitId": "" , ~/~/ ID подразделения

1857

"sim1": "" , ~/~/ Номер SIM 1

1858

"sim2": "" , ~/~/ Номер SIM2

1859

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1860

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1861

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1862

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1863

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1864

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1865

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1866

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1867

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1868

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1869

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1870

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1871

1872

"mileageCalcMethod": 0,

1873

"mileageCoeff": 0,

1874

"locationByCellId": true,

1875

"dottedLineTrackWhenNoCoords": true,

1876

"counters": ~/~/ счетчики

1877

{

1878

"mileage": "" , ~/~/ пробег

1879

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1880

"motohours": "" , ~/~/ моточасы

1881

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1882

},

1883

"cmsv6Parameters": { ~/~/ параметры CMSv6

1884

"enabled": true, ~/~/ флаг включения

1885

"id": "" , ~/~/ идентификатор

1886

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1887

"login": "" , ~/~/ имя учетной записи

1888

"password": "" ~/~/ пароль учетной записи

1889

},

1890

"inspectionTasks": ~/~/ задания на ТО

1891

{

1892

"enabled": "" , ~/~/ Признак включения

1893

"name": "" , ~/~/ Имя задания

1894

"description": "" , ~/~/ Описание задания

1895

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1896

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1897

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1898

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1899

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1900

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1901

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1902

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1903

}

1904

1905

"drivers": [ ~/~/ Водители

{

(((

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

1910

"inputNumber": 0, ~/~/ № входа.

1911

"createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.

1912

"comment": "string", ~/~/ Комментарий.

1913

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

1914

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

1915

"beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.

1916

"endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.

)))

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1922

{

1923

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1930

{

1931

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1932

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1933

"type": 0, ~/~/ Тип датчика

1934

"name": "string", ~/~/ Имя датчика

1935

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1936

"inputNumber": 0, ~/~/ Номер входа

1937

"pseudonym": "string", ~/~/ Псевдоним

1938

"medianDegree": 0, ~/~/ Медианная фильтрация

1939

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1940

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1941

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1942

"gradesTables": [ ~/~/ Массив таблиц тарировки

1943

{

1944

"grades": [ ~/~/ Таблица тарировки 1

1945

{

1946

"input": 0, ~/~/ Входящее значение

1947

"output": 0 ~/~/ Выходящее значение

1948

}

1949

],

1950

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1951

}

1952

],

1953

"showInTooltip": true, ~/~/ Отображать в подсказке

1954

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1955

1956

(((

1957

"color": "string",** ~/~/ **Цвет датчика

1958

)))

1959

1960

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1961

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1962

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1963

"expr": "string", ~/~/ Формула

1964

"children": [ ~/~/ массив дочерних датчиков

1965

"string"

1966

],

1967

"customParams": { ~/~/ прочие произвольные параметры

1968

"additionalProp1": "string",

1969

"additionalProp2": "string",

1970

"additionalProp3": "string"

1971

},

1972

~/~/ Характерные для произвольного:

1973

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1974

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1975

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1976

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1977

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1978

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1979

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1980

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1981

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1982

~/~/ "ValueOn": "Вкл.",

1983

~/~/ "ValueOff": "Выкл."

1984

"summaryMaxValue": 0 ~/~/ Макс. значение

1985

1986

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1987

{

1988

"from": 0, ~/~/ С какого значения

1989

"color": "string", ~/~/ Каким цветом

1990

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1996

1997

"customFields": [ ~/~/ Произвольные поля

1998

{

1999

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

2000

"name": "string", ~/~/ Наименование произвольного поля

2001

"value": "string", ~/~/ Значение произвольного поля

2002

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

2003

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

2004

"forReport": true ~/~/ Отобразить произвольное поле в отчете

}

(((

],

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов

)))

}

(% style="color:#000000" %)Ответ:

(((

{

"vehicleId": 0, ~/~/ ID ТС

2020

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС

2021

"name": "string", ~/~/ Имя объекта

2022

"imei": "string", ~/~/ IMEI

2023

"deviceTypeId": 0, ~/~/ ID типа устройства

2024

"modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели

2025

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения

2026

"sim1": "string", ~/~/ SIM1

2027

"sim2": "string", ~/~/ SIM2

2028

"consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км

2029

"consumptionPerHour": 0, ~/~/ Расход топлива на моточас

2030

"consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу

2031

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

2032

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

2033

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

2034

"consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

2035

"consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

2036

"consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

2037

"consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

2038

"consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

2039

"consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

2040

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor

2041

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

2042

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

2043

"dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.

2044

"showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.

2045

"counters": { ~/~/ состояний счётчиков

2046

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

2047

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

2048

"mileage": 0, ~/~/ Пробег

2049

"motohours": 0 ~/~/ Моточасы

2050

},

2051

"cmsv6Parameters": { ~/~/ Dto для CMSv6

2052

"id": "string", ~/~/ CMSV6 Идентификатор

2053

"enabled": true, ~/~/ Признак включения

2054

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6.

)))

(((

~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

2060

"login": "string", ~/~/ CMSV6 имя учетной записи

2061

"password": "string" ~/~/ CMSV6 — пароль учетной записи

2062

},

2063

"inspectionTasks": [ ~/~/ Задания на ТО

2064

{

2065

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи

2066

"enabled": true, ~/~/ Признак включения

2067

"name": "string", ~/~/ Имя задания

2068

"description": "string", ~/~/ Описание задания

2069

"mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)

2070

"lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО

2071

"motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)

2072

"lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО

2073

"periodicCondition": 0, ~/~/ Условие периодичности по времени

2074

"kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы

2075

"lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО

2076

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

2077

}

2078

],

2079

"drivers": [ ~/~/ Список водителей

2080

{

2081

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

2082

"inputNumber": 0, ~/~/ № входа.

2083

"createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.

2084

"comment": "string", ~/~/ Комментарий.

2085

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

2086

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

2087

"beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.

2088

"endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.

2089

}

2090

],

2091

"commandTemplates": [ ~/~/ Список шаблонов команд

2092

{

2093

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

2094

"name": "string", ~/~/ Название шаблона команд

2095

"command": "string", ~/~/ Команда на выполнение

2096

"retries": 0 ~/~/ Лимит попыток отправки

2097

}

2098

],

2099

"sensors": [ ~/~/ Список датчиков

2100

{

2101

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

2102

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

2103

"type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,

)))

(((

~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,

)))

(((

~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,

)))

(((

~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,

)))

(((

~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,

)))

(((

~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed

2124

"name": "string", ~/~/ Имя датчика

2125

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,

)))

(((

~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

2130

"inputNumber": 0, ~/~/ Номер входа

2131

"pseudonym": "string", ~/~/ Псевдоним

2132

"medianDegree": 0, ~/~/ Степень медианной фильтрации

2133

"isInverted": true, ~/~/ Признак инверсии

2134

"disabled": true, ~/~/ Датчик не участвует в обработке

2135

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

2136

"gradesTables": [ ~/~/ Тарировка

2137

{

2138

"grades": [ ~/~/ Таблицы тарировки

2139

{

2140

"input": 0, ~/~/ Вход

2141

"output": 0 ~/~/ Выход

2142

}

2143

],

2144

"relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

2145

}

2146

],

2147

"showInTooltip": true, ~/~/ Отображение в подсказке

2148

"showLastValid": true, ~/~/ Отображать последнее валидное значение

2149

2150

(((

2151

"color": "string", ~/~/ цвет уведомлений

2152

)))

2153

2154

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

2155

"showWithoutIgn": true, ~/~/ Отображать без включенного зажигания

2156

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

2157

"expr": "string", ~/~/ Выражение

2158

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

2159

"string"

2160

],

2161

"customParams": { ~/~/ Дополнительные настройки

2162

"additionalProp1": "string",

2163

"additionalProp2": "string",

2164

"additionalProp3": "string"

2165

},

2166

"summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.

2167

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

2168

{

2169

"from": 0, ~/~/ С какого значения

2170

"color": "string", ~/~/ Каким цветом

2171

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

2177

"customFields": [ ~/~/ Список произвольных полей

2178

{

2179

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

2180

"name": "string", ~/~/ Наименование произвольного поля

2181

"value": "string", ~/~/ Значение произвольного поля

2182

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

2183

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

2184

"forReport": true ~/~/ Отобразить произвольное поле в отчете

2185

}

2186

],

2187

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor

}

)))

**Валидация:**

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

2193

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

2194

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

2195

2196

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

2197

2198

(% class="box errormessage" %)

2199

(((

2200

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

2201

)))

2202

2203

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

2204

2205

(% style="color:#000000" %)Метод запроса: **DELETE**

2206

2207

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

2208

2209

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

2210

2211

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2212

2213

(% style="text-align:left" %)

2214

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

2215

2216

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

2217

2218

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

2219

2220

(% class="box infomessage" %)

2221

(((

2222

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

2223

)))

2224

2225

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

2226

2227

(% style="color:#000000" %)Метод запроса: **GET**

2228

2229

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

2230

2231

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2232

2233

(% style="color:#000000" %)Ответ:

2234

2235

(% style="color:#000000" %){(%%)

2236

"deviceTypeId" : "", ~/~/ ID типа устройства

2237

"deviceTypeName" : "" ~/~/ Название типа устройства

2238

(% style="color:#000000" %)}

2239

2240

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

2241

2242

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

2243

2244

(% class="box infomessage" %)

2245

(((

2246

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

2247

)))

2248

2249

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

2250

2251

(% style="color:#000000" %)Метод запроса: **GET**

2252

2253

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

2254

2255

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2256

2257

(% style="color:#000000" %)Ответ:

2258

2259

(% style="color:#000000" %){(%%)

2260

"id": "", ~/~/ ID типа датчика

2261

"name": "", ~/~/ Название

2262

"description": "", ~/~/ Описание

2263

(% style="color:#000000" %)}

2264

2265

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

2266

2267

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

2268

2269

(% class="box infomessage" style="text-align: left;" %)

2270

(((

2271

**POST /api/v3/terminalMessages/count**

2272

)))

2273

2274

(% style="text-align: left;" %)

2275

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

2276

2277

(% style="text-align: left;" %)

2278

Метод запроса **POST**

2279

2280

(% style="text-align: left;" %)

2281

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

2282

2283

(% style="text-align: left;" %)

2284

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2285

2286

(% style="text-align: left;" %)

2287

{

2288

"vehicleIds": [

2289

id ~/~/ здесь передается список идентификаторов объектов

2290

],

2291

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

2292

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

2293

}

2294

2295

(% style="text-align: left;" %)

2296

Ответ:

2297

2298

(% style="text-align: left;" %)

2299

[

2300

{

2301

"vehicleId": 0, ~/~/ идентификатор объекта

2302

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

2307

2308

(% class="box infomessage" style="text-align: left;" %)

2309

(((

2310

**POST /api/v3/terminalMessages/mapping**

2311

)))

2312

2313

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

2314

2315

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

2316

2317

(% 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);" %)**Описание**

2325

|protocolType|ID типа протокола

2326

|params|(((

2327

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

2347

|protocolType|Тип протокола

2348

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2354

Перечень 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/]]

2355

2356

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2357

2358

(% class="box infomessage" %)

2359

(((

2360

**POST /api/v3/terminalMessages**

2361

)))

2362

2363

Метод возвращает список сообщений терминала объекта за выбранный период.

2364

2365

(% style="text-align: left;" %)

2366

Метод запроса **POST**

2367

2368

(% style="text-align: left;" %)

2369

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

2370

2371

(% style="text-align: left;" %)

2372

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2373

2374

{

2375

"vehicleId": 0, ~/~/ id объекта

2376

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2377

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2378

}

2379

2380

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2381

|vehicleId|ID объекта

2382

|from|Дата и время начала периода запроса

2383

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2392

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2402

"additionalProp2": "string",

2403

"additionalProp3": "string"

2404

},

2405

"photoCount": 0,

2406

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2414

|deviceTime|Время сообщения терминала

2415

|serverTime|Время когда сообщение поступило на сервер

2416

|speed|Скорость

2417

|altitude|Высота над уровнем моря

2418

|latitude|Широта

2419

|longitude|Долгота

2420

|satellites|Кол-во спутников

2421

|course|Курс

2422

|voltage|Бортовое напряжение

2423

|parameters|Список параметров и их значений

2424

|photoCount|Количество фото

2425

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2426

|protocolType|ID типа протокола

2427

2428

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2429

2430

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2431

2432

(% class="box infomessage" %)

2433

(((

2434

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2435

)))

2436

2437

(% style="color:#000000" %)Метод запроса: **POST**

2438

2439

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2440

2441

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2442

2443

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2448

"vehicleIds": [0], ~/~/ Список ID объектов

2449

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2450

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2451

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2459

"name": "string", ~/~/ Имя ТС

2460

"periods": [ ~/~/ Периоды

2461

{

2462

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2463

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2464

"mileage": 0, ~/~/ Пробег за период, километры

2465

"mileageBegin": 0, ~/~/ Пробег на начало периода, километры

2466

"mileageEnd": 0, ~/~/ Пробег на окончание периода, километры

2467

"motohours": 0, ~/~/ Моточасы за период, секунды

2468

"motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды

2469

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2476

2477

(% class="box infomessage" %)

2478

(((

2479

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2480

)))

2481

2482

(% style="color:#000000" %)Метод запроса: **POST**

2483

2484

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2485

2486

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2487

2488

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2493

"vehicleIds": [0], ~/~/ Список ID объектов

2494

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2495

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2496

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2504

"name": "string", ~/~/ Имя ТС

2505

"periods": [ ~/~/ Периоды

2506

{

2507

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2508

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2509

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2510

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2511

"fuelConsumption": 0, ~/~/ Расход топлива

2512

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

(% class="box warningmessage" %)

2519

(((

2520

Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".

2521

\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".

2522

)))

2523

2524

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2525

2526

(% class="box infomessage" %)

2527

(((

2528

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2529

)))

2530

2531

(% style="color:#000000" %)Метод запроса: **POST**

2532

2533

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2534

2535

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2536

2537

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2542

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2543

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2544

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2552

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2553

"vehicleId": 0, ~/~/ ID объекта

2554

"name": "string", ~/~/ Имя объекта

2555

"model": "string", ~/~/ Модель объекта

2556

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2557

{

2558

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2559

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2560

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2561

"valueFuel": 0, ~/~/ Количество

2562

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2563

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2571

2572

(% class="box infomessage" %)

2573

(((

2574

**POST /api/v3/vehicles/moveStop**

2575

)))

2576

2577

Метод запроса: **POST**

2578

2579

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2580

2581

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2588

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2589

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2590

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2598

"vehicleName": "string", ~/~/ Имя объекта

2599

"moves": [ ~/~/ Событие движения

2600

{

2601

"mileage": 0, ~/~/ Пробег, км

2602

"eventId": 0, ~/~/ Идентификатор события

2603

"eventName": "string", ~/~/ Название события

2604

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2605

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2606

"duration": 0 ~/~/ Продолжительность события, секунд

2607

}

2608

],

2609

"stops": [ ~/~/ События стоянок

2610

{

2611

"address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты

2612

"eventId": 0, ~/~/ Идентификатор события

2613

"eventName": "string", ~/~/ Название события

2614

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2615

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2616

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2624

2625

(% class="box infomessage" %)

2626

(((

2627

**POST /api/v3/vehicles/getlastdata**

2628

)))

2629

2630

Метод запроса: **POST**

2631

2632

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2633

2634

В заголовках запроса: X-Auth: Токен авторизации

2635

2636

2637

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2642

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2643

"vehicleNumber": "string",~/~/Номер объекта.

2644

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2645

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2646

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2647

"speed": 0,~/~/Скорость объекта.

2648

"course": 0,~/~/Курс движения [0;360]

2649

"latitude": 0,~/~/Широта [-90°;90°].

2650

"longitude": 0,~/~/Долгота [-180°;180°].

2651

"address": "string",~/~/Адрес.

2652

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2660

2661

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2662

2663

(% class="box infomessage" %)

2664

(((

2665

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2666

)))

2667

2668

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2669

2670

(% style="color:#000000" %)Метод запроса: **POST**

2671

2672

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2673

2674

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2675

2676

(% style="text-align:left" %)

2677

Тело запроса:

2678

2679

(% style="text-align:left" %)

2680

{

2681

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2682

}

2683

2684

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2690

"name": "string", ~/~/ Название объекта геозоны

2691

"type": 0, ~/~/ Тип объекта геозоны

2692

"fname": "string", ~/~/ Имя файла

2693

"parentId": "string", ~/~/ Идентификатор клиента

2694

"radius": 0, ~/~/ Радиус геообъекта

2695

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2696

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2697

"description": "string", ~/~/ Описание

2698

"area": 0, ~/~/ Площадь, м^^2^^

2699

"perimetr": 0, ~/~/ Периметр, м

2700

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2705

2706

(% class="box infomessage" %)

2707

(((

2708

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2709

)))

2710

2711

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2712

2713

(% style="color:#000000" %)Метод запроса: **POST**

2714

2715

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2716

2717

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2718

2719

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2724

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2725

"ids": [ ], ~/~/ Массив id объектов

2726

"byTime": 0, ~/~/ Объединение событий по времени

2727

"byDist": 0, ~/~/ Объединение событий по расстоянию

2728

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2729

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2736

"geozoneName": "string", ~/~/ Название геообъекта

2737

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2738

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2739

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2740

"vehicleId": 0, ~/~/ ID объекта

2741

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2746

2747

(% class="box infomessage" %)

2748

(((

2749

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2750

)))

2751

2752

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2753

2754

(% style="color:#000000" %)Метод запроса: **POST**

2755

2756

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2757

2758

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2759

2760

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2765

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2766

"ids": [ ], ~/~/ Массив id геообъектов

2767

"byTime": 0, ~/~/ Объединение событий по времени

2768

"byDist": 0, ~/~/ Объединение событий по расстоянию

2769

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2770

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2778

"geozoneName": "string", ~/~/ Название геообъекта

2779

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2780

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2781

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2782

"vehicleId": 0, ~/~/ ID объекта

2783

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2788

2789

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2790

2791

(% class="box infomessage" %)

2792

(((

2793

**POST /api/v3/notifications/find**

2794

)))

2795

2796

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2797

2798

(% style="text-align: left;" %)

2799

Метод запроса **POST**

2800

2801

(% style="text-align: left;" %)

2802

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2803

2804

(% style="text-align: left;" %)

2805

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2806

2807

{

2808

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2816

"name": "string", ~/~/ Название уведомления

2817

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2818

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2819

"userId": "", ~/~/ Пользователь, создавший уведомление

2820

"parentId": "", ~/~/ Идентификатор клиента

2821

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2826

2827

(% class="box infomessage" %)

2828

(((

2829

**GET /api/v3/notifications/{id}**

2830

)))

2831

2832

Метод возвращает данные правил формирования выбранного уведомления.

2833

2834

(% style="text-align: left;" %)

2835

Метод запроса **GET**

2836

2837

(% style="text-align: left;" %)

2838

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2839

2840

(% style="text-align: left;" %)

2841

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2842

2843

(% style="text-align: left;" %)

2844

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2845

2846

(% style="text-align: left;" %)

2847

(% style="color:#000000" %)Ответ:

2848

2849

(% style="text-align: left;" %)

2850

(% style="color:#000000" %){

2851

"id": 0, ~/~/ (%%)id уведомления

2852

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2853

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2854

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2855

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2856

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2857

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2858

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2859

(% style="color:#000000" %) 0

2860

],

2861

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2862

(% style="color:#000000" %) 0

2863

],

2864

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2865

(% style="color:#000000" %) 0

2866

],

2867

"settings": { ~/~/ Список параметров уведомления

2868

"additionalProp1": "string",

2869

"additionalProp2": "string",

2870

"additionalProp3": "string"

2871

},

2872

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2873

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2874

(% style="color:#000000" %) ""

2875

],

2876

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2877

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2878

(% style="color:#000000" %) "string"

2879

],

2880

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2881

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2882

(% style="color:#000000" %) {

2883

"id": 0, ~/~/ (%%)Идентификатор участника чата

2884

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2885

(% style="color:#000000" %) }

2886

],

2887

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2888

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2889

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2890

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2891

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2892

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2893

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2894

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2895

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2896

(% style="color:#000000" %)}

2897

2898

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2899

2900

(% class="box warningmessage" %)

2901

(((

2902

**PUT /api/v3/notifications/**

2903

)))

2904

2905

Метод позволяет отредактировать уведомление.

2906

2907

Метод запроса **PUT**

2908

2909

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2910

2911

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2916

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2917

"userId": "", ~/~/ Пользователь, создавший уведомление

2918

"parentId": "", ~/~/ Идентификатор клиента

2919

"parentName": "string", ~/~/ Имя клиента

2920

"name": "string", ~/~/ Название уведомления

2921

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2922

"vehicleIds": [ ~/~/ Список id объектов для анализа

2923

0

2924

],

2925

"geoids": [ ~/~/ Список id геообъектов для анализа

2926

0

2927

],

2928

"fieldids": [ ~/~/ Список id полей для анализа

2929

0

2930

],

2931

"settings": { ~/~/ Список параметров уведомления

2932

"additionalProp1": "string",

2933

"additionalProp2": "string",

2934

"additionalProp3": "string"

2935

},

2936

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2937

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2938

""

2939

],

2940

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2941

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2942

"string"

2943

],

2944

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2945

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2946

{

2947

"id": 0, ~/~/ Идентификатор участника чата

2948

"info": "string" ~/~/ Дополнительные сведения

2949

}

2950

],

2951

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2952

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2953

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2954

"kind": 0, ~/~/ Определяет вид уведомления

2955

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2956

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2957

"timezone": 0, ~/~/ Сдвиг часового пояса

2958

"validity": 0, ~/~/ Срок действия в днях (1-90)

2959

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==

2968

2969

(% class="box warningmessage" %)

2970

(((

2971

**PUT** /api/v3/notifications/prolongation

2972

)))

2973

2974

Метод позволяет продлить уведомления.

2975

2976

Метод запроса **PUT**

2977

2978

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation

2979

2980

В заголовках запроса: X-Auth: Токен авторизации.

Тело запроса:

[

0

]

где 0 идентификатор ids.

2991

2992

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2993

2994

(% class="box errormessage" %)

2995

(((

2996

**DELETE /api/v3/notifications/{id}**

2997

)))

2998

2999

Метод позволяет удалить выбранное уведомление.

3000

3001

Метод запроса **DELETE**

3002

3003

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

3004

3005

Передаваемый параметр: {id} - id уведомления

3006

3007

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

3015

3016

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

3017

3018

(% class="box infomessage" %)

3019

(((

3020

**POST /api/v3/Drivers/find**

3021

)))

3022

3023

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

3030

"description": "string", ~/~/ Определяет описание

3031

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

3032

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

3033

"exclusive": true, ~/~/ Определяет признак "Исключительный"

3034

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

3035

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

3036

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

3041

3042

(% class="box infomessage" %)

3043

(((

3044

**GET /api/v3/Drivers/{driverGuid}**

3045

)))

3046

3047

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

3053

"description": "string", ~/~/ Определяет описание

3054

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

3055

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

3056

"exclusive": true, ~/~/ Определяет признак "Исключительный"

3057

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

3058

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

3059

"deleted": true ~/~/ Признак удаления

3060

}

3061

3062

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

3063

3064

(% class="box successmessage" %)

3065

(((

3066

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

3074

"hiredate": "2023-06-30T12:50:54.020Z",

3075

"chopdate": "2023-06-30T12:50:54.020Z",

3076

"exclusive": true,

3077

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3078

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

3087

"hiredate": "2023-06-30T12:50:54.051Z",

3088

"chopdate": "2023-06-30T12:50:54.051Z",

3089

"exclusive": true,

3090

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3091

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

3097

3098

(% class="box warningmessage" %)

3099

(((

3100

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

3108

"hiredate": "2023-06-30T12:50:27.910Z",

3109

"chopdate": "2023-06-30T12:50:27.910Z",

3110

"exclusive": true,

3111

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3112

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

3121

"hiredate": "2023-06-30T12:50:27.929Z",

3122

"chopdate": "2023-06-30T12:50:27.929Z",

3123

"exclusive": true,

3124

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3125

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

3131

3132

(% class="box errormessage" %)

3133

(((

3134

**DELETE /api/v3/Drivers/{driverGuid}**

3135

)))

3136

3137

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

3145

3146

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

3147

3148

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

3149

3150

(% class="box infomessage" %)

3151

(((

3152

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3160

],

3161

"BeginTime": "2023-06-30T12:49:04.365Z",

3162

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

3171

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3172

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3173

"BeginTime": "2023-06-30T09:52:31.240Z",

3174

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

3180

3181

(% class="box infomessage" %)

3182

(((

3183

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

3193

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

3202

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3203

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3204

"BeginTime": "2023-06-30T09:54:01.631Z",

3205

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

3211

3212

(% class="box successmessage" %)

3213

(((

3214

**POST /api/v3/DriversVehiclesAssignments**

3215

)))

3216

3217

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

3224

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

3225

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3226

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

3227

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

3237

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3238

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3239

"BeginTime": "2023-06-30T11:04:46.903Z",

3240

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

3246

3247

(% class="box warningmessage" %)

3248

(((

3249

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

3258

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3259

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3260

"BeginTime": "2023-06-30T11:14:08.117Z",

3261

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

3271

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3272

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3273

"BeginTime": "2023-06-30T11:14:53.349Z",

3274

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

3280

3281

(% class="box errormessage" %)

3282

(((

3283

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

3298

3299

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

3300

3301

(% class="box infomessage" %)

3302

(((

3303

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3311

],

3312

"BeginTime": "2023-06-30T12:47:12.162Z",

3313

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3321

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3322

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3323

"BeginTime": "2023-06-30T11:19:40.703Z",

3324

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

3330

3331

(% class="box infomessage" %)

3332

(((

3333

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3341

],

3342

"BeginTime": "2023-06-30T12:47:12.162Z",

3343

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3351

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3352

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3353

"BeginTime": "2023-06-30T11:19:40.703Z",

3354

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

3360

3361

(% class="box successmessage" %)

3362

(((

3363

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3371

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3372

"BeginTime": "2023-06-30T11:27:08.635Z",

3373

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3382

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3383

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3384

"BeginTime": "2023-06-30T11:27:08.677Z",

3385

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3391

3392

(% class="box warningmessage" %)

3393

(((

3394

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3402

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3403

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3404

"BeginTime": "2023-06-30T11:28:43.330Z",

3405

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3414

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3415

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3416

"BeginTime": "2023-06-30T11:28:43.331Z",

3417

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3423

3424

(% class="box errormessage" %)

3425

(((

3426

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3441

3442

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3443

3444

(% class="box infomessage" %)

3445

(((

3446

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3454

],

3455

"BeginTime": "2023-06-30T12:45:10.852Z",

3456

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3464

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3465

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3466

"BeginTime": "2023-06-30T11:58:04.695Z",

3467

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3473

3474

(% class="box infomessage" %)

3475

(((

3476

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3484

],

3485

"BeginTime": "2023-06-30T12:45:10.852Z",

3486

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3494

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3495

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3496

"BeginTime": "2023-06-30T11:58:04.695Z",

3497

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3503

3504

(% class="box successmessage" %)

3505

(((

3506

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3514

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3515

"BeginTime": "2023-06-30T12:09:53.175Z",

3516

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3525

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3526

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3527

"BeginTime": "2023-06-30T12:09:53.201Z",

3528

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3534

3535

(% class="box warningmessage" %)

3536

(((

3537

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3545

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3546

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3547

"BeginTime": "2023-06-30T12:09:53.201Z",

3548

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3557

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3558

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3559

"BeginTime": "2023-06-30T12:09:53.201Z",

3560

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3566

3567

(% class="box errormessage" %)

3568

(((

3569

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3584

3585

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3586

3587

(% class="box infomessage" %)

3588

(((

3589

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3596

"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);" %)**Описание**

3602

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3603

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3604

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3605

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3612

"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",

3622

"name": "string",

3623

"rid": "string",

3624

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3625

"trailer": {

3626

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3627

"Number": "string",

3628

"Description": "string",

3629

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3630

"ExternalID": "string",

3631

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3632

"CreateTime": "2023-11-14T10:48:03.717Z",

3633

"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);" %)**Описание**

3641

|SD|Дата и время начала события

3642

|ED|Дата и время окончания события

3643

|id|ID объекта

3644

|SLat|Широта начальной координаты

3645

|SLon|Долгота начальной координаты

3646

|ELat|Широта конечной координаты

3647

|ELon|Долгота конечной координаты

3648

|mileage|Пробег

3649

|Duration|Продолжительность

3650

|Address|Адрес начального местоположения

3651

|Address2|Адрес конечного местоположения

3652

|name|Имя радиометки

3653

|rid|Номер радиометки

3654

|rguid|ID радиометки

3655

|trailer|Информация об агрегате

3656

|ModelGuid|ID агрегата

3657

|Number|Название/номер агрегата

3658

|Description|Текст примечания агрегата

3659

3660

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3661

3662

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3663

3664

(% class="box infomessage" %)

3665

(((

3666

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3683

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3688

|parentId|ID клиента

3689

|name|Название карты-метки

3690

|number|Номер

3691

|period|Период запросов в секундах (работает только для агрегатов)

3692

|id|ID карты-метки

3693

3694

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3695

3696

(% class="box infomessage" %)

3697

(((

3698

**GET /api/v3/Rfids/{rfidGuid}**

3699

)))

3700

3701

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3711

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3716

|name|Название карты-метки

3717

|number|Номер

3718

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3723

3724

(% class="box successmessage" %)

3725

(((

3726

**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",

3745

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3746

}

3747

3748

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3749

|name|Название карты-метки

3750

|number|Номер

3751

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3756

3757

(% class="box warningmessage" %)

3758

(((

3759

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3769

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3779

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3780

}

3781

3782

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3783

|name|Название карты-метки

3784

|number|Номер

3785

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3790

3791

(% class="box errormessage" %)

3792

(((

3793

**DELETE /api/v3/Rfids/{rfidGuid}**

3794

)))

3795

3796

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3804

3805

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3806

3807

(% class="box infomessage" %)

3808

(((

3809

**GET /api/v3/Billing/client/balance/{clientId}**

3810

)))

3811

3812

Параметр запроса: **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);" %)**Описание**

3822

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3823

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3824

3825

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3826

3827

(% class="box infomessage" %)

3828

(((

3829

**GET /api/v3/Billing/client/constraint/{clientId}**

3830

)))

3831

3832

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3838

"CalculationType": 0,

3839

"PermissibleBalance": 0,

3840

"DefermentDays": 0,

3841

"SendUiNotifications": true,

3842

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3847

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3848

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3849

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3850

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3851

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3852

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3853

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3854

3855

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3856

3857

(% class="box infomessage" %)

3858

(((

3859

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3865

3866

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3872

"Plan": { **~/~/ Описание тарифного плана**

3873

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3874

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3879

"PermissibleBalance": 0,

3880

"DefermentDays": 0

3881

},

3882

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3894

"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);" %)**Описание**

3910

|ClientId|Идентификатор клиента

3911

|Id|Идентификатор тарифного плана

3912

|OwnerId|Идентификатор клиента-владельца

3913

|Name|Наименование тарифного плана

3914

|IsArchived|Признак, определяющий архивный тарифный план

3915

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3916

|PermissibleBalance|Допустимый баланс

3917

|DefermentDays|Отсрочка, количество дней

3918

|Feature|Код услуги

3919

|IsEnabled|Признак, определяющий активирована ли услуга

3920

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3921

|IsFactual|Признак, определяющий расчёт по факту

3922

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3923

|Price|Цена за единицу.

3924

|DebitDate|Следующий момент времени списания с баланса за услугу.

3925

|PeriodValue|Значение периода.

3926

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3927

3928

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3929

3930

(% class="box infomessage" %)

3931

(((

3932

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3933

)))

3934

3935

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3942

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3947

"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);" %)**Описание**

3964

|ClientId|Идентификатор клиента

3965

|Id|Идентификатор тарифного плана

3966

|OwnerId|Идентификатор клиента-владельца

3967

|Name|Наименование тарифного плана

3968

|IsArchived|Признак, определяющий архивный тарифный план

3969

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3970

|PermissibleBalance|Допустимый баланс

3971

|DefermentDays|Отсрочка, количество дней

3972

|Feature|Код услуги

3973

|IsFactual|Признак, определяющий расчёт по факту

3974

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3975

|Price|Цена за единицу.

3976

|PeriodValue|Значение периода.

3977

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3978

3979

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3980

3981

(% class="box infomessage" %)

3982

(((

3983

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3984

)))

3985

3986

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3993

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3998

"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);" %)**Описание**

4015

|ClientId|Идентификатор клиента

4016

|Id|Идентификатор тарифного плана

4017

|OwnerId|Идентификатор клиента-владельца

4018

|Name|Наименование тарифного плана

4019

|IsArchived|Признак, определяющий архивный тарифный план

4020

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

4021

|PermissibleBalance|Допустимый баланс

4022

|DefermentDays|Отсрочка, количество дней

4023

|Feature|Код услуги

4024

|IsFactual|Признак, определяющий расчёт по факту

4025

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

4026

|Price|Цена за единицу.

4027

|PeriodValue|Значение периода.

4028

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

4029

4030

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

4031

4032

(% class="box warningmessage" %)

4033

(((

4034

**PUT /api/v3/Billing/client/balance**

4035

)))

4036

4037

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

4049

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

4050

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

4051

4052

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

4053

4054

(% class="box warningmessage" %)

4055

(((

4056

**PUT /api/v3/billing/client/balance/deposit**

4057

)))

4058

4059

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

4071

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

4072

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

4073

4074

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

4075

4076

Создает операцию **Списание **с указанной суммой

4077

4078

(% class="box warningmessage" %)

4079

(((

4080

**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);" %)**Описание**

4093

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

4094

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

4095

4096

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

4097

4098

(% class="box warningmessage" %)

4099

(((

4100

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4107

"CalculationType": 0,

4108

"PermissibleBalance": 0,

4109

"DefermentDays": 0,

4110

"SendUiNotifications": true,

4111

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4118

|ClientId|Идентификатор клиента

4119

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

4120

|PermissibleBalance|Допустимый баланс

4121

|DefermentDays|(((

4122

Отсрочка, количество дней

4123

)))

4124

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

4125

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

4126

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

4127

4128

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

4129

4130

(% class="box warningmessage" %)

4131

(((

4132

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4139

"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);" %)**Описание**

4157

|ClientId|Идентификатор клиента

4158

|PlanId|Идентификатор тарифного плана

4159

|Feature|Код услуги

4160

|IsEnabled|Признак, определяющий активирована ли услуга

4161

|IsFactual|Признак, определяющий расчёт по факту

4162

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

4163

|Price|Цена за единицу.

4164

|DebitDate|Следующий момент времени списания с баланса за услугу.

4165

|PeriodValue|Значение периода.

4166

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

4167

4168

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

4169

4170

(% class="box warningmessage" %)

4171

(((

4172

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

4173

)))

4174

4175

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

4176

4177

(% class="box infomessage" %)

4178

(((

4179

**POST /api/v3/vehicles/import/{agentId}**

4180

)))

4181

4182

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

4183

4184

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4193

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

4194

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

4195

4196

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4201

|data|В значении передаем файл объекта, формат **xml** или **wlp **

4202

|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);" %)**Описание**

4213

|vehicleId|ID созданного объекта

4214

|name|Имя созданного объекта

4215

|errors|Ошибки и их описание

4216

4217

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

4218

4219

(% class="box infomessage" %)

4220

(((

4221

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

4222

)))

4223

4224

(% class="wikigeneratedid" %)

4225

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

4226

4227

(% class="wikigeneratedid" %)

4228

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

4233

4234

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4239

|**history**|В значении передавать файл с историей

4240

4241

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

4254

"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);" %)**Описание**

4262

|results|Результаты импорта в разрезе ТС

4263

|vehicleGuid|Guid ТС

4264

|vehicleId|ID ТС

4265

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

4266

|firstMessageDate|Дата первого импортированного сообщения (UTC)

4267

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

4268

|producedCount|Кол-во успешно отправленных в шину данных сообщений

4269

|msgCount|Кол-во обработанных сообщений всего

4270

4271

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

4272

4273

(% class="box infomessage" %)

4274

(((

4275

**GET /api/v3/vehicles/import/history/status**

4276

)))

4277

4278

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4289

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

4290

|progress|Guid ТС

4291

4292

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

4293

4294

(% class="box infomessage" %)

4295

(((

4296

**POST /api/v3/vehicles/export**

4297

)))

4298

4299

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

4308

4309

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

4310

4311

(% class="box infomessage" %)

4312

(((

4313

**POST /api/v3/vehicles/export/history**

4314

)))

4315

4316

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4324

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4330

4331

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4332

|vehicleId|ID объекта

4333

|asArchive|true - Архивировать файл, False - не архивировать

4334

|from|Дата и время начала запроса

4335

|to|Дата и время окончания запроса

4336

4337

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4338

4339

(% class="box infomessage" %)

4340

(((

4341

**GET /api/v3/vehicles/export/history/status**

4342

)))

4343

4344

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4355

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4356

|progress|Прогресс экспорта, от 0 до 100%

4357

|message|Текст описывающий статус

4358

4359

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4360

4361

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4362

4363

(% class="box infomessage" %)

4364

(((

4365

**POST /api/v3/EcoDriving/rating**

4366

)))

4367

4368

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId], ~/~/Массив ID объектов

4374

"from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса

4375

"to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса

}

Ответ:

{

"items": [ ~/~/ Список в разрезе ТС

4382

{

4383

"from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода

4384

"to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода

4385

"vehicleId": 0, ~/~/ ID ТС

4386

"vehicleName": "string", ~/~/ Название ТС

4387

"vehicleModel": "string", ~/~/ Модель ТС

4388

"penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС

4389

"score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС

4390

"totalViolations": 0, ~/~/ Нарушений всего

4391

"violationsByType": { ~/~/ Информация о нарушениях по типу

4392

"overspeedingViolations": 0, ~/~/ Нарушений превышения скорости

4393

"accelerationViolations": 0, ~/~/ Нарушений ускорения

4394

"brakingViolations": 0, ~/~/ Нарушений торможения

4395

"turningViolations": 0, ~/~/ Нарушений опасного поворота

4396

"dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения

4397

"sensorViolations": 0 ~/~/ Нарушений по датчику

},

(((

)))

"moveTime": 0, ~/~/ Продолжительность движения, сек

4405

"mileage": 0, ~/~/ Пробег, м

4406

"tripsCount": 0, ~/~/ Кол-во рейсов

4407

"trips": [ ~/~/ Информация по рейсу

4408

{

4409

"penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс

4410

"score": 0, ~/~/ Рассчитанная оценка вождения за рейс

4411

"violationsCount": 0, ~/~/ Всего нарушений

4412

"violationsByType": { ~/~/ Информация о нарушениях по типу

4413

"overspeedingViolations": 0, ~/~/ Нарушений превышения скорости

4414

"accelerationViolations": 0, ~/~/ Нарушений ускорения

4415

"brakingViolations": 0, ~/~/ Нарушений торможения

4416

"turningViolations": 0, ~/~/ Нарушений опасного поворота

4417

"dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения

4418

"sensorViolations": 0 ~/~/ Нарушений по датчику

4419

},

4420

4421

"startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки

4422

"endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки

4423

"moveTime": 0, ~/~/ Продолжительность движения, сек

4424

"mileage": 0, ~/~/ Пробег, м

4425

"motohours": 0, ~/~/ Моточасы, секунды

4426

"maxSpeed": 0, ~/~/ Максимальная скорость за рейс

4427

"startAddress": "string", ~/~/ Адрес начала рейса

4428

"endAddress": "string", ~/~/ Адрес конца рейса

4429

"drivers": [ ~/~/ Список водителей

4430

{

4431

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя

4432

"driverName": "string", ~/~/ФИО водителя

4433

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки

}

]

}

]

}

]

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4443

4444

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4445

4446

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4447

4448

(% class="box infomessage" %)

4449

(((

4450

**POST /api/v3/fuelcards/transactions**

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4456

\\В заголовках запроса: X-Auth: Токен авторизации

4457

4458

Параметры в теле запроса (JSON):

4459

4460

{

4461

"startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода

4462

"endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода

4463

"ids": [

4464

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт

4465

],

4466

"timezone": 0 ~/~/ Часовой пояс

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции

4473

"driver": "string", ~/~/ Водители, привязанные к ТК

4474

"object": "string", ~/~/ Наименование ТС

4475

"amount": 0, ~/~/ Количество топлива

4476

"amountDut": 0, ~/~/ Количество по ДУТ

4477

"amountDiff": 0, ~/~/ Разница, л

4478

"amountDiffPerc": 0, ~/~/ Разница, %

4479

"summa": 0, ~/~/ Стоимость, руб

4480

"serviceName": "string", ~/~/ Тип топлива

4481

"price": 0, ~/~/ Цена за литр, руб

4482

"cardName": "string", ~/~/ Наименование ТК

4483

"cardNum": "string", ~/~/ Номер ТК

4484

"operator": "string", ~/~/ Оператор ТК

4485

"address": "string" ~/~/ Адрес АЗС

4486

}

4487

4488

== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==

4489

4490

(% class="box infomessage" %)

4491

(((

4492

**GET /api/v3/fuelcards**

)))

Метод запроса: GET

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список

Ответ:

[

{

"Name": "string", ~/~/ Определяет наименование карты.

4504

"OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.

4505

"Number": "string", ~/~/ Определяет № карты.

4506

"Enabled": true, ~/~/ Определяет признак активности карты.

4507

"Description": "string", ~/~/ Определяет описание карты.

4508

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты

4509

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

4510

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4515

4516

4517

== **Получение полных данных о ретрансляторе** ==

4518

4519

(% class="box infomessage" %)

4520

(((

4521

**GET ** **/api/v3/retranslations/{id}**

4522

)))

4523

4524

id - Идентификатор ретранслятора

Пример ответа:

{

"description": "", ~/~/ Поле описания ретранслятора

4531

"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)

4532

"protocolType": 0, ~/~/ Тип протокола ретрансляции

4533

"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен

4534

"address": "string", ~/~/ Адрес и порт принимающего сервера

4535

"objects": [ ~/~/ Объекты для ретрансляции

4536

{

4537

"id": "", ~/~/ Идентификатор объекта ретрансляции

4538

"name": "", ~/~/ Наименование объекта ретрансляции

4539

"imei": "", ~/~/ IMEI объекта ретрансляции

4540

"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен

4541

}

4542

],

4543

"id": "", ~/~/ Идентификатор ретранслятора

4544

"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)

4545

"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4550

4551

(% class="box infomessage" %)

4552

(((

4553

**DELETE** **/api/v3/retranslations/{id}**

4554

)))

4555

4556

id - Идентификатор ретранслятора

4557

4558

4559

== **Создание ретранслятора** ==

4560

4561

(% class="box infomessage" %)

4562

(((

4563

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Поле описания ретранслятора

4570

"subscriberId": "", ~/~/ Идентификатор подписчика

4571

"protocolType": 0, ~/~/ Тип протокола ретрансляции

4572

"address": "", ~/~/ Адрес и порт принимающего сервера

4573

"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен

4574

"objects": [ ~/~/Объекты для ретрансляции

4575

{

4576

"id": "", ~/~/ Идентификатор ретранслятора

4577

"imei": "", ~/~/ IMEI объекта ретрансляции

4578

"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен

}

]

}

Ответ:

{

"description": "", ~/~/ Поле описания ретранслятора

4588

"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)

4589

"protocolType": 0, ~/~/ Тип протокола ретрансляции

4590

"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен

4591

"address": "string", ~/~/ Адрес и порт принимающего сервера

4592

"objects": [ ~/~/ Объекты для ретрансляции

4593

{

4594

"id": "", ~/~/ Идентификатор объекта ретрансляции

4595

"name": "string", ~/~/ Наименование объекта ретрансляции

4596

"imei": "", ~/~/ IMEI объекта ретрансляции

4597

"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен

4598

}

4599

],

4600

"id": "", ~/~/ Идентификатор ретранслятора

4601

"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)

4602

"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален

}

== **Редактирование ретранслятора** ==

4607

4608

(% class="box infomessage" %)

4609

(((

4610

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ Идентификатор ретранслятора

4617

"description": "string", ~/~/ Поле описания ретранслятора

4618

"subscriberId": "", ~/~/ Идентификатор подписчика

4619

"protocolType": 0, ~/~/ Тип протокола ретрансляции

4620

"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен

4621

"address": "string", ~/~/ Адрес и порт принимающего сервера

4622

"objects": ~/~/ Объекты для ретрансляции

4623

[

4624

{

4625

"id": "", ~/~/ Идентификатор объекта ретрансляции

4626

"imei": "", ~/~/ IMEI объекта ретрансляции

4627

"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Поле описания ретранслятора

4637

"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)

4638

"protocolType": 0, ~/~/ Тип протокола ретрансляции

4639

"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен

4640

"address": "string", ~/~/ Адрес и порт принимающего сервера

4641

"objects": [ ~/~/ Объекты для ретрансляции

4642

{

4643

"id": "", ~/~/ Идентификатор объекта ретрансляции

4644

"name": "string", ~/~/ Наименование объекта ретрансляции

4645

"imei": "", ~/~/ IMEI объекта ретрансляции

4646

"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен

4647

}

4648

],

4649

"id": "", ~/~/ Идентификатор ретранслятора

4650

"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)

4651

"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален

}

== **Получение списка ретранслятора клиента** ==

4656

4657

(% class="box infomessage" %)

4658

(((

4659

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ Идентификатор ретранслятора

4666

"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4667

"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).

}

Ответ:

[

{

"description": "", ~/~/ Поле описания ретранслятора

4675

"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)

4676

"protocolType": 0, ~/~/ Тип протокола ретрансляции

4677

"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен

4678

"address": "string", ~/~/ Адрес и порт принимающего сервера

4679

"id": "", ~/~/ Идентификатор ретранслятора

4680

"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)

4681

"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4687

4688

== **API для отчета по выгрузке комбайнов** ==

4689

4690

(% class="box infomessage" %)

4691

(((

4692

**POST /api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4699

"byDist": 0, ~/~/ Объединение событий по расстоянию

4700

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4701

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4702

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4703

"vehicleIds": [ ~/~/ Список id объектов для анализа

4704

0

4705

],

4706

"from": "", ~/~/ Дата и время начало запроса

4707

"to": "", ~/~/ Дата и время окончания запроса

4708

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4716

"harvesterId": 0, ~/~/Комбайн, id

4717

"harvesterModel": "", ~/~/ Модель комбайна

4718

"hopperCapacity": 0, ~/~/ Объем бункера м3

4719

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4720

"events": [ ~/~/Список событий в разрезе комбайна

4721

{

4722

"driverId": "", ~/~/Идентификатор водителя

4723

"driverName": "", ~/~/Водитель комбайна, ФИО

4724

"RFID": "", ~/~/ идентификатор карты-метки

4725

"rfidName": "", ~/~/Водитель комбайна, имя метки

4726

"vehicleId": 0, ~/~/идентификатор объекта

4727

"vehicleName": "string", ~/~/ Имя объекта

4728

"modelName": "string", ~/~/ Имя модели объекта

4729

"nearestVehicles": [ ~/~/Объекты рядом

4730

{

4731

"vehicleId": 0, ~/~/идентификатор объекта

4732

"vehicleName": "string" ~/~/ Имя объекта

4733

}

4734

],

4735

"fields": [ ~/~/Поля, где происходила выгрузка

4736

{

4737

"id": 0, ~/~/ идентификатор пользователя

4738

"name": "string" ~/~/ имя пользователя

4739

}

4740

],

4741

"event": "string", ~/~/Событие

4742

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4743

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4744

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4745

"cultureName": "string", ~/~/ название культуры

4746

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4747

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4748

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4749

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4750

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4751

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4752

"issued": 0, ~/~/Выдано, бункеров

4753

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4754

"latitude": 0, ~/~/Широта

4755

"longitude": 0, ~/~/ Долгота

4756

"litresAway": 0, ~/~/Отдано, л

4757

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =

4765

4766

4767

== **Запрос списка полей** ==

4768

4769

(% class="box successmessage" %)

4770

(((

4771

**POST /api/v3/agroLands/find**

)))

Пример запроса:

(((

(((

(((

{

"year": 0, ~/~/ Фильтр по году

4781

"name": "string", ~/~/ Фильтр по названию

4782

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению

}

)))

)))

)))

Пример ответа:

(((

[

{

"sqPlan": 0, ~/~/ Определяет площадь поля, Га.

4796

"year": 0, ~/~/ Год поля

4797

"startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая

4798

"endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая

4799

"status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто

4800

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры

4801

"cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии

4802

"counts": { ~/~/ Счётчики с/х поля

4803

"fieldOperations": 0, ~/~/ Количество операций на поле

4804

"actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле

4805

"facts": 0 ~/~/ Счётчик факта

4806

},

4807

"planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

4808

"actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

4809

"factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

4810

"taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

4811

"fieldId": 0, ~/~/ Ссылка на группирующее с/х поле

4812

"sourceId": 0, ~/~/ Ссылка на участок прошлого года

4813

"planComment": "string", ~/~/ Комментарий к полю

4814

"productivity": 0, ~/~/ Урожайность.

4815

"id": 0, ~/~/ Идентификатор объекта геозоны

4816

"name": "string", ~/~/ Название объекта геозоны

4817

"type": 0, ~/~/ Тип объекта геозоны

4818

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

4819

"fname": "string", ~/~/ Имя файла

4820

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента

4821

"beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны

4822

"endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны

4823

"description": "string", ~/~/ Описание объекта геозоны

4824

"area": 0, ~/~/ Площадь, м2

4825

"perimetr": 0, ~/~/ Периметр, м

4826

"createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд

}

]

== **Создание нового поля ** ==

4832

4833

(% class="box successmessage" %)

4834

(((

4835

**POST /api/v3/agroLands**

)))

Пример запроса:

(((

{

"extId": "string",

"shape": "string", ~/~/ Форма поля

4844

"shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля

4845

"display": "string", ~/~/ Настройки отображения

4846

"year": 0, ~/~/ Год поля

4847

"name": "string", ~/~/ Наименование

4848

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

4849

"startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая

4850

"endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая

4851

"planComment": "string", ~/~/ Комментарий к полю

4852

"cropRotations": [ ~/~/ Данные по севообороту

4853

{

4854

"landId": 0, ~/~/ ID поля

4855

"landName": "string", ~/~/ Название поля

4856

"year": 0, ~/~/ Год урожая

4857

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры

4858

"cultureName": "string", ~/~/ Название культуры

4859

"productivity": 0, ~/~/ Урожайность

4860

"area": 0, ~/~/ Площадь поля, Га

4861

"total": 0, ~/~/ Валовый сбор

4862

"productivityFact": 0, ~/~/ Фактическая урожайность

4863

"areaFact": 0, ~/~/ Фактическая площадь поля, Га.

4864

"totalFact": 0, ~/~/ Фактический валовый сбор

4865

"start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ

4866

"sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева

4867

"harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая

4868

"isyearplan": true, ~/~/ Годовой план

4869

"comment": "string" ~/~/ Комментарий

}

]

}

)))

(((

)))

Пример ответа:

(((

(((

{

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры

4885

"cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии

4886

"fieldId": 0, ~/~/ Ссылка на группирующее с/х поле

4887

"sourceId": 0, ~/~/ Ссылка на участок прошлого года

4888

"cropRotations": [ ~/~/ Данные по севообороту

4889

{

4890

"landId": 0, ~/~/ ID поля

4891

"landName": "string", ~/~/ Название поля

4892

"year": 0, ~/~/ Год урожая

4893

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры

4894

"cultureName": "string", ~/~/ Название культуры

4895

"productivity": 0, ~/~/ Урожайность

4896

"area": 0, ~/~/ Площадь поля, Га.

4897

"total": 0, ~/~/ Валовый сбор

4898

"productivityFact": 0, ~/~/ Фактическая урожайность

4899

"areaFact": 0, ~/~/ Фактическая площадь поля, Га.

4900

"totalFact": 0, ~/~/ Фактический валовый сбор

4901

"start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ

4902

"sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева

4903

"harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая

4904

"isyearplan": true, ~/~/ годовой план

4905

"comment": "string" ~/~/ Комментарий

4906

}

4907

],

4908

"cropVegetation": [ ~/~/ История вегетации поля

4909

{

4910

"values": [ ~/~/ Данные вегетации и состояния посева

4911

{

4912

"date": "2024-12-20T08:19:59.743Z", ~/~/ Дата

4913

"ndvi": 0 ~/~/ Индекс вегетации

4914

}

4915

],

4916

"resources": [ ~/~/ Данные о снимках для каждого значения NDVI

4917

{

4918

"date": "2024-12-20T08:19:59.743Z", ~/~/ Дата

4919

"type": "string", ~/~/ Тип

4920

"pictureid": "string" ~/~/ Идентификатор ресурса

4921

}

4922

],

4923

"states": [ ~/~/ Ключевые даты развития поля

4924

{

4925

"date": "2024-12-20T08:19:59.743Z", ~/~/ Дата

4926

"state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая

}

]

}

],

"endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая

4932

"counts": {

4933

"fieldOperations": 0, ~/~/ Количество операций на поле

4934

"actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле

4935

"facts": 0 ~/~/ Счётчик факта

4936

},

4937

"planComment": "string", ~/~/ Комментарий к полю

)))

(((

"productivity": 0, ~/~/ Урожайность.

4942

"sqPlan": 0, ~/~/ Определяет площадь поля, Га.

4943

"startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая

4944

"year": 0, ~/~/ Год поля

4945

"planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

4946

"actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

4947

"factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

4948

"taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

4949

"status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто

4950

"id": 0, ~/~/ Идентификатор объекта геозоны

4951

"name": "string", ~/~/ Название объекта геозоны

4952

"type": 0, ~/~/ Тип объекта геозоны

4953

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

4954

"fname": "string", ~/~/ Имя файла

4955

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента

4956

"beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны

4957

"endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны

4958

"description": "string", ~/~/ Описание объекта геозоны

4959

"area": 0, ~/~/ Площадь, м2

4960

"perimetr": 0, ~/~/ Периметр, м

4961

"createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд

}

)))

)))

)))

== **Получение поля по id** ==

4970

4971

(% class="box infomessage" %)

4972

(((

4973

**GET /api/v3/agroLands/{id}**

)))

Пример запроса:

id ~/~/ Идентификатор поля

Пример ответа:

(((

{

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры

4984

"cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии

4985

"fieldId": 0, ~/~/ Ссылка на группирующее с/х поле

4986

"sourceId": 0, ~/~/ Ссылка на участок прошлого года

4987

"cropRotations": [ ~/~/ Данные по севообороту

4988

{

4989

"landId": 0, ~/~/ ID поля

4990

"landName": "string", ~/~/ Название поля

4991

"year": 0, ~/~/ Год урожая

4992

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры

4993

"cultureName": "string", ~/~/ Название культуры

4994

"productivity": 0, ~/~/ Урожайность

4995

"area": 0, ~/~/ Площадь поля, Га

4996

"total": 0, ~/~/ Валовый сбор

4997

"productivityFact": 0, ~/~/ Фактическая урожайность

4998

"areaFact": 0, ~/~/ Фактическая площадь поля, Га.

4999

"totalFact": 0, ~/~/ Фактический валовый сбор

5000

"start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ

5001

"sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева

5002

"harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая

5003

"isyearplan": true, ~/~/ План года

5004

"comment": "string" ~/~/ Комментарий

5005

}

5006

],

5007

"cropVegetation": [ ~/~/ История вегетации поля

5008

{

5009

"values": [ ~/~/ Данные вегетации и состояния посева

5010

{

5011

"date": "2024-12-20T07:45:52.611Z", ~/~/ Дата

5012

"ndvi": 0 ~/~/ Индекс вегетации

5013

}

5014

],

5015

"resources": [ ~/~/ Данные о снимках для каждого значения NDVI

5016

{

5017

"date": "2024-12-20T07:45:52.611Z", ~/~/ Дата

5018

"type": "string", ~/~/ Тип

5019

"pictureid": "string" ~/~/ Идентификатор ресурса

5020

}

5021

],

5022

"states": [ ~/~/ Ключевые даты развития поля

5023

{

5024

"date": "2024-12-20T07:45:52.611Z", ~/~/ Дата

5025

"state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая

}

]

}

],

"endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая

5031

"counts": {

5032

"fieldOperations": 0, ~/~/ Количество операций на поле

5033

"actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле

5034

"facts": 0 ~/~/ Счётчик факта

5035

},

5036

"planComment": "string", ~/~/ Комментарий к полю

5037

"productivity": 0, ~/~/ Урожайность.

5038

"sqPlan": 0, ~/~/ Определяет площадь поля, Га.

)))

(((

(((

"startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая

5044

"year": 0, ~/~/ Год поля

5045

"planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)

5046

"actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)

5047

"factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)

5048

"taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)

5049

"status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)

5050

"id": 0, ~/~/ Идентификатор объекта геозоны

5051

"name": "string", ~/~/ Название объекта геозоны

5052

"type": 0, ~/~/ Тип объекта геозоны

5053

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

5054

"fname": "string", ~/~/ Имя файла

5055

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента

5056

"beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны

5057

"endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны

5058

"description": "string", ~/~/ Описание объекта геозоны

5059

"area": 0, ~/~/ Площадь, м2

5060

"perimetr": 0, ~/~/ Периметр, м

5061

"createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд

}

)))

== **Удаление существующего поля** ==

5067

5068

(% class="box errormessage" %)

5069

(((

5070

**DELETE /api/v3/agroLands/{id}**

)))

Пример запроса:

id ~/~/ Идентификатор поля

Пример ответа:

(((

200 ~/~/ Успех

)))

(((

)))

(((

(((

(((

)))

(((

== **Изменение поля** ==

5094

5095

(% class="box infomessage" %)

5096

(((

5097

**PUT /api/v3/agroLands**

)))

Пример запроса:

(((

(((

{

"id": 0, ~/~/ Идентификатор поля

5106

"extId": "string", ~/~/ ExtId

5107

"shape": "string", ~/~/ Форма поля

5108

"shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля

5109

"display": "string", ~/~/ Настройки отображения

5110

"year": 0, ~/~/ Год поля

5111

"name": "string", ~/~/ Наименование

5112

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

5113

"startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая

5114

"endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая

5115

"planComment": "string", ~/~/Комментарий к полю

5116

"cropRotations": [ ~/~/ Данные по севообороту

5117

{

5118

"landId": 0, ~/~/ ID поля

5119

"landName": "string", ~/~/ Название поля

5120

"year": 0, ~/~/ Год урожая

5121

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры

5122

"cultureName": "string", ~/~/ Название культуры

5123

"productivity": 0, ~/~/ Урожайность

5124

"area": 0, ~/~/ Площадь поля, Га.

5125

"total": 0, ~/~/ Валовый сбор

5126

"productivityFact": 0, ~/~/ Фактическая урожайность

5127

"areaFact": 0, ~/~/ Фактическая площадь поля, Га.

5128

"totalFact": 0, ~/~/ Фактический валовый сбор

5129

"start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ

5130

"sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева

5131

"harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая

5132

"isyearplan": true,

5133

"comment": "string" ~/~/ Комментарий

5134

}

5135

],

5136

"deleteStatistic": true ~/~/ Нужно ли удалять статистику

}

)))

)))

(((

)))

Пример ответа:

(((

(((

(((

{

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры

5152

"cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии

5153

"fieldId": 0, ~/~/ Ссылка на группирующее с/х поле

5154

"sourceId": 0, ~/~/ Ссылка на участок прошлого года

5155

"cropRotations": [ ~/~/ Данные по севообороту

5156

{

5157

"landId": 0, ~/~/ ID поля

5158

"landName": "string", ~/~/ Название поля

5159

"year": 0, ~/~/ Год урожая

5160

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры

5161

"cultureName": "string", ~/~/ Название культуры

5162

"productivity": 0, ~/~/ Урожайность

5163

"area": 0, ~/~/ Площадь поля, Га

5164

"total": 0, ~/~/ Валовый сбор

5165

"productivityFact": 0, ~/~/ Фактическая урожайность

5166

"areaFact": 0, ~/~/ Фактическая площадь поля, Га.

5167

"totalFact": 0, ~/~/ Фактический валовый сбор

5168

"start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ

5169

"sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева

5170

"harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая

5171

"isyearplan": true, ~/~/

5172

"comment": "string" ~/~/ Комментарий

5173

}

5174

],

5175

"cropVegetation": [ ~/~/ История вегетации поля

5176

{

5177

"values": [ ~/~/ Данные вегетации и состояния посева

5178

{

5179

"date": "2024-12-20T10:11:59.533Z", ~/~/ Дата

5180

"ndvi": 0 ~/~/ Индекс вегетации

5181

}

5182

],

5183

"resources": [ ~/~/ Данные о снимках для каждого значения NDVI

5184

{

5185

"date": "2024-12-20T10:11:59.533Z", ~/~/ Дата

5186

"type": "string", ~/~/ Тип

5187

"pictureid": "string" ~/~/ Идентификатор ресурса

5188

}

5189

],

5190

"states": [ ~/~/ Ключевые даты развития поля

5191

{

5192

"date": "2024-12-20T10:11:59.533Z", ~/~/ Дата

5193

"state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая

}

]

}

],

"endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая

5199

"counts": {

5200

"fieldOperations": 0, ~/~/ Количество операций на поле

5201

"actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле

5202

"facts": 0 ~/~/ Счётчик факта

5203

},

5204

"planComment": "string", ~/~/ Комментарий к полю

5205

"productivity": 0, ~/~/ Урожайность.

5206

"sqPlan": 0, ~/~/ Определяет площадь поля, Га.

5207

"startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая

5208

"year": 0, ~/~/ Год поля

5209

"planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

5210

"actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

5211

"factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

5212

"taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой

5213

"status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто

5214

"id": 0, ~/~/ Идентификатор объекта геозоны

5215

"name": "string", ~/~/ Название объекта геозоны

5216

"type": 0, ~/~/ Тип объекта геозоны

5217

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

5218

"fname": "string", ~/~/ Имя файла

5219

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента

5220

"beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны

5221

"endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны

5222

"description": "string", ~/~/ Описание объекта геозоны

5223

"area": 0, ~/~/ Площадь, м2

5224

"perimetr": 0, ~/~/ Периметр, м

5225

"createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд

}

)))

)))

)))

)))

)))

== **Редактирование года урожая ** ==

5235

5236

(% class="box successmessage" %)

5237

(((

5238

**POST /api/v3/agroLands/updateOpenCloseYear**

)))

Пример запроса:

(((

(((

{

"agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая

5247

0

5248

],

5249

"newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая

5250

"newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая

}

)))

)))

Пример ответа:

(((

(((

{

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры

5263

"cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии

5264

"fieldId": 0, ~/~/ Ссылка на группирующее с/х поле

5265

"sourceId": 0, ~/~/ Ссылка на участок прошлого года

5266

"cropRotations": [ ~/~/ Данные по севообороту

5267

{

5268

"landId": 0, ~/~/ ID поля

5269

"landName": "string", ~/~/ Название поля

5270

"year": 0, ~/~/ Год урожая

5271

"cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры

5272

"cultureName": "string", ~/~/ Название культуры

5273

"productivity": 0, ~/~/ Урожайность

5274

"area": 0, ~/~/ Площадь поля, Га.

5275

"total": 0, ~/~/ Валовый сбор

5276

"productivityFact": 0, ~/~/ Фактическая урожайность

5277

"areaFact": 0, ~/~/ Фактическая площадь поля, Га.

5278

"totalFact": 0, ~/~/ Фактический валовый сбор

5279

"start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ

5280

"sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева

5281

"harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая

5282

"isyearplan": true, ~/~/

5283

"comment": "string" ~/~/ Комментарий

5284

}

5285

],

5286

"cropVegetation": [ ~/~/ История вегетации поля

5287

{

5288

"values": [ ~/~/ Данные вегетации и состояния посева

5289

{

5290

"date": "2024-12-20T11:43:44.091Z", ~/~/ Дата

5291

"ndvi": 0 ~/~/ Индекс вегетации

5292

}

5293

],

5294

"resources": [ ~/~/ Данные о снимках для каждого значения NDVI

5295

{

5296

"date": "2024-12-20T11:43:44.091Z", ~/~/ Дата

5297

"type": "string", ~/~/ Тип

5298

"pictureid": "string" ~/~/ Идентификатор ресурса

5299

}

5300

],

5301

"states": [ ~/~/ Ключевые даты развития поля

5302

{

5303

"date": "2024-12-20T11:43:44.091Z", ~/~/ Дата

5304

"state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая

}

]

}

],

"endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая

5310

"counts": {

5311

"fieldOperations": 0, ~/~/ Количество операций на поле

5312

"actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле

5313

"facts": 0 ~/~/ Счётчик факта

5314

},

5315

"planComment": "string", ~/~/ Комментарий к полю

5316

"productivity": 0, ~/~/ Урожайность.

5317

"sqPlan": 0, ~/~/ Определяет площадь поля, Га.

5318

"startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая

5319

"year": 0, ~/~/ Год поля

5320

"planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

5321

"actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

5322

"factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

5323

"taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой

5324

"status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто

5325

"id": 0, ~/~/ Идентификатор объекта геозоны

5326

"name": "string", ~/~/ Название объекта геозоны

5327

"type": 0, ~/~/ Тип объекта геозоны

5328

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение

5329

"fname": "string", ~/~/ Имя файла

5330

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента

5331

"beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны

5332

"endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны

5333

"description": "string", ~/~/ Описание объекта геозоны

5334

"area": 0, ~/~/ Площадь, м2

5335

"perimetr": 0, ~/~/ ериметр, м

5336

"createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд

}

)))

== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==

)))

)))

)))

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

5347

5348

5349

(% class="box infomessage" %)

5350

(((

5351

**GET api/v3/Vehicles/recyclebin/all**

5352

)))

5353

5354

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

5355

5356

Параметр запроса: {parentId} - идентификатор агента

5357

5358

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

5365

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

5366

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

5367

"objectId": 0, ~/~/ID объекта, помещённого в корзину

5368

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

5369

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

5370

"details": { ~/~/Список деталей объекта, помещённого в корзину

5371

"items": [ ~/~/

5372

nullable: true ~/~/Детали

5373

{

5374

"name": "string", ~/~/наименование столбца

5375

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

5387

5388

(% class="box infomessage" %)

5389

(((

5390

**POST api/v3/Vehicles/recyclebin/erase**

5391

)))

5392

5393

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

5407

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

5408

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

5409

"objectId": 0, ~/~/ID объекта, помещённого в корзин

5410

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

5411

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

5412

"details": { ~/~/Список деталей объекта, помещённого в корзину

5413

"items": [ ~/~/Детали

5414

{

5415

"name": "", ~/~/Имя свойства

5416

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

5427

5428

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

5429

5430

(% class="box infomessage" %)

5431

(((

5432

**POST api/v3/Vehicles/recyclebin/restore**

5433

)))

5434

5435

В заголовках запроса: X-Auth: Токен авторизации

5436

5437

Параметры в теле запроса (JSON):

5438

5439

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

5440

5441

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

5464

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

5465

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

5466

"objectId": 0, ~/~/ID объекта, помещённого в корзину

5467

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

5468

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

5469

"details": { ~/~/Список деталей объекта, помещённого в корзину

5470

"items": [ ~/~/Детали

5471

{

5472

"name": "string", ~/~/Имя свойства

5473

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

5486

(((

5487

(% 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]] **

5488

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню