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

1

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

2

(((

3

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

)))

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

8

9

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

10

11

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

12

13

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

14

15

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

16

17

18

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

19

20

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

21

22

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

23

24

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

25

(((

26

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

27

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

28

)))

29

30

(% class="box successmessage" %)

31

(((

32

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

33

)))

34

35

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

36

37

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

38

39

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

40

41

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

42

43

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

44

45

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

46

"login": "testuser",

47

"password": "testuser"

48

}

49

50

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

51

52

(% lang="en-US" %)

53

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

54

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

55

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

56

}

57

58

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

59

60

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

61

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

62

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

63

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

64

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

65

66

(% class="wikigeneratedid" %)

67

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

68

69

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

70

71

(% class="box infomessage" %)

72

(((

73

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

74

)))

75

76

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

77

78

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

79

80

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

81

82

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

83

84

(% lang="en-US" %)

85

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

86

87

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

88

89

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

90

91

(% class="box infomessage" %)

92

(((

93

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

94

)))

95

96

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

97

98

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

99

100

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

101

102

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

103

104

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

105

106

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

111

"name": "string",

112

"fullName": "string",

113

"agentInfoType": 0,

114

"isForeign": true/false,

115

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

122

"email": "string",

123

"director": "string",

124

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

152

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

153

154

(% class="box infomessage" %)

155

(((

156

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

157

)))

158

159

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

160

161

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

162

163

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

164

165

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

166

167

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

168

169

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

170

171

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

172

173

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

"parentId": "string"

}

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

178

179

{

180

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

181

"parentId": "",

182

"name": "string",

183

"fullName": "string",

184

"agentInfoType": 0,

185

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

}

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

190

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

191

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

192

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

193

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

194

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

195

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

196

197

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

198

199

(% class="box successmessage" %)

200

(((

201

**POST /api/v3/agents **

202

)))

203

204

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

205

206

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

207

208

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

209

210

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

211

212

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

213

214

{

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

}

Ответ:

{

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

}

258

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

281

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

282

283

(% class="box warningmessage" %)

284

(((

285

**PUT /api/v3/agents**

286

)))

287

288

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

289

290

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

291

292

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

293

294

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

295

296

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

297

298

{

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

}

Ответ:

{

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

}

342

343

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

344

345

(% class="box errormessage" %)

346

(((

347

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

348

)))

349

350

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

351

352

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

353

354

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

355

356

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

357

358

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

359

360

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

361

362

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

363

364

(% class="box warningmessage" %)

365

(((

366

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

367

)))

368

369

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

370

371

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

372

373

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

Ответ: Code 204

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

378

379

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

380

381

(% class="box successmessage" %)

382

(((

383

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

384

)))

385

386

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

387

388

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

389

390

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

391

392

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

393

394

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

395

396

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

397

{

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

"doubleAuth":

414

{

415

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

416

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

},

"groups":

[

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

],

"customGroups":

[

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

425

],

426

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

427

}

428

{

429

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

430

"lastName": "string",

431

"firstName": "string",

432

"position": "string",

433

"phone": "string",

434

"organization": "string",

435

"login": "string",

436

"password": "string",

437

"email": "string",

438

439

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

440

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

441

{

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

}

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

463

464

(% class="box infomessage" %)

465

(((

466

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

467

)))

468

469

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

470

471

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

472

473

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

474

475

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

476

477

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

478

479

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

480

481

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

482

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

483

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

484

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

485

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

486

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

487

488

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

489

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

506

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

507

508

(% class="box infomessage" %)

509

(((

510

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

511

)))

512

513

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

514

515

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

516

517

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

518

519

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

520

521

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

(((

(((

{

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

"doubleAuth":

541

{

542

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

543

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

544

},

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

}

)))

)))

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

559

560

(% class="box warningmessage" %)

561

(((

562

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

563

)))

564

565

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

566

567

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

568

569

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

570

571

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

572

573

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

574

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

575

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

"doubleAuth":

595

{

596

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

597

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

598

},

599

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

600

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

601

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

602

603

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

604

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

605

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

"doubleAuth":

622

{

623

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

624

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

625

},

626

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

627

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

628

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

629

}

630

631

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

632

633

(% class="box warningmessage" %)

634

(((

635

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

636

)))

637

638

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

639

640

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

641

642

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

643

644

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

645

646

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

647

648

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

649

650

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

651

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

652

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

653

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

654

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

655

656

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

657

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

658

659

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

660

661

(% class="box warningmessage" %)

662

(((

663

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

664

)))

665

666

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

667

668

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

669

670

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

671

672

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

673

674

[

675

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

676

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

677

]

678

679

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

680

681

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

682

683

(% class="box warningmessage" %)

684

(((

685

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

686

)))

687

688

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

689

690

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

691

692

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

693

694

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

695

696

[

697

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

698

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

699

]

700

701

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

702

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

(((

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

{

"errorMessages": [

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

709

],

710

"users": [

711

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

712

]

713

}

714

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

715

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

716

)))

717

718

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

719

720

(% class="box errormessage" %)

721

(((

722

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

723

)))

724

725

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

726

727

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

728

729

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

730

731

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

732

733

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

734

735

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

736

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

737

738

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

739

740

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

741

742

(% class="box infomessage" %)

743

(((

744

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

745

)))

746

747

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

748

749

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

750

751

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

752

753

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

754

755

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

756

757

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

758

759

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

760

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

767

"hoppercapacity": 0,

768

"hopperdischargespeed": 0,

769

"modelType": 0,

770

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

771

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

776

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

777

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

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

788

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

789

790

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

791

792

(% class="box successmessage" %)

793

(((

794

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

795

)))

796

797

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

798

799

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

800

801

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

802

803

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

804

805

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

806

807

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

808

}

809

810

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

811

812

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

813

{

814

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

815

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

816

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

823

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

824

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

825

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

826

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

827

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

828

829

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

830

831

(% class="box successmessage" %)

832

(((

833

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

834

)))

835

836

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

837

838

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

839

840

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

841

842

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

843

844

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

845

846

{

847

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

848

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

857

"fueloutlay": 0,

858

"hoppercapacity": 0,

859

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

867

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

876

"hoppercapacity": 0,

877

"hopperdischargespeed": 0,

"modelType": 0

}

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

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

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

894

895

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

896

897

(% class="box warningmessage" %)

898

(((

899

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

900

)))

901

902

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

903

904

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

905

906

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

907

908

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

909

910

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

911

912

{

913

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

914

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

923

"fueloutlay": 0,

924

"hoppercapacity": 0,

925

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

933

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

942

"fueloutlay": 0,

943

"hoppercapacity": 0,

944

"hopperdischargespeed": 0,

"modelType": 0

}

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

962

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

963

964

(% class="box errormessage" %)

965

(((

966

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

967

)))

968

969

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

970

971

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

972

973

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

974

975

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

976

977

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

978

979

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

980

981

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

982

983

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

984

985

(% class="box infomessage" %)

986

(((

987

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

988

)))

989

990

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

991

992

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

993

994

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

995

996

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

997

998

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

999

1000

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

1001

1002

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

1003

1004

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

1005

1006

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

(((

{

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

},

1026

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

1027

{

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

}

1035

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

},

1061

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

},

1069

1070

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

1071

{

1072

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

1073

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

1074

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

1075

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

1076

}

1077

],

1078

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

1079

{

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

{

1093

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

1094

{

1095

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

1096

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

1097

}

1098

],

1099

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

1100

}

1101

],

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

1108

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

1109

"string"

1110

],

1111

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

1112

"additionalProp1": "string",

1113

"additionalProp2": "string",

1114

"additionalProp3": "string"

1115

},

1116

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

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

1130

}

1131

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

1132

{

1133

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

1134

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

1135

"description": "string",

1136

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

1137

}

1138

],

1139

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

1140

{

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

}

1154

],

1155

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

1156

{

1157

"status": 0,

1158

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

1159

"description": "string",

1160

"additionalInfo": "string"

}

]

}

)))

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

1167

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

1168

1169

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

1170

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

1171

1172

1173

== **Импортировать историю ТС (Асинхронный запрос)** ==

1174

1175

(% class="box successmessage" %)

1176

(((

1177

**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **

1178

)))

1179

1180

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

1181

1182

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

1183

1184

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

Ответ:

{

"RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса

1192

1193

"Status": 0, ~/~/ Перечисление состояний выполнения запроса

1194

1195

~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)

1196

1197

"Message": "string", ~/~/ Информация о выполнении запроса

1198

1199

"ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)

1200

1201

"ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress

1202

1203

"Data": "string" ~/~/ Данные

}

== **Возвращает статус асинхронного запроса импорта истории ТС** ==

1209

1210

(% class="box infomessage" %)

1211

(((

1212

**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**

1213

)))

1214

1215

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

1216

1217

(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**

1218

1219

(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса

Ответ:

{

"RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса

1227

1228

"Status": 0, ~/~/ Перечисление состояний выполения запроса

1229

~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest

1230

1231

"Message": "string", ~/~/ Информация о выполнении запроса

1232

1233

"ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса

1234

1235

~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None

1236

1237

"ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress

1238

1239

"Data": "string" ~/~/ Данные

}

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

1245

1246

(% class="box successmessage" %)

1247

(((

1248

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

1249

)))

1250

1251

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

1252

1253

{

1254

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

1255

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

1256

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

1257

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

}

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

1262

1263

(% class="box infomessage" %)

1264

(((

1265

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

1266

)))

1267

1268

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

1269

1270

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

1271

1272

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

1273

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

1283

(((

1284

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

1285

1286

(% class="box infomessage" %)

1287

(((

1288

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

1289

)))

1290

1291

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

1292

1293

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

1294

1295

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

[

{

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

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

}

]

)))

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

1311

1312

(% class="box successmessage" %)

1313

(((

1314

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

1315

)))

1316

1317

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

1318

1319

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

1320

1321

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

1322

1323

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

1324

1325

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

1326

1327

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

1328

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

1329

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

1330

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

1331

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

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

"mileageCalcMethod": 0,

1349

"mileageCoeff": 0,

1350

"locationByCellId": true,

1351

"dottedLineTrackWhenNoCoords": true,

1352

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

1353

{

1354

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

1355

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

1356

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

1357

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

1358

},

1359

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

1360

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

1361

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

1362

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

1363

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

1364

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

1365

},

1366

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

1367

{

1368

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

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

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

1376

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

1377

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

1378

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

1379

}

1380

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

1381

{

1382

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

"isDefault": true

}

],

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

1387

{

1388

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1395

{

1396

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

1397

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

1398

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

1399

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

1400

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

1401

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

{

1409

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

1410

{

1411

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

1412

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

1413

}

1414

],

1415

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

1416

}

1417

],

1418

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

1419

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

1420

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

1421

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

1422

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

1423

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

1424

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

1425

"string"

1426

],

1427

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

1428

"additionalProp1": "string",

1429

"additionalProp2": "string",

1430

"additionalProp3": "string"

1431

},

1432

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

1433

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

1434

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

1435

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

1436

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

1437

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

1438

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

1439

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

1440

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

1441

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

1442

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

1443

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

1444

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

1445

1446

(((

1447

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

1448

{

1449

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

1450

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

1451

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

}

]

}

],

)))

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

1459

1460

1461

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

1462

{

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

}

]

}

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

(((

(((

(((

{

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

1481

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

1482

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

1483

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

1484

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

1485

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

1486

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

1487

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

1488

"sim2": "string", ~/~/ SIM2

1489

"consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км

1490

"consumptionPerHour": 0, ~/~/ Расход топлива на моточас

1491

"consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу

1492

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1493

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1494

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1495

"consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1496

"consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1497

"consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1498

"consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1499

"consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1500

"consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1501

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)

1502

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

1503

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

1504

"dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.

1505

"showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.

1506

"counters": { ~/~/ Dto для состояний счётчиков

1507

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

1508

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

1509

"mileage": 0, ~/~/ Пробег

1510

"motohours": 0 ~/~/ Моточасы

1511

},

1512

"cmsv6Parameters": { ~/~/ Dto для CMSv6

1513

"id": "string", ~/~/ CMSV6 Идентификатор

1514

"enabled": true, ~/~/ Признак включения

1515

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1516

"login": "string", ~/~/ CMSV6 имя учетной записи

1517

"password": "string" ~/~/ CMSV6 — пароль учетной записи

1518

},

1519

"inspectionTasks": [ ~/~/ Dto для описания задачи на ТО

1520

{

1521

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи

1522

"enabled": true, ~/~/ Признак включения

1523

"name": "string", ~/~/ Имя задания

1524

"description": "string", ~/~/ Описание задания

1525

"mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)

1526

"lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО

1527

"motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)

1528

"lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО

1529

"periodicCondition": 0, ~/~/ Условие периодичности по времени

1530

"kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)

1531

"lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО

1532

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

1533

}

1534

],

1535

"drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.

1536

{

1537

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

1538

"inputNumber": 0, ~/~/ № входа.

1539

"createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.

1540

"comment": "string", ~/~/ Комментарий

1541

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

1542

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

1543

"beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.

1544

"endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.

1545

}

1546

],

1547

"commandTemplates": [ ~/~/ Список шаблонов команд

1548

{

1549

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

1550

"name": "string", ~/~/ Название шаблона команд

1551

"command": "string", ~/~/ Команда на выполнение

1552

"retries": 0 ~/~/ Лимит попыток отправки

1553

}

1554

],

1555

"sensors": [ ~/~/ Список датчиков

1556

{

1557

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1558

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

1559

"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

1560

"name": "string", ~/~/ Имя датчика

1561

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

1562

"inputNumber": 0, ~/~/ Номер входа

1563

"pseudonym": "string", ~/~/ Псевдоним

1564

"medianDegree": 0, ~/~/ Степень медианной фильтрации

1565

"isInverted": true, ~/~/ Признак инверсии

1566

"disabled": true, ~/~/ Датчик не участвует в обработке

1567

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1568

"gradesTables": [ ~/~/ Тарировка

1569

{

1570

"grades": [ ~/~/ Таблицы тарировки

1571

{

1572

"input": 0, ~/~/ Вход

1573

"output": 0 ~/~/ Выход

1574

}

1575

],

1576

"relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

1577

}

1578

],

1579

"showInTooltip": true, ~/~/ Отображение в подсказке

1580

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1581

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1582

"showWithoutIgn": true, ~/~/ Отображать без включенного зажигания

1583

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

1584

"expr": "string", ~/~/ Выражение

1585

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

"string"

],

"customParams": {

"additionalProp1": "string",

1590

"additionalProp2": "string",

1591

"additionalProp3": "string"

1592

},

1593

"summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.

1594

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1595

{

1596

"from": 0, ~/~/ С какого значения

1597

"color": "string", ~/~/ Каким цветом

)))

(((

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1607

"customFields": [ ~/~/ Список произвольных полей

1608

{

1609

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1610

"name": "string", ~/~/ Наименование произвольного поля

1611

"value": "string", ~/~/ Значение произвольного поля

1612

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

1613

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

1614

"forReport": true ~/~/ Отобразить произвольное поле в отчете

1615

}

1616

],

1617

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor

}

)))

)))

)))

**Валидация:**

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1626

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1627

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1628

1629

== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==

1630

1631

(% class="box infomessage" %)

1632

(((

1633

(% lang="en-US" %)**POST /api/v3/vehicles/find**

1634

)))

1635

1636

(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

1637

1638

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:

1639

1640

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

1641

1642

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

1643

1644

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

1645

1646

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

1647

1648

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

1649

1650

(% style="color:#000000" %)Метод запроса: **POST**

1651

1652

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

1653

1654

(% style="color:#000000" %)В заголовках запроса:

1655

1656

(% style="color:#000000" %)− Content-Type: __**application/json**__

1657

1658

(% style="color:#000000" %)− X-Auth: Токен авторизации

1659

1660

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1661

1662

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1663

1664

{

1665

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1666

"name": null, ~/~/ Имя ТС (string, опционально)

1667

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1668

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1669

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1670

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)

1671

"unitName": "string", ~/~/ Название подразделения (опционально)

1672

"customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)

1673

"vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)

1674

"vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)

1675

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные

1676

}

1677

1678

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1679

1680

(% style="color:#000000" %)Ответ:

1681

1682

(% style="color:#000000" %)[

{

(((

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC

)))

(((

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1691

"name": "" ~/~/ наименование объекта

1692

"imei": "" ~/~/ IMEI объекта

1693

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1694

"deviceTypeName": "" ~/~/ наименование типа устройства

1695

"sim1": "" ~/~/ первый номер телефона

1696

"sim2": "" ~/~/ второй номер телефона

1697

"parentId": "" ~/~/ идентификатор клиента-родителя

1698

"parentName": "" ~/~/ наименование клиента-родителя

1699

"modelId": "" ~/~/ идентификатор модели объекта

1700

"modelName": "" ~/~/ наименование модели объекта

1701

"unitId": "" ~/~/ идентификатор подразделения

1702

"unitName": "" ~/~/ наименование подразделения

1703

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1704

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1705

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1706

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1707

"customFields": [

1708

{

1709

"id": "", ~/~/ идентификатор произвольного поля

1710

"name": "", ~/~/ имя произвольного поля

1711

"value": "", ~/~/ значение произвольного поля

1712

"forClient": true, ~/~/ право на отображение у клиента

1713

"forTooltip": false, ~/~/ право на отображение в подсказке

1714

"forReport": false ~/~/ право на отображение в отчетах

)))

(((

}

],

"vehicleGroups": [ ~/~/ Группы ТС

1721

{

1722

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1723

"name": "string" ~/~/ Наименование группы ТС

}

]

}

]

)))

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1731

1732

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1733

1734

(% class="box successmessage" %)

1735

(((

1736

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1737

)))

1738

1739

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1740

1741

(% style="color:#000000" %)Метод запроса: **POST**

1742

1743

(% 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}

1744

1745

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1746

1747

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1748

1749

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1750

1751

(% style="color:#000000" %){

1752

1753

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1754

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1755

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1756

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1757

"description": "", ~/~/ Описание

1758

"data": "", ~/~/ Данные

1759

"overwrite": false, ~/~/ Флаг перезаписи

1760

"stage": "", ~/~/ Состояние, может быть null

1761

(% style="color:#000000" %)}

1762

1763

(% style="color:#000000" %)Ответ:

1764

1765

(% style="color:#000000" %){(%%)

1766

"status": "", ~/~/ значение статуса

1767

"date": "", ~/~/ Дата смены статуса

1768

"description": "", ~/~/ Описание

1769

"data": "", ~/~/ Данные

1770

"overwrite": false, ~/~/ Флаг перезаписи

1771

"stage": "", ~/~/ Состояние

1772

(% style="color:#000000" %) }

== ==

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1777

1778

(% class="box warningmessage" %)

1779

(((

1780

(% lang="en-US" %)**PUT /api/v3/vehicles**

1781

)))

1782

1783

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1784

1785

(% style="color:#000000" %)Метод запроса: **PUT**

1786

1787

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1788

1789

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1790

1791

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1792

1793

(% style="color:#000000" %){

1794

"vehicleId": , ~/~/ ID объекта

1795

"parentId": "" , ~/~/ ID клиента

1796

"name": "" , ~/~/ имя ТС

1797

"imei": "" , ~/~/ IMEI

1798

"deviceTypeId": "" , ~/~/ ID типа устройства

1799

"modelId": "" , ~/~/ ID модели

1800

"unitId": "" , ~/~/ ID подразделения

1801

"sim1": "" , ~/~/ Номер SIM 1

1802

"sim2": "" , ~/~/ Номер SIM2

1803

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1804

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1805

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1806

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1807

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1808

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1809

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1810

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1811

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1812

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1813

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1814

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1815

1816

"mileageCalcMethod": 0,

1817

"mileageCoeff": 0,

1818

"locationByCellId": true,

1819

"dottedLineTrackWhenNoCoords": true,

1820

"counters": ~/~/ счетчики

1821

{

1822

"mileage": "" , ~/~/ пробег

1823

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1824

"motohours": "" , ~/~/ моточасы

1825

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1826

},

1827

"cmsv6Parameters": { ~/~/ параметры CMSv6

1828

"enabled": true, ~/~/ флаг включения

1829

"id": "" , ~/~/ идентификатор

1830

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1831

"login": "" , ~/~/ имя учетной записи

1832

"password": "" ~/~/ пароль учетной записи

1833

},

1834

"inspectionTasks": ~/~/ задания на ТО

1835

{

1836

"enabled": "" , ~/~/ Признак включения

1837

"name": "" , ~/~/ Имя задания

1838

"description": "" , ~/~/ Описание задания

1839

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1840

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1841

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1842

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1843

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1844

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1845

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1846

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1847

}

1848

1849

"drivers": [ ~/~/ Водители

1850

{

1851

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1856

{

1857

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1864

{

1865

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1866

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1867

"type": 0, ~/~/ Тип датчика

1868

"name": "string", ~/~/ Имя датчика

1869

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1870

"inputNumber": 0, ~/~/ Номер входа

1871

"pseudonym": "string", ~/~/ Псевдоним

1872

"medianDegree": 0, ~/~/ Медианная фильтрация

1873

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1874

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1875

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1876

"gradesTables": [ ~/~/ Массив таблиц тарировки

1877

{

1878

"grades": [ ~/~/ Таблица тарировки 1

1879

{

1880

"input": 0, ~/~/ Входящее значение

1881

"output": 0 ~/~/ Выходящее значение

1882

}

1883

],

1884

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1885

}

1886

],

1887

"showInTooltip": true, ~/~/ Отображать в подсказке

1888

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1889

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1890

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1891

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1892

"expr": "string", ~/~/ Формула

1893

"children": [ ~/~/ массив дочерних датчиков

1894

"string"

1895

],

1896

"customParams": { ~/~/ прочие произвольные параметры

1897

"additionalProp1": "string",

1898

"additionalProp2": "string",

1899

"additionalProp3": "string"

1900

},

1901

~/~/ Характерные для произвольного:

1902

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1903

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1904

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1905

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1906

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1907

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1908

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1909

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1910

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1911

~/~/ "ValueOn": "Вкл.",

1912

~/~/ "ValueOff": "Выкл."

1913

"summaryMaxValue": 0 ~/~/ Макс. значение

1914

1915

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1916

{

1917

"from": 0, ~/~/ С какого значения

1918

"color": "string", ~/~/ Каким цветом

1919

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1925

1926

"customFields": [ ~/~/ Произвольные поля

1927

{

1928

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1929

"name": "string", ~/~/ Наименование произвольного поля

1930

"value": "string", ~/~/ Значение произвольного поля

1931

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

1932

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

1933

"forReport": true ~/~/ Отобразить произвольное поле в отчете

}

]

}

(% style="color:#000000" %)Ответ:

(((

{

"vehicleId": 0, ~/~/ ID ТС

1944

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС

1945

"name": "string", ~/~/ Имя объекта

1946

"imei": "string", ~/~/ IMEI

1947

"deviceTypeId": 0, ~/~/ ID типа устройства

1948

"modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели

1949

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения

1950

"sim1": "string", ~/~/ SIM1

1951

"sim2": "string", ~/~/ SIM2

1952

"consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км

1953

"consumptionPerHour": 0, ~/~/ Расход топлива на моточас

1954

"consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу

1955

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1956

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1957

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1958

"consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1959

"consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1960

"consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1961

"consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1962

"consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1963

"consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1964

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor

1965

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

1966

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

1967

"dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.

1968

"showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.

1969

"counters": { ~/~/ состояний счётчиков

1970

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

1971

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

1972

"mileage": 0, ~/~/ Пробег

1973

"motohours": 0 ~/~/ Моточасы

1974

},

1975

"cmsv6Parameters": { ~/~/ Dto для CMSv6

1976

"id": "string", ~/~/ CMSV6 Идентификатор

1977

"enabled": true, ~/~/ Признак включения

1978

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6.

)))

(((

~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1984

"login": "string", ~/~/ CMSV6 имя учетной записи

1985

"password": "string" ~/~/ CMSV6 — пароль учетной записи

1986

},

1987

"inspectionTasks": [ ~/~/ Задания на ТО

1988

{

1989

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи

1990

"enabled": true, ~/~/ Признак включения

1991

"name": "string", ~/~/ Имя задания

1992

"description": "string", ~/~/ Описание задания

1993

"mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)

1994

"lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО

1995

"motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)

1996

"lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО

1997

"periodicCondition": 0, ~/~/ Условие периодичности по времени

1998

"kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы

1999

"lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО

2000

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

2001

}

2002

],

2003

"drivers": [ ~/~/ Список водителей

2004

{

2005

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

2006

"inputNumber": 0, ~/~/ № входа.

2007

"createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.

2008

"comment": "string", ~/~/ Комментарий.

2009

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

2010

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

2011

"beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.

2012

"endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.

2013

}

2014

],

2015

"commandTemplates": [ ~/~/ Список шаблонов команд

2016

{

2017

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

2018

"name": "string", ~/~/ Название шаблона команд

2019

"command": "string", ~/~/ Команда на выполнение

2020

"retries": 0 ~/~/ Лимит попыток отправки

2021

}

2022

],

2023

"sensors": [ ~/~/ Список датчиков

2024

{

2025

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

2026

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

2027

"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

2048

"name": "string", ~/~/ Имя датчика

2049

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,

)))

(((

~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

2054

"inputNumber": 0, ~/~/ Номер входа

2055

"pseudonym": "string", ~/~/ Псевдоним

2056

"medianDegree": 0, ~/~/ Степень медианной фильтрации

2057

"isInverted": true, ~/~/ Признак инверсии

2058

"disabled": true, ~/~/ Датчик не участвует в обработке

2059

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

2060

"gradesTables": [ ~/~/ Тарировка

2061

{

2062

"grades": [ ~/~/ Таблицы тарировки

2063

{

2064

"input": 0, ~/~/ Вход

2065

"output": 0 ~/~/ Выход

2066

}

2067

],

2068

"relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

2069

}

2070

],

2071

"showInTooltip": true, ~/~/ Отображение в подсказке

2072

"showLastValid": true, ~/~/ Отображать последнее валидное значение

2073

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

2074

"showWithoutIgn": true, ~/~/ Отображать без включенного зажигания

2075

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

2076

"expr": "string", ~/~/ Выражение

2077

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

2078

"string"

2079

],

2080

"customParams": { ~/~/ Дополнительные настройки

2081

"additionalProp1": "string",

2082

"additionalProp2": "string",

2083

"additionalProp3": "string"

2084

},

2085

"summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.

2086

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

2087

{

2088

"from": 0, ~/~/ С какого значения

2089

"color": "string", ~/~/ Каким цветом

2090

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

2096

"customFields": [ ~/~/ Список произвольных полей

2097

{

2098

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

2099

"name": "string", ~/~/ Наименование произвольного поля

2100

"value": "string", ~/~/ Значение произвольного поля

2101

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

2102

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

2103

"forReport": true ~/~/ Отобразить произвольное поле в отчете

2104

}

2105

],

2106

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor

}

)))

**Валидация:**

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

2112

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

2113

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

2114

2115

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

2116

2117

(% class="box errormessage" %)

2118

(((

2119

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

2120

)))

2121

2122

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

2123

2124

(% style="color:#000000" %)Метод запроса: **DELETE**

2125

2126

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

2127

2128

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

2129

2130

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2131

2132

(% style="text-align:left" %)

2133

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

2134

2135

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

2136

2137

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

2138

2139

(% class="box infomessage" %)

2140

(((

2141

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

2142

)))

2143

2144

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

2145

2146

(% style="color:#000000" %)Метод запроса: **GET**

2147

2148

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

2149

2150

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2151

2152

(% style="color:#000000" %)Ответ:

2153

2154

(% style="color:#000000" %){(%%)

2155

"deviceTypeId" : "", ~/~/ ID типа устройства

2156

"deviceTypeName" : "" ~/~/ Название типа устройства

2157

(% style="color:#000000" %)}

2158

2159

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

2160

2161

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

2162

2163

(% class="box infomessage" %)

2164

(((

2165

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

2166

)))

2167

2168

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

2169

2170

(% style="color:#000000" %)Метод запроса: **GET**

2171

2172

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

2173

2174

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2175

2176

(% style="color:#000000" %)Ответ:

2177

2178

(% style="color:#000000" %){(%%)

2179

"id": "", ~/~/ ID типа датчика

2180

"name": "", ~/~/ Название

2181

"description": "", ~/~/ Описание

2182

(% style="color:#000000" %)}

2183

2184

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

2185

2186

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

2187

2188

(% class="box infomessage" style="text-align: left;" %)

2189

(((

2190

**POST /api/v3/terminalMessages/count**

2191

)))

2192

2193

(% style="text-align: left;" %)

2194

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

2195

2196

(% style="text-align: left;" %)

2197

Метод запроса **POST**

2198

2199

(% style="text-align: left;" %)

2200

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

2201

2202

(% style="text-align: left;" %)

2203

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2204

2205

(% style="text-align: left;" %)

2206

{

2207

"vehicleIds": [

2208

id ~/~/ здесь передается список идентификаторов объектов

2209

],

2210

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

2211

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

2212

}

2213

2214

(% style="text-align: left;" %)

2215

Ответ:

2216

2217

(% style="text-align: left;" %)

2218

[

2219

{

2220

"vehicleId": 0, ~/~/ идентификатор объекта

2221

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

2226

2227

(% class="box infomessage" style="text-align: left;" %)

2228

(((

2229

**POST /api/v3/terminalMessages/mapping**

2230

)))

2231

2232

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

2233

2234

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

2235

2236

(% 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);" %)**Описание**

2244

|protocolType|ID типа протокола

2245

|params|(((

2246

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

2266

|protocolType|Тип протокола

2267

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2273

Перечень 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/]]

2274

2275

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2276

2277

(% class="box infomessage" %)

2278

(((

2279

**POST /api/v3/terminalMessages**

2280

)))

2281

2282

Метод возвращает список сообщений терминала объекта за выбранный период.

2283

2284

(% style="text-align: left;" %)

2285

Метод запроса **POST**

2286

2287

(% style="text-align: left;" %)

2288

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

2289

2290

(% style="text-align: left;" %)

2291

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2292

2293

{

2294

"vehicleId": 0, ~/~/ id объекта

2295

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2296

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2297

}

2298

2299

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2300

|vehicleId|ID объекта

2301

|from|Дата и время начала периода запроса

2302

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2311

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2321

"additionalProp2": "string",

2322

"additionalProp3": "string"

2323

},

2324

"photoCount": 0,

2325

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2333

|deviceTime|Время сообщения терминала

2334

|serverTime|Время когда сообщение поступило на сервер

2335

|speed|Скорость

2336

|altitude|Высота над уровнем моря

2337

|latitude|Широта

2338

|longitude|Долгота

2339

|satellites|Кол-во спутников

2340

|course|Курс

2341

|voltage|Бортовое напряжение

2342

|parameters|Список параметров и их значений

2343

|photoCount|Количество фото

2344

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2345

|protocolType|ID типа протокола

2346

2347

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2348

2349

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2350

2351

(% class="box infomessage" %)

2352

(((

2353

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2354

)))

2355

2356

(% style="color:#000000" %)Метод запроса: **POST**

2357

2358

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2359

2360

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2361

2362

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2367

"vehicleIds": [0], ~/~/ Список ID объектов

2368

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2369

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2370

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2378

"name": "string", ~/~/ Имя ТС

2379

"periods": [ ~/~/ Периоды

2380

{

2381

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2382

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2383

"mileage": 0, ~/~/ Пробег за период, километры

2384

"mileageBegin": 0, ~/~/ Пробег на начало периода, километры

2385

"mileageEnd": 0, ~/~/ Пробег на окончание периода, километры

2386

"motohours": 0, ~/~/ Моточасы за период, секунды

2387

"motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды

2388

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2395

2396

(% class="box infomessage" %)

2397

(((

2398

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2399

)))

2400

2401

(% style="color:#000000" %)Метод запроса: **POST**

2402

2403

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2404

2405

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2406

2407

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2412

"vehicleIds": [0], ~/~/ Список ID объектов

2413

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2414

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2415

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2423

"name": "string", ~/~/ Имя ТС

2424

"periods": [ ~/~/ Периоды

2425

{

2426

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2427

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2428

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2429

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2430

"fuelConsumption": 0, ~/~/ Расход топлива

2431

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

(% class="box warningmessage" %)

2438

(((

2439

Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".

2440

\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".

2441

)))

2442

2443

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2444

2445

(% class="box infomessage" %)

2446

(((

2447

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2448

)))

2449

2450

(% style="color:#000000" %)Метод запроса: **POST**

2451

2452

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2453

2454

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2455

2456

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2461

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2462

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2463

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2471

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2472

"vehicleId": 0, ~/~/ ID объекта

2473

"name": "string", ~/~/ Имя объекта

2474

"model": "string", ~/~/ Модель объекта

2475

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2476

{

2477

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2478

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2479

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2480

"valueFuel": 0, ~/~/ Количество

2481

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2482

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2490

2491

(% class="box infomessage" %)

2492

(((

2493

**POST /api/v3/vehicles/moveStop**

2494

)))

2495

2496

Метод запроса: **POST**

2497

2498

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2499

2500

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2507

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2508

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2509

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2517

"vehicleName": "string", ~/~/ Имя объекта

2518

"moves": [ ~/~/ Событие движения

2519

{

2520

"mileage": 0, ~/~/ Пробег, км

2521

"eventId": 0, ~/~/ Идентификатор события

2522

"eventName": "string", ~/~/ Название события

2523

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2524

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2525

"duration": 0 ~/~/ Продолжительность события, секунд

2526

}

2527

],

2528

"stops": [ ~/~/ События стоянок

2529

{

2530

"address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты

2531

"eventId": 0, ~/~/ Идентификатор события

2532

"eventName": "string", ~/~/ Название события

2533

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2534

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2535

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2543

2544

(% class="box infomessage" %)

2545

(((

2546

**POST /api/v3/vehicles/getlastdata**

2547

)))

2548

2549

Метод запроса: **POST**

2550

2551

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2552

2553

В заголовках запроса: X-Auth: Токен авторизации

2554

2555

2556

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2561

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2562

"vehicleNumber": "string",~/~/Номер объекта.

2563

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2564

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2565

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2566

"speed": 0,~/~/Скорость объекта.

2567

"course": 0,~/~/Курс движения [0;360]

2568

"latitude": 0,~/~/Широта [-90°;90°].

2569

"longitude": 0,~/~/Долгота [-180°;180°].

2570

"address": "string",~/~/Адрес.

2571

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2579

2580

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2581

2582

(% class="box infomessage" %)

2583

(((

2584

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2585

)))

2586

2587

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2588

2589

(% style="color:#000000" %)Метод запроса: **POST**

2590

2591

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2592

2593

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2594

2595

(% style="text-align:left" %)

2596

Тело запроса:

2597

2598

(% style="text-align:left" %)

2599

{

2600

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2601

}

2602

2603

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2609

"name": "string", ~/~/ Название объекта геозоны

2610

"type": 0, ~/~/ Тип объекта геозоны

2611

"fname": "string", ~/~/ Имя файла

2612

"parentId": "string", ~/~/ Идентификатор клиента

2613

"radius": 0, ~/~/ Радиус геообъекта

2614

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2615

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2616

"description": "string", ~/~/ Описание

2617

"area": 0, ~/~/ Площадь, м^^2^^

2618

"perimetr": 0, ~/~/ Периметр, м

2619

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2624

2625

(% class="box infomessage" %)

2626

(((

2627

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2628

)))

2629

2630

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2631

2632

(% style="color:#000000" %)Метод запроса: **POST**

2633

2634

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2635

2636

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2637

2638

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2643

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2644

"ids": [ ], ~/~/ Массив id объектов

2645

"byTime": 0, ~/~/ Объединение событий по времени

2646

"byDist": 0, ~/~/ Объединение событий по расстоянию

2647

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2648

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2655

"geozoneName": "string", ~/~/ Название геообъекта

2656

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2657

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2658

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2659

"vehicleId": 0, ~/~/ ID объекта

2660

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2665

2666

(% class="box infomessage" %)

2667

(((

2668

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2669

)))

2670

2671

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2672

2673

(% style="color:#000000" %)Метод запроса: **POST**

2674

2675

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2676

2677

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2678

2679

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2684

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2685

"ids": [ ], ~/~/ Массив id геообъектов

2686

"byTime": 0, ~/~/ Объединение событий по времени

2687

"byDist": 0, ~/~/ Объединение событий по расстоянию

2688

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2689

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2697

"geozoneName": "string", ~/~/ Название геообъекта

2698

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2699

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2700

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2701

"vehicleId": 0, ~/~/ ID объекта

2702

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2707

2708

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2709

2710

(% class="box infomessage" %)

2711

(((

2712

**POST /api/v3/notifications/find**

2713

)))

2714

2715

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2716

2717

(% style="text-align: left;" %)

2718

Метод запроса **POST**

2719

2720

(% style="text-align: left;" %)

2721

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2722

2723

(% style="text-align: left;" %)

2724

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2725

2726

{

2727

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2735

"name": "string", ~/~/ Название уведомления

2736

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2737

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2738

"userId": "", ~/~/ Пользователь, создавший уведомление

2739

"parentId": "", ~/~/ Идентификатор клиента

2740

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2745

2746

(% class="box infomessage" %)

2747

(((

2748

**GET /api/v3/notifications/{id}**

2749

)))

2750

2751

Метод возвращает данные правил формирования выбранного уведомления.

2752

2753

(% style="text-align: left;" %)

2754

Метод запроса **GET**

2755

2756

(% style="text-align: left;" %)

2757

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2758

2759

(% style="text-align: left;" %)

2760

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2761

2762

(% style="text-align: left;" %)

2763

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2764

2765

(% style="text-align: left;" %)

2766

(% style="color:#000000" %)Ответ:

2767

2768

(% style="text-align: left;" %)

2769

(% style="color:#000000" %){

2770

"id": 0, ~/~/ (%%)id уведомления

2771

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2772

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2773

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2774

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2775

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2776

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2777

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2778

(% style="color:#000000" %) 0

2779

],

2780

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2781

(% style="color:#000000" %) 0

2782

],

2783

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2784

(% style="color:#000000" %) 0

2785

],

2786

"settings": { ~/~/ Список параметров уведомления

2787

"additionalProp1": "string",

2788

"additionalProp2": "string",

2789

"additionalProp3": "string"

2790

},

2791

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2792

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2793

(% style="color:#000000" %) ""

2794

],

2795

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2796

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2797

(% style="color:#000000" %) "string"

2798

],

2799

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2800

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2801

(% style="color:#000000" %) {

2802

"id": 0, ~/~/ (%%)Идентификатор участника чата

2803

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2804

(% style="color:#000000" %) }

2805

],

2806

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2807

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2808

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2809

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2810

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2811

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2812

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2813

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2814

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2815

(% style="color:#000000" %)}

2816

2817

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2818

2819

(% class="box warningmessage" %)

2820

(((

2821

**PUT /api/v3/notifications/**

2822

)))

2823

2824

Метод позволяет отредактировать уведомление.

2825

2826

Метод запроса **PUT**

2827

2828

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2829

2830

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2835

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2836

"userId": "", ~/~/ Пользователь, создавший уведомление

2837

"parentId": "", ~/~/ Идентификатор клиента

2838

"parentName": "string", ~/~/ Имя клиента

2839

"name": "string", ~/~/ Название уведомления

2840

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2841

"vehicleIds": [ ~/~/ Список id объектов для анализа

2842

0

2843

],

2844

"geoids": [ ~/~/ Список id геообъектов для анализа

2845

0

2846

],

2847

"fieldids": [ ~/~/ Список id полей для анализа

2848

0

2849

],

2850

"settings": { ~/~/ Список параметров уведомления

2851

"additionalProp1": "string",

2852

"additionalProp2": "string",

2853

"additionalProp3": "string"

2854

},

2855

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2856

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2857

""

2858

],

2859

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2860

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2861

"string"

2862

],

2863

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2864

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2865

{

2866

"id": 0, ~/~/ Идентификатор участника чата

2867

"info": "string" ~/~/ Дополнительные сведения

2868

}

2869

],

2870

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2871

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2872

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2873

"kind": 0, ~/~/ Определяет вид уведомления

2874

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2875

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2876

"timezone": 0, ~/~/ Сдвиг часового пояса

2877

"validity": 0, ~/~/ Срок действия в днях (1-90)

2878

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==

2887

2888

(% class="box warningmessage" %)

2889

(((

2890

**PUT** /api/v3/notifications/prolongation

2891

)))

2892

2893

Метод позволяет продлить уведомления.

2894

2895

Метод запроса **PUT**

2896

2897

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation

2898

2899

В заголовках запроса: X-Auth: Токен авторизации.

Тело запроса:

[

0

]

где 0 идентификатор ids.

2910

2911

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2912

2913

(% class="box errormessage" %)

2914

(((

2915

**DELETE /api/v3/notifications/{id}**

2916

)))

2917

2918

Метод позволяет удалить выбранное уведомление.

2919

2920

Метод запроса **DELETE**

2921

2922

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2923

2924

Передаваемый параметр: {id} - id уведомления

2925

2926

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2934

2935

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2936

2937

(% class="box infomessage" %)

2938

(((

2939

**POST /api/v3/Drivers/find**

2940

)))

2941

2942

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2949

"description": "string", ~/~/ Определяет описание

2950

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2951

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2952

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2953

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2954

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2955

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2960

2961

(% class="box infomessage" %)

2962

(((

2963

**GET /api/v3/Drivers/{driverGuid}**

2964

)))

2965

2966

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2972

"description": "string", ~/~/ Определяет описание

2973

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2974

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2975

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2976

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2977

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2978

"deleted": true ~/~/ Признак удаления

2979

}

2980

2981

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2982

2983

(% class="box successmessage" %)

2984

(((

2985

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2993

"hiredate": "2023-06-30T12:50:54.020Z",

2994

"chopdate": "2023-06-30T12:50:54.020Z",

2995

"exclusive": true,

2996

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2997

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

3006

"hiredate": "2023-06-30T12:50:54.051Z",

3007

"chopdate": "2023-06-30T12:50:54.051Z",

3008

"exclusive": true,

3009

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3010

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

3016

3017

(% class="box warningmessage" %)

3018

(((

3019

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

3027

"hiredate": "2023-06-30T12:50:27.910Z",

3028

"chopdate": "2023-06-30T12:50:27.910Z",

3029

"exclusive": true,

3030

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3031

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

3040

"hiredate": "2023-06-30T12:50:27.929Z",

3041

"chopdate": "2023-06-30T12:50:27.929Z",

3042

"exclusive": true,

3043

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3044

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

3050

3051

(% class="box errormessage" %)

3052

(((

3053

**DELETE /api/v3/Drivers/{driverGuid}**

3054

)))

3055

3056

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

3064

3065

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

3066

3067

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

3068

3069

(% class="box infomessage" %)

3070

(((

3071

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3079

],

3080

"BeginTime": "2023-06-30T12:49:04.365Z",

3081

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

3090

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3091

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3092

"BeginTime": "2023-06-30T09:52:31.240Z",

3093

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

3099

3100

(% class="box infomessage" %)

3101

(((

3102

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

3112

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

3121

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3122

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3123

"BeginTime": "2023-06-30T09:54:01.631Z",

3124

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

3130

3131

(% class="box successmessage" %)

3132

(((

3133

**POST /api/v3/DriversVehiclesAssignments**

3134

)))

3135

3136

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

3143

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

3144

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3145

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

3146

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

3156

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3157

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3158

"BeginTime": "2023-06-30T11:04:46.903Z",

3159

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

3165

3166

(% class="box warningmessage" %)

3167

(((

3168

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

3177

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3178

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3179

"BeginTime": "2023-06-30T11:14:08.117Z",

3180

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

3190

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3191

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3192

"BeginTime": "2023-06-30T11:14:53.349Z",

3193

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

3199

3200

(% class="box errormessage" %)

3201

(((

3202

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

3217

3218

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

3219

3220

(% class="box infomessage" %)

3221

(((

3222

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3230

],

3231

"BeginTime": "2023-06-30T12:47:12.162Z",

3232

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3240

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3241

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3242

"BeginTime": "2023-06-30T11:19:40.703Z",

3243

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

3249

3250

(% class="box infomessage" %)

3251

(((

3252

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3260

],

3261

"BeginTime": "2023-06-30T12:47:12.162Z",

3262

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3270

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3271

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3272

"BeginTime": "2023-06-30T11:19:40.703Z",

3273

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

3279

3280

(% class="box successmessage" %)

3281

(((

3282

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3290

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3291

"BeginTime": "2023-06-30T11:27:08.635Z",

3292

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3301

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3302

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3303

"BeginTime": "2023-06-30T11:27:08.677Z",

3304

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3310

3311

(% class="box warningmessage" %)

3312

(((

3313

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"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:28:43.330Z",

3324

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3333

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3334

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3335

"BeginTime": "2023-06-30T11:28:43.331Z",

3336

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3342

3343

(% class="box errormessage" %)

3344

(((

3345

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3360

3361

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3362

3363

(% class="box infomessage" %)

3364

(((

3365

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3373

],

3374

"BeginTime": "2023-06-30T12:45:10.852Z",

3375

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3383

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3384

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3385

"BeginTime": "2023-06-30T11:58:04.695Z",

3386

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3392

3393

(% class="box infomessage" %)

3394

(((

3395

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3403

],

3404

"BeginTime": "2023-06-30T12:45:10.852Z",

3405

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3413

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3414

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3415

"BeginTime": "2023-06-30T11:58:04.695Z",

3416

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3422

3423

(% class="box successmessage" %)

3424

(((

3425

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3433

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3434

"BeginTime": "2023-06-30T12:09:53.175Z",

3435

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3444

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3445

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3446

"BeginTime": "2023-06-30T12:09:53.201Z",

3447

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3453

3454

(% class="box warningmessage" %)

3455

(((

3456

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3464

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3465

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3466

"BeginTime": "2023-06-30T12:09:53.201Z",

3467

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3476

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3477

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3478

"BeginTime": "2023-06-30T12:09:53.201Z",

3479

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3485

3486

(% class="box errormessage" %)

3487

(((

3488

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3503

3504

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3505

3506

(% class="box infomessage" %)

3507

(((

3508

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3515

"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);" %)**Описание**

3521

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3522

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3523

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3524

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3531

"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",

3541

"name": "string",

3542

"rid": "string",

3543

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3544

"trailer": {

3545

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3546

"Number": "string",

3547

"Description": "string",

3548

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3549

"ExternalID": "string",

3550

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3551

"CreateTime": "2023-11-14T10:48:03.717Z",

3552

"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);" %)**Описание**

3560

|SD|Дата и время начала события

3561

|ED|Дата и время окончания события

3562

|id|ID объекта

3563

|SLat|Широта начальной координаты

3564

|SLon|Долгота начальной координаты

3565

|ELat|Широта конечной координаты

3566

|ELon|Долгота конечной координаты

3567

|mileage|Пробег

3568

|Duration|Продолжительность

3569

|Address|Адрес начального местоположения

3570

|Address2|Адрес конечного местоположения

3571

|name|Имя радиометки

3572

|rid|Номер радиометки

3573

|rguid|ID радиометки

3574

|trailer|Информация об агрегате

3575

|ModelGuid|ID агрегата

3576

|Number|Название/номер агрегата

3577

|Description|Текст примечания агрегата

3578

3579

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3580

3581

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3582

3583

(% class="box infomessage" %)

3584

(((

3585

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3602

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3607

|parentId|ID клиента

3608

|name|Название карты-метки

3609

|number|Номер

3610

|period|Период запросов в секундах (работает только для агрегатов)

3611

|id|ID карты-метки

3612

3613

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3614

3615

(% class="box infomessage" %)

3616

(((

3617

**GET /api/v3/Rfids/{rfidGuid}**

3618

)))

3619

3620

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3630

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3635

|name|Название карты-метки

3636

|number|Номер

3637

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3642

3643

(% class="box successmessage" %)

3644

(((

3645

**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",

3664

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3665

}

3666

3667

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3668

|name|Название карты-метки

3669

|number|Номер

3670

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3675

3676

(% class="box warningmessage" %)

3677

(((

3678

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3688

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3698

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3699

}

3700

3701

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3702

|name|Название карты-метки

3703

|number|Номер

3704

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3709

3710

(% class="box errormessage" %)

3711

(((

3712

**DELETE /api/v3/Rfids/{rfidGuid}**

3713

)))

3714

3715

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3723

3724

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3725

3726

(% class="box infomessage" %)

3727

(((

3728

**GET /api/v3/Billing/client/balance/{clientId}**

3729

)))

3730

3731

Параметр запроса: **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);" %)**Описание**

3741

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3742

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3743

3744

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3745

3746

(% class="box infomessage" %)

3747

(((

3748

**GET /api/v3/Billing/client/constraint/{clientId}**

3749

)))

3750

3751

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3757

"CalculationType": 0,

3758

"PermissibleBalance": 0,

3759

"DefermentDays": 0,

3760

"SendUiNotifications": true,

3761

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3766

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3767

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3768

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3769

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3770

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3771

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3772

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3773

3774

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3775

3776

(% class="box infomessage" %)

3777

(((

3778

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3784

3785

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3791

"Plan": { **~/~/ Описание тарифного плана**

3792

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3793

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3798

"PermissibleBalance": 0,

3799

"DefermentDays": 0

3800

},

3801

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3813

"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);" %)**Описание**

3829

|ClientId|Идентификатор клиента

3830

|Id|Идентификатор тарифного плана

3831

|OwnerId|Идентификатор клиента-владельца

3832

|Name|Наименование тарифного плана

3833

|IsArchived|Признак, определяющий архивный тарифный план

3834

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3835

|PermissibleBalance|Допустимый баланс

3836

|DefermentDays|Отсрочка, количество дней

3837

|Feature|Код услуги

3838

|IsEnabled|Признак, определяющий активирована ли услуга

3839

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3840

|IsFactual|Признак, определяющий расчёт по факту

3841

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3842

|Price|Цена за единицу.

3843

|DebitDate|Следующий момент времени списания с баланса за услугу.

3844

|PeriodValue|Значение периода.

3845

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3846

3847

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3848

3849

(% class="box infomessage" %)

3850

(((

3851

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3852

)))

3853

3854

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3861

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3866

"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);" %)**Описание**

3883

|ClientId|Идентификатор клиента

3884

|Id|Идентификатор тарифного плана

3885

|OwnerId|Идентификатор клиента-владельца

3886

|Name|Наименование тарифного плана

3887

|IsArchived|Признак, определяющий архивный тарифный план

3888

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3889

|PermissibleBalance|Допустимый баланс

3890

|DefermentDays|Отсрочка, количество дней

3891

|Feature|Код услуги

3892

|IsFactual|Признак, определяющий расчёт по факту

3893

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3894

|Price|Цена за единицу.

3895

|PeriodValue|Значение периода.

3896

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3897

3898

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3899

3900

(% class="box infomessage" %)

3901

(((

3902

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3903

)))

3904

3905

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3912

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3917

"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);" %)**Описание**

3934

|ClientId|Идентификатор клиента

3935

|Id|Идентификатор тарифного плана

3936

|OwnerId|Идентификатор клиента-владельца

3937

|Name|Наименование тарифного плана

3938

|IsArchived|Признак, определяющий архивный тарифный план

3939

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3940

|PermissibleBalance|Допустимый баланс

3941

|DefermentDays|Отсрочка, количество дней

3942

|Feature|Код услуги

3943

|IsFactual|Признак, определяющий расчёт по факту

3944

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3945

|Price|Цена за единицу.

3946

|PeriodValue|Значение периода.

3947

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3948

3949

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3950

3951

(% class="box warningmessage" %)

3952

(((

3953

**PUT /api/v3/Billing/client/balance**

3954

)))

3955

3956

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3968

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3969

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3970

3971

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3972

3973

(% class="box warningmessage" %)

3974

(((

3975

**PUT /api/v3/billing/client/balance/deposit**

3976

)))

3977

3978

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3990

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3991

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3992

3993

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3994

3995

Создает операцию **Списание **с указанной суммой

3996

3997

(% class="box warningmessage" %)

3998

(((

3999

**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);" %)**Описание**

4012

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

4013

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

4014

4015

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

4016

4017

(% class="box warningmessage" %)

4018

(((

4019

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4026

"CalculationType": 0,

4027

"PermissibleBalance": 0,

4028

"DefermentDays": 0,

4029

"SendUiNotifications": true,

4030

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4037

|ClientId|Идентификатор клиента

4038

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

4039

|PermissibleBalance|Допустимый баланс

4040

|DefermentDays|(((

4041

Отсрочка, количество дней

4042

)))

4043

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

4044

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

4045

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

4046

4047

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

4048

4049

(% class="box warningmessage" %)

4050

(((

4051

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4058

"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);" %)**Описание**

4076

|ClientId|Идентификатор клиента

4077

|PlanId|Идентификатор тарифного плана

4078

|Feature|Код услуги

4079

|IsEnabled|Признак, определяющий активирована ли услуга

4080

|IsFactual|Признак, определяющий расчёт по факту

4081

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

4082

|Price|Цена за единицу.

4083

|DebitDate|Следующий момент времени списания с баланса за услугу.

4084

|PeriodValue|Значение периода.

4085

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

4086

4087

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

4088

4089

(% class="box warningmessage" %)

4090

(((

4091

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

4092

)))

4093

4094

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

4095

4096

(% class="box infomessage" %)

4097

(((

4098

**POST /api/v3/vehicles/import/{agentId}**

4099

)))

4100

4101

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

4102

4103

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4112

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

4113

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

4114

4115

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4120

|data|В значении передаем файл объекта, формат **xml** или **wlp **

4121

|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);" %)**Описание**

4132

|vehicleId|ID созданного объекта

4133

|name|Имя созданного объекта

4134

|errors|Ошибки и их описание

4135

4136

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

4137

4138

(% class="box infomessage" %)

4139

(((

4140

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

4141

)))

4142

4143

(% class="wikigeneratedid" %)

4144

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

4145

4146

(% class="wikigeneratedid" %)

4147

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

4152

4153

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4158

|**history**|В значении передавать файл с историей

4159

4160

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

4173

"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);" %)**Описание**

4181

|results|Результаты импорта в разрезе ТС

4182

|vehicleGuid|Guid ТС

4183

|vehicleId|ID ТС

4184

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

4185

|firstMessageDate|Дата первого импортированного сообщения (UTC)

4186

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

4187

|producedCount|Кол-во успешно отправленных в шину данных сообщений

4188

|msgCount|Кол-во обработанных сообщений всего

4189

4190

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

4191

4192

(% class="box infomessage" %)

4193

(((

4194

**GET /api/v3/vehicles/import/history/status**

4195

)))

4196

4197

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4208

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

4209

|progress|Guid ТС

4210

4211

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

4212

4213

(% class="box infomessage" %)

4214

(((

4215

**POST /api/v3/vehicles/export**

4216

)))

4217

4218

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

4227

4228

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

4229

4230

(% class="box infomessage" %)

4231

(((

4232

**POST /api/v3/vehicles/export/history**

4233

)))

4234

4235

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4243

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4249

4250

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4251

|vehicleId|ID объекта

4252

|asArchive|true - Архивировать файл, False - не архивировать

4253

|from|Дата и время начала запроса

4254

|to|Дата и время окончания запроса

4255

4256

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4257

4258

(% class="box infomessage" %)

4259

(((

4260

**GET /api/v3/vehicles/export/history/status**

4261

)))

4262

4263

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4274

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4275

|progress|Прогресс экспорта, от 0 до 100%

4276

|message|Текст описывающий статус

4277

4278

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4279

4280

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4281

4282

(% class="box infomessage" %)

4283

(((

4284

**POST /api/v3/EcoDriving/rating**

4285

)))

4286

4287

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId], ~/~/Массив ID объектов

4293

"from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса

4294

"to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса

}

Ответ:

{

"items": [ ~/~/ Список в разрезе ТС

4301

{

4302

"from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода

4303

"to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода

4304

"vehicleId": 0, ~/~/ ID ТС

4305

"vehicleName": "string", ~/~/ Название ТС

4306

"vehicleModel": "string", ~/~/ Модель ТС

4307

"penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС

4308

"score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС

4309

"totalViolations": 0, ~/~/ Нарушений всего

4310

"violationsByType": { ~/~/ Информация о нарушениях по типу

4311

"overspeedingViolations": 0, ~/~/ Нарушений превышения скорости

4312

"accelerationViolations": 0, ~/~/ Нарушений ускорения

4313

"brakingViolations": 0, ~/~/ Нарушений торможения

4314

"turningViolations": 0, ~/~/ Нарушений опасного поворота

4315

"dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения

4316

"sensorViolations": 0 ~/~/ Нарушений по датчику

},

(((

)))

"moveTime": 0, ~/~/ Продолжительность движения, сек

4324

"mileage": 0, ~/~/ Пробег, м

4325

"tripsCount": 0, ~/~/ Кол-во рейсов

4326

"trips": [ ~/~/ Информация по рейсу

4327

{

4328

"penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс

4329

"score": 0, ~/~/ Рассчитанная оценка вождения за рейс

4330

"violationsCount": 0, ~/~/ Всего нарушений

4331

"violationsByType": { ~/~/ Информация о нарушениях по типу

4332

"overspeedingViolations": 0, ~/~/ Нарушений превышения скорости

4333

"accelerationViolations": 0, ~/~/ Нарушений ускорения

4334

"brakingViolations": 0, ~/~/ Нарушений торможения

4335

"turningViolations": 0, ~/~/ Нарушений опасного поворота

4336

"dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения

4337

"sensorViolations": 0 ~/~/ Нарушений по датчику

4338

},

4339

4340

"startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки

4341

"endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки

4342

"moveTime": 0, ~/~/ Продолжительность движения, сек

4343

"mileage": 0, ~/~/ Пробег, м

4344

"motohours": 0, ~/~/ Моточасы, секунды

4345

"maxSpeed": 0, ~/~/ Максимальная скорость за рейс

4346

"startAddress": "string", ~/~/ Адрес начала рейса

4347

"endAddress": "string", ~/~/ Адрес конца рейса

4348

"drivers": [ ~/~/ Список водителей

4349

{

4350

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя

4351

"driverName": "string", ~/~/ФИО водителя

4352

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки

}

]

}

]

}

]

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4362

4363

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4364

4365

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4366

4367

(% class="box infomessage" %)

4368

(((

4369

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4375

\\В заголовках запроса: X-Auth: Токен авторизации

4376

4377

Параметры в теле запроса (JSON):

4378

4379

{

4380

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4381

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4382

"ids": [

4383

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4384

],

4385

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4392

"driver": "string", ~/~/Водители, привязанные к ТК

4393

"object": "string", ~/~/Наименование ТС

4394

"amount": 0, ~/~/Количество топлива

4395

"amountDut": 0, ~/~/Количество по ДУТ

4396

"amountDiff": 0, ~/~/Разница, л

4397

"amountDiffPerc": 0, ~/~/Разница, %

4398

"summa": 0, ~/~/Стоимость, руб

4399

"serviceName": "string", ~/~/Тип топлива

4400

"price": 0, ~/~/Цена за литр, руб

4401

"cardName": "string", ~/~/Наименование ТК

4402

"cardNum": "string", ~/~/Номер ТК

4403

"operator": "string", ~/~/Оператор ТК

4404

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4409

4410

4411

== **Получение полных данных о ретрансляторе** ==

4412

4413

(% class="box infomessage" %)

4414

(((

4415

**GET ** **/api/v3/retranslations/{id}**

4416

)))

4417

4418

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4425

"subscriberId": "", ~/~/ Подписчик

4426

"protocolType": 0, ~/~/ Тип протокола

4427

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4428

"address": "string", ~/~/ Адрес события

4429

"objects": [ ~/~/Объекты для ретрансляции

4430

{

4431

"id": "", ~/~/ Идентификатор объекта ретрансляции

4432

"name": "", ~/~/ Наименование объекта ретрансляции

4433

"imei": "", ~/~/ IMEI объекта

4434

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4435

}

4436

],

4437

"id": "", ~/~/ идентификатор пользователя

4438

"parentId": "", ~/~/Guid родителя

4439

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4444

4445

(% class="box infomessage" %)

4446

(((

4447

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4454

4455

(% class="box infomessage" %)

4456

(((

4457

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4464

"subscriberId": "", ~/~/ Подписчик

4465

"protocolType": 0, ~/~/ Тип протокола

4466

"address": "", ~/~/ Адрес ретрансляции

4467

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4468

"objects": [ ~/~/Объекты для ретрансляции

4469

{

4470

"id": "", ~/~/ идентификатор пользователя

4471

"imei": "", ~/~/IMEI объекта

4472

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4482

"subscriberId": "", ~/~/ идентификатор запроса

4483

"protocolType": 0, ~/~/ Тип протокола

4484

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4485

"address": "", ~/~/ Адрес события

4486

"objects": [ ~/~/Объекты для ретрансляции

4487

{

4488

"id": "", ~/~/ идентификатор пользователя

4489

"name": "string", ~/~/ Название уведомления

4490

"imei": "string", ~/~/IMEI объекта

4491

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4492

}

4493

],

4494

"id": "", ~/~/ идентификатор пользователя

4495

"parentId": "", ~/~/ Guid идентификатор родителя

4496

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4501

4502

(% class="box infomessage" %)

4503

(((

4504

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4511

"description": "string", ~/~/ Определяет описание

4512

"subscriberId": "", ~/~/ идентификатор запроса

4513

"protocolType": 0, ~/~/ Тип протокола

4514

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4515

"address": "string", ~/~/ Адрес события

4516

"objects": ~/~/Объекты для ретрансляции

4517

[

4518

{

4519

"id": "", ~/~/ идентификатор пользователя

4520

"imei": "", ~/~/IMEI объекта

4521

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4531

"subscriberId": "", ~/~/ идентификатор запроса

4532

"protocolType": 0, ~/~/ Тип протокола

4533

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4534

"address": "string", ~/~/ Адрес события

4535

"objects": [ ~/~/Объекты для ретрансляции

4536

{

4537

"id": "", ~/~/ идентификатор пользователя

4538

"name": "string", ~/~/ Название уведомления

4539

"imei": "", ~/~/IMEI объекта

4540

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4541

}

4542

],

4543

"id": "", ~/~/ идентификатор пользователя

4544

"parentId": "", ~/~/ Guid идентификатор родителя

4545

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4550

4551

(% class="box infomessage" %)

4552

(((

4553

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4560

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4561

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4569

"subscriberId": "", ~/~/ идентификатор запроса

4570

"protocolType": 0, ~/~/ Тип протокола

4571

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4572

"address": "string", ~/~/ Адрес события

4573

"id": "", ~/~/ идентификатор пользователя

4574

"parentId": "", ~/~/ Guid идентификатор родителя

4575

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4581

4582

== **API для отчета по выгрузке комбайнов** ==

4583

4584

(% class="box infomessage" %)

4585

(((

4586

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4593

"byDist": 0, ~/~/ Объединение событий по расстоянию

4594

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4595

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4596

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4597

"vehicleIds": [ ~/~/ Список id объектов для анализа

4598

0

4599

],

4600

"from": "", ~/~/ Дата и время начало запроса

4601

"to": "", ~/~/ Дата и время окончания запроса

4602

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4610

"harvesterId": 0, ~/~/Комбайн, id

4611

"harvesterModel": "", ~/~/ Модель комбайна

4612

"hopperCapacity": 0, ~/~/ Объем бункера м3

4613

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4614

"events": [ ~/~/Список событий в разрезе комбайна

4615

{

4616

"driverId": "", ~/~/Идентификатор водителя

4617

"driverName": "", ~/~/Водитель комбайна, ФИО

4618

"RFID": "", ~/~/ идентификатор карты-метки

4619

"rfidName": "", ~/~/Водитель комбайна, имя метки

4620

"vehicleId": 0, ~/~/идентификатор объекта

4621

"vehicleName": "string", ~/~/ Имя объекта

4622

"modelName": "string", ~/~/ Имя модели объекта

4623

"nearestVehicles": [ ~/~/Объекты рядом

4624

{

4625

"vehicleId": 0, ~/~/идентификатор объекта

4626

"vehicleName": "string" ~/~/ Имя объекта

4627

}

4628

],

4629

"fields": [ ~/~/Поля, где происходила выгрузка

4630

{

4631

"id": 0, ~/~/ идентификатор пользователя

4632

"name": "string" ~/~/ имя пользователя

4633

}

4634

],

4635

"event": "string", ~/~/Событие

4636

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4637

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4638

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4639

"cultureName": "string", ~/~/ название культуры

4640

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4641

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4642

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4643

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4644

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4645

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4646

"issued": 0, ~/~/Выдано, бункеров

4647

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4648

"latitude": 0, ~/~/Широта

4649

"longitude": 0, ~/~/ Долгота

4650

"litresAway": 0, ~/~/Отдано, л

4651

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4659

4660

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4661

4662

4663

(% class="box infomessage" %)

4664

(((

4665

GET api/v3/Vehicles/recyclebin/all

4666

)))

4667

4668

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4669

4670

Параметр запроса: {parentId} - идентификатор агента

4671

4672

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4679

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4680

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4681

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4682

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4683

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4684

"details": { ~/~/Список деталей объекта, помещённого в корзину

4685

"items": [ ~/~/

4686

nullable: true ~/~/Детали

4687

{

4688

"name": "string", ~/~/наименование столбца

4689

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4701

4702

(% class="box infomessage" %)

4703

(((

4704

POST/api/v3/Vehicles/recyclebin/erase

4705

)))

4706

4707

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4721

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4722

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4723

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4724

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4725

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4726

"details": { ~/~/Список деталей объекта, помещённого в корзину

4727

"items": [ ~/~/Детали

4728

{

4729

"name": "", ~/~/Имя свойства

4730

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4741

4742

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4743

4744

(% class="box infomessage" %)

4745

(((

4746

POST/api/v3/Vehicles/recyclebin/restore

4747

)))

4748

4749

В заголовках запроса: X-Auth: Токен авторизации

4750

4751

Параметры в теле запроса (JSON):

4752

4753

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4754

4755

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4778

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4779

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4780

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4781

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4782

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4783

"details": { ~/~/Список деталей объекта, помещённого в корзину

4784

"items": [ ~/~/Детали

4785

{

4786

"name": "string", ~/~/Имя свойства

4787

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4800

(((

4801

(% 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]] **

4802

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню