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

1

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

2

(((

3

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

)))

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

10

11

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

12

13

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

14

15

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

16

17

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

18

19

20

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

21

22

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

23

24

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

25

26

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

27

(((

28

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

29

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

30

)))

31

32

(% class="box successmessage" %)

33

(((

34

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

35

)))

36

37

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

38

39

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

40

41

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

42

43

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

44

45

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

46

47

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

48

"login": "testuser",

49

"password": "testuser"

50

}

51

52

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

53

54

(% lang="en-US" %)

55

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

56

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

57

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

58

}

59

60

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

61

62

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

63

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

64

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

65

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

66

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

67

68

(% class="wikigeneratedid" %)

69

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

70

71

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

72

73

(% class="box infomessage" %)

74

(((

75

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

76

)))

77

78

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

79

80

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

81

82

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

83

84

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

85

86

(% lang="en-US" %)

87

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

88

89

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

90

91

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

92

93

(% class="box infomessage" %)

94

(((

95

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

96

)))

97

98

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

99

100

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

101

102

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

103

104

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

105

106

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

107

108

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

{

"agentId": "", (%%)

"parentId": "",

"parentName": "string",

113

"name": "string",

114

"fullName": "string",

115

"agentInfoType": 0,

116

"isForeign": true/false,

117

"district": "string",

"region": "string",

"city": "string",

"inn": "string",

"kpp": "string",

"address": "string",

"addressFact": "string",

124

"email": "string",

125

"director": "string",

126

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

154

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

155

156

(% class="box infomessage" %)

157

(((

158

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

159

)))

160

161

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

162

163

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

164

165

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

166

167

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

168

169

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

170

171

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

172

173

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

174

175

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

"parentId": "string"

}

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

180

181

{

182

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

183

"parentId": "",

184

"name": "string",

185

"fullName": "string",

186

"agentInfoType": 0,

187

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

}

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

192

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

193

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

194

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

195

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

196

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

197

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

198

199

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

200

201

(% class="box successmessage" %)

202

(((

203

**POST /api/v3/agents **

204

)))

205

206

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

207

208

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

209

210

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

211

212

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

213

214

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

215

216

{

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

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

}

Ответ:

{

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

}

260

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

283

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

284

285

(% class="box warningmessage" %)

286

(((

287

**PUT /api/v3/agents**

288

)))

289

290

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

291

292

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

293

294

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

295

296

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

297

298

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

299

300

{

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

}

Ответ:

{

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

}

344

345

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

346

347

(% class="box errormessage" %)

348

(((

349

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

350

)))

351

352

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

353

354

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

355

356

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

357

358

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

359

360

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

361

362

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

363

364

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

365

366

(% class="box warningmessage" %)

367

(((

368

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

369

)))

370

371

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

372

373

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

374

375

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

Ответ: Code 204

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

380

381

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

382

383

(% class="box successmessage" %)

384

(((

385

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

386

)))

387

388

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

389

390

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

391

392

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

393

394

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

395

396

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

397

398

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

399

{

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

"doubleAuth":

416

{

417

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

418

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

},

"groups":

[

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

],

"customGroups":

[

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

427

],

428

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

429

}

430

{

431

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

432

"lastName": "string",

433

"firstName": "string",

434

"position": "string",

435

"phone": "string",

436

"organization": "string",

437

"login": "string",

438

"password": "string",

439

"email": "string",

440

441

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

442

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

443

{

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

}

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

465

466

(% class="box infomessage" %)

467

(((

468

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

469

)))

470

471

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

472

473

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

474

475

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

476

477

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

478

479

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

480

481

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

482

483

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

484

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

485

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

486

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

487

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

488

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

489

490

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

491

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

508

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

509

510

(% class="box infomessage" %)

511

(((

512

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

513

)))

514

515

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

516

517

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

518

519

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

520

521

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

522

523

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

(((

(((

{

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

"doubleAuth":

543

{

544

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

545

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

546

},

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

}

)))

)))

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

561

562

(% class="box warningmessage" %)

563

(((

564

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

565

)))

566

567

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

568

569

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

570

571

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

572

573

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

574

575

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

576

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

577

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

"doubleAuth":

597

{

598

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

599

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

600

},

601

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

602

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

603

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

604

605

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

606

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

607

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

"doubleAuth":

624

{

625

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

626

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

627

},

628

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

629

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

630

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

631

}

632

633

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

634

635

(% class="box warningmessage" %)

636

(((

637

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

638

)))

639

640

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

641

642

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

643

644

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

645

646

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

647

648

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

649

650

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

651

652

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

653

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

654

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

655

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

656

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

657

658

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

659

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

660

661

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

662

663

(% class="box warningmessage" %)

664

(((

665

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

666

)))

667

668

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

669

670

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

671

672

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

673

674

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

675

676

[

677

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

678

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

679

]

680

681

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

682

683

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

684

685

(% class="box warningmessage" %)

686

(((

687

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

688

)))

689

690

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

691

692

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

693

694

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

695

696

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

697

698

[

699

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

700

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

701

]

702

703

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

704

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

(((

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

{

"errorMessages": [

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

711

],

712

"users": [

713

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

714

]

715

}

716

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

717

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

718

)))

719

720

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

721

722

(% class="box errormessage" %)

723

(((

724

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

725

)))

726

727

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

728

729

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

730

731

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

732

733

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

734

735

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

736

737

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

738

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

739

740

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

741

742

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

743

744

(% class="box infomessage" %)

745

(((

746

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

747

)))

748

749

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

750

751

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

752

753

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

754

755

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

756

757

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

758

759

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

760

761

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

762

"parentName": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

769

"hoppercapacity": 0,

770

"hopperdischargespeed": 0,

771

"modelType": 0,

772

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

773

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

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

788

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

789

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

790

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

791

792

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

793

794

(% class="box successmessage" %)

795

(((

796

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

797

)))

798

799

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

800

801

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

802

803

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

804

805

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

806

807

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

808

809

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

810

}

811

812

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

813

814

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

815

{

816

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

817

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

818

"parentName": "string",

"name": "string",

"modelType": 0

}

]

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

825

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

826

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

827

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

828

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

829

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

830

831

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

832

833

(% class="box successmessage" %)

834

(((

835

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

836

)))

837

838

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

839

840

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

841

842

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

843

844

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

845

846

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

847

848

{

849

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

850

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

859

"fueloutlay": 0,

860

"hoppercapacity": 0,

861

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

869

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

878

"hoppercapacity": 0,

879

"hopperdischargespeed": 0,

"modelType": 0

}

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

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

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

894

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

895

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

896

897

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

898

899

(% class="box warningmessage" %)

900

(((

901

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

902

)))

903

904

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

905

906

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

907

908

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

909

910

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

911

912

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

913

914

{

915

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

916

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

925

"fueloutlay": 0,

926

"hoppercapacity": 0,

927

"hopperdischargespeed": 0,

"modelType": 0

}

Ответ:

{

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

935

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

"deleted": true,

"extId": "string",

"name": "string",

"picture": "string",

"minspeed": 0,

"maxspeed": 0,

"width": 0,

"imbeddedtrailer": true,

944

"fueloutlay": 0,

945

"hoppercapacity": 0,

946

"hopperdischargespeed": 0,

"modelType": 0

}

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

964

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

965

966

(% class="box errormessage" %)

967

(((

968

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

969

)))

970

971

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

972

973

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

974

975

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

976

977

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

978

979

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

980

981

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

982

983

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

984

985

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

986

987

(% class="box infomessage" %)

988

(((

989

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

990

)))

991

992

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

993

994

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

995

996

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

997

998

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

999

1000

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

1001

1002

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

1003

1004

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

1005

1006

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

1007

1008

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

(((

{

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

},

1028

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

1029

{

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

}

1037

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

},

1063

1064

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

1065

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

1066

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

1067

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

1068

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

1069

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

1070

},

1071

1072

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

1073

{

1074

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

1075

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

1076

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

1077

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

1078

}

1079

],

1080

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

1081

{

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

1094

{

1095

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

1096

{

1097

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

1098

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

1099

}

1100

],

1101

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

1102

}

1103

],

1104

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

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

"string"

1112

],

1113

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

1114

"additionalProp1": "string",

1115

"additionalProp2": "string",

1116

"additionalProp3": "string"

1117

},

1118

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

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

1130

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

1131

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

1132

}

1133

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

1134

{

1135

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

1136

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

1137

"description": "string",

1138

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

1139

}

1140

],

1141

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

1142

{

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

1155

}

1156

],

1157

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

1158

{

1159

"status": 0,

1160

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

1161

"description": "string",

1162

"additionalInfo": "string"

}

]

}

)))

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

1169

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

1170

1171

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

1172

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

1173

1174

1175

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

1176

1177

(% class="box successmessage" %)

1178

(((

1179

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

1180

)))

1181

1182

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

1183

1184

{

1185

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

1186

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

1187

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

1188

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

}

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

1193

1194

(% class="box infomessage" %)

1195

(((

1196

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

1197

)))

1198

1199

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

1200

1201

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

1202

1203

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

1204

1205

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

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

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

1213

1214

(((

1215

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

1216

1217

(% class="box infomessage" %)

1218

(((

1219

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

1220

)))

1221

1222

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

1223

1224

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

1225

1226

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

[

{

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

1231

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

1232

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

1233

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

1234

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

1235

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

1236

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

}

]

)))

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

1242

1243

(% class="box successmessage" %)

1244

(((

1245

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

1246

)))

1247

1248

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

1249

1250

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

1251

1252

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

1253

1254

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

1255

1256

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

1257

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

"mileageCalcMethod": 0,

1280

"mileageCoeff": 0,

1281

"locationByCellId": true,

1282

"dottedLineTrackWhenNoCoords": true,

1283

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

1284

{

1285

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

1286

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

1287

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

1288

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

1289

},

1290

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

1291

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

1292

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

1293

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

1294

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

1295

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

1296

},

1297

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

1298

{

1299

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

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

}

1311

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

1312

{

1313

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

"isDefault": true

}

],

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

1318

{

1319

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1326

{

1327

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

1328

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

1329

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

1330

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

1331

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

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1339

{

1340

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

1341

{

1342

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

1343

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

1344

}

1345

],

1346

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

1347

}

1348

],

1349

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

1350

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

1351

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

1352

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

1353

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

1354

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

1355

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

1356

"string"

1357

],

1358

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

1359

"additionalProp1": "string",

1360

"additionalProp2": "string",

1361

"additionalProp3": "string"

1362

},

1363

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

1364

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

1365

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

1366

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

1367

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

1368

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

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

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

1376

1377

(((

1378

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

1379

{

1380

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

1381

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

1382

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

}

]

}

],

)))

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

1390

1391

1392

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

1393

{

1394

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

1395

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

1396

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

1397

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

1398

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

1399

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

}

]

}

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

(((

(((

(((

{

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

1412

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

1413

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

1414

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

1415

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

1416

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

1417

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

1418

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

1419

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

1420

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

1421

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

1422

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

1423

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1424

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1425

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1426

"consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1427

"consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1428

"consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1429

"consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1430

"consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1431

"consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1432

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)

1433

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

1434

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

1435

"dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.

1436

"showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.

1437

"counters": { ~/~/ Dto для состояний счётчиков

1438

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

1439

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

1440

"mileage": 0, ~/~/ Пробег

1441

"motohours": 0 ~/~/ Моточасы

1442

},

1443

"cmsv6Parameters": { ~/~/ Dto для CMSv6

1444

"id": "string", ~/~/ CMSV6 Идентификатор

1445

"enabled": true, ~/~/ Признак включения

1446

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1447

"login": "string", ~/~/ CMSV6 имя учетной записи

1448

"password": "string" ~/~/ CMSV6 — пароль учетной записи

1449

},

1450

"inspectionTasks": [ ~/~/ Dto для описания задачи на ТО

1451

{

1452

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи

1453

"enabled": true, ~/~/ Признак включения

1454

"name": "string", ~/~/ Имя задания

1455

"description": "string", ~/~/ Описание задания

1456

"mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)

1457

"lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО

1458

"motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)

1459

"lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО

1460

"periodicCondition": 0, ~/~/ Условие периодичности по времени

1461

"kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)

1462

"lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО

1463

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

1464

}

1465

],

1466

"drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.

1467

{

1468

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

1469

"inputNumber": 0, ~/~/ № входа.

1470

"createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.

1471

"comment": "string", ~/~/ Комментарий

1472

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

1473

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

1474

"beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.

1475

"endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.

1476

}

1477

],

1478

"commandTemplates": [ ~/~/ Список шаблонов команд

1479

{

1480

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

1481

"name": "string", ~/~/ Название шаблона команд

1482

"command": "string", ~/~/ Команда на выполнение

1483

"retries": 0 ~/~/ Лимит попыток отправки

1484

}

1485

],

1486

"sensors": [ ~/~/ Список датчиков

1487

{

1488

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1489

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

1490

"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

1491

"name": "string", ~/~/ Имя датчика

1492

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

1493

"inputNumber": 0, ~/~/ Номер входа

1494

"pseudonym": "string", ~/~/ Псевдоним

1495

"medianDegree": 0, ~/~/ Степень медианной фильтрации

1496

"isInverted": true, ~/~/ Признак инверсии

1497

"disabled": true, ~/~/ Датчик не участвует в обработке

1498

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1499

"gradesTables": [ ~/~/ Тарировка

1500

{

1501

"grades": [ ~/~/ Таблицы тарировки

1502

{

1503

"input": 0, ~/~/ Вход

1504

"output": 0 ~/~/ Выход

1505

}

1506

],

1507

"relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

1508

}

1509

],

1510

"showInTooltip": true, ~/~/ Отображение в подсказке

1511

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1512

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1513

"showWithoutIgn": true, ~/~/ Отображать без включенного зажигания

1514

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

1515

"expr": "string", ~/~/ Выражение

1516

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

"string"

],

"customParams": {

"additionalProp1": "string",

1521

"additionalProp2": "string",

1522

"additionalProp3": "string"

1523

},

1524

"summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.

1525

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1526

{

1527

"from": 0, ~/~/ С какого значения

1528

"color": "string", ~/~/ Каким цветом

)))

(((

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1538

"customFields": [ ~/~/ Список произвольных полей

1539

{

1540

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1541

"name": "string", ~/~/ Наименование произвольного поля

1542

"value": "string", ~/~/ Значение произвольного поля

1543

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

1544

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

1545

"forReport": true ~/~/ Отобразить произвольное поле в отчете

1546

}

1547

],

1548

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor

}

)))

)))

)))

**Валидация:**

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1557

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1558

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1559

1560

== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==

1561

1562

(% class="box infomessage" %)

1563

(((

1564

(% lang="en-US" %)**POST /api/v3/vehicles/find**

1565

)))

1566

1567

(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

1568

1569

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:

1570

1571

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

1572

1573

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

1574

1575

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

1576

1577

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

1578

1579

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

1580

1581

(% style="color:#000000" %)Метод запроса: **POST**

1582

1583

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

1584

1585

(% style="color:#000000" %)В заголовках запроса:

1586

1587

(% style="color:#000000" %)− Content-Type: __**application/json**__

1588

1589

(% style="color:#000000" %)− X-Auth: Токен авторизации

1590

1591

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

1592

1593

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1594

1595

{

1596

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1597

"name": null, ~/~/ Имя ТС (string, опционально)

1598

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1599

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1600

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1601

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1602

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1603

"customFields": null ~/~/ значение любого из произвольных полей ТС

1604

}

1605

1606

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1607

1608

(% style="color:#000000" %)Ответ:

1609

1610

(% style="color:#000000" %){

1611

"vehicleId": "" ~/~/ идентификатор объекта

1612

"name": "" ~/~/ наименование объекта

1613

"imei": "" ~/~/ IMEI объекта

1614

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1615

"deviceTypeName": "" ~/~/ наименование типа устройства

1616

"sim1": "" ~/~/ первый номер телефона

1617

"sim2": "" ~/~/ второй номер телефона

1618

"parentId": "" ~/~/ идентификатор клиента-родителя

1619

"parentName": "" ~/~/ наименование клиента-родителя

1620

"modelId": "" ~/~/ идентификатор модели объекта

1621

"modelName": "" ~/~/ наименование модели объекта

1622

"unitId": "" ~/~/ идентификатор подразделения

1623

"unitName": "" ~/~/ наименование подразделения

1624

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1625

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1626

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1627

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1628

"customFields": [

1629

{

1630

"id": "", ~/~/ идентификатор произвольного поля

1631

"name": "", ~/~/ имя произвольного поля

1632

"value": "", ~/~/ значение произвольного поля

1633

"forClient": true, ~/~/ право на отображение у клиента

1634

"forTooltip": false, ~/~/ право на отображение в подсказке

1635

"forReport": false ~/~/ право на отображение в отчетах

1636

}(%%)

1637

(% style="color:#000000" %)}

1638

1639

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1640

1641

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1642

1643

(% class="box successmessage" %)

1644

(((

1645

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

1646

)))

1647

1648

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.

1649

1650

(% style="color:#000000" %)Метод запроса: **POST**

1651

1652

(% 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}

1653

1654

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1655

1656

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1657

1658

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1659

1660

(% style="color:#000000" %){

1661

1662

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1663

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1664

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1665

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1666

"description": "", ~/~/ Описание

1667

"data": "", ~/~/ Данные

1668

"overwrite": false, ~/~/ Флаг перезаписи

1669

"stage": "", ~/~/ Состояние, может быть null

1670

(% style="color:#000000" %)}

1671

1672

(% style="color:#000000" %)Ответ:

1673

1674

(% style="color:#000000" %){(%%)

1675

"status": "", ~/~/ значение статуса

1676

"date": "", ~/~/ Дата смены статуса

1677

"description": "", ~/~/ Описание

1678

"data": "", ~/~/ Данные

1679

"overwrite": false, ~/~/ Флаг перезаписи

1680

"stage": "", ~/~/ Состояние

1681

(% style="color:#000000" %) }

== ==

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

1686

1687

(% class="box warningmessage" %)

1688

(((

1689

(% lang="en-US" %)**PUT /api/v3/vehicles**

1690

)))

1691

1692

(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.

1693

1694

(% style="color:#000000" %)Метод запроса: **PUT**

1695

1696

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

1697

1698

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1699

1700

(% style="color:#000000" %)Параметры в теле запроса (JSON):

1701

1702

(% style="color:#000000" %){

1703

"vehicleId": , ~/~/ ID объекта

1704

"parentId": "" , ~/~/ ID клиента

1705

"name": "" , ~/~/ имя ТС

1706

"imei": "" , ~/~/ IMEI

1707

"deviceTypeId": "" , ~/~/ ID типа устройства

1708

"modelId": "" , ~/~/ ID модели

1709

"unitId": "" , ~/~/ ID подразделения

1710

"sim1": "" , ~/~/ Номер SIM 1

1711

"sim2": "" , ~/~/ Номер SIM2

1712

"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

1713

"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

1714

"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу

1715

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1716

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1717

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1718

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1719

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1720

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1721

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1722

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1723

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1724

1725

"mileageCalcMethod": 0,

1726

"mileageCoeff": 0,

1727

"locationByCellId": true,

1728

"dottedLineTrackWhenNoCoords": true,

1729

"counters": ~/~/ счетчики

1730

{

1731

"mileage": "" , ~/~/ пробег

1732

"mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"

1733

"motohours": "" , ~/~/ моточасы

1734

"motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"

1735

},

1736

"cmsv6Parameters": { ~/~/ параметры CMSv6

1737

"enabled": true, ~/~/ флаг включения

1738

"id": "" , ~/~/ идентификатор

1739

"host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6

1740

"login": "" , ~/~/ имя учетной записи

1741

"password": "" ~/~/ пароль учетной записи

1742

},

1743

"inspectionTasks": ~/~/ задания на ТО

1744

{

1745

"enabled": "" , ~/~/ Признак включения

1746

"name": "" , ~/~/ Имя задания

1747

"description": "" , ~/~/ Описание задания

1748

"mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)

1749

"lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)

1750

"motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)

1751

"lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)

1752

"periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)

1753

"kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

1754

"lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)

1755

"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)

1756

}

1757

1758

"drivers": [ ~/~/ Водители

1759

{

1760

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"isDefault": true

}

],

"commandTemplates": [ ~/~/ Шаблон команды

1765

{

1766

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "string",

"command": "string",

"retries": 0

}

],

"sensors": [ ~/~/ Датчики

1773

{

1774

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1775

"kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный

1776

"type": 0, ~/~/ Тип датчика

1777

"name": "string", ~/~/ Имя датчика

1778

"inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE

1779

"inputNumber": 0, ~/~/ Номер входа

1780

"pseudonym": "string", ~/~/ Псевдоним

1781

"medianDegree": 0, ~/~/ Медианная фильтрация

1782

"isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.

1783

"disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.

1784

"gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1785

"gradesTables": [ ~/~/ Массив таблиц тарировки

1786

{

1787

"grades": [ ~/~/ Таблица тарировки 1

1788

{

1789

"input": 0, ~/~/ Входящее значение

1790

"output": 0 ~/~/ Выходящее значение

1791

}

1792

],

1793

"relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы

1794

}

1795

],

1796

"showInTooltip": true, ~/~/ Отображать в подсказке

1797

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1798

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1799

"showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания

1800

"agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION

1801

"expr": "string", ~/~/ Формула

1802

"children": [ ~/~/ массив дочерних датчиков

1803

"string"

1804

],

1805

"customParams": { ~/~/ прочие произвольные параметры

1806

"additionalProp1": "string",

1807

"additionalProp2": "string",

1808

"additionalProp3": "string"

1809

},

1810

~/~/ Характерные для произвольного:

1811

~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off

1812

~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы

1813

~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off

1814

~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний

1815

~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off

1816

~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off

1817

~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off

1818

~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)

1819

~/~/ Характерные для таблицы тарировки Вкл./Выкл.:

1820

~/~/ "ValueOn": "Вкл.",

1821

~/~/ "ValueOff": "Выкл."

1822

"summaryMaxValue": 0 ~/~/ Макс. значение

1823

1824

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1825

{

1826

"from": 0, ~/~/ С какого значения

1827

"color": "string", ~/~/ Каким цветом

1828

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

1834

1835

"customFields": [ ~/~/ Произвольные поля

1836

{

1837

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

1838

"name": "string", ~/~/ Наименование произвольного поля

1839

"value": "string", ~/~/ Значение произвольного поля

1840

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

1841

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

1842

"forReport": true ~/~/ Отобразить произвольное поле в отчете

}

]

}

(% style="color:#000000" %)Ответ:

(((

{

"vehicleId": 0, ~/~/ ID ТС

1853

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС

1854

"name": "string", ~/~/ Имя объекта

1855

"imei": "string", ~/~/ IMEI

1856

"deviceTypeId": 0, ~/~/ ID типа устройства

1857

"modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели

1858

"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения

1859

"sim1": "string", ~/~/ SIM1

1860

"sim2": "string", ~/~/ SIM2

1861

"consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км

1862

"consumptionPerHour": 0, ~/~/ Расход топлива на моточас

1863

"consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу

1864

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1865

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1866

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1867

"consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1868

"consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1869

"consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1870

"consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1871

"consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1872

"consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1873

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor

1874

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

1875

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

1876

"dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.

1877

"showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.

1878

"counters": { ~/~/ состояний счётчиков

1879

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

1880

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

1881

"mileage": 0, ~/~/ Пробег

1882

"motohours": 0 ~/~/ Моточасы

1883

},

1884

"cmsv6Parameters": { ~/~/ Dto для CMSv6

1885

"id": "string", ~/~/ CMSV6 Идентификатор

1886

"enabled": true, ~/~/ Признак включения

1887

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6.

)))

(((

~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1893

"login": "string", ~/~/ CMSV6 имя учетной записи

1894

"password": "string" ~/~/ CMSV6 — пароль учетной записи

1895

},

1896

"inspectionTasks": [ ~/~/ Задания на ТО

1897

{

1898

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи

1899

"enabled": true, ~/~/ Признак включения

1900

"name": "string", ~/~/ Имя задания

1901

"description": "string", ~/~/ Описание задания

1902

"mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)

1903

"lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО

1904

"motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)

1905

"lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО

1906

"periodicCondition": 0, ~/~/ Условие периодичности по времени

1907

"kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы

1908

"lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО

1909

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

1910

}

1911

],

1912

"drivers": [ ~/~/ Список водителей

1913

{

1914

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

1915

"inputNumber": 0, ~/~/ № входа.

1916

"createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.

1917

"comment": "string", ~/~/ Комментарий.

1918

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

1919

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

1920

"beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.

1921

"endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.

1922

}

1923

],

1924

"commandTemplates": [ ~/~/ Список шаблонов команд

1925

{

1926

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

1927

"name": "string", ~/~/ Название шаблона команд

1928

"command": "string", ~/~/ Команда на выполнение

1929

"retries": 0 ~/~/ Лимит попыток отправки

1930

}

1931

],

1932

"sensors": [ ~/~/ Список датчиков

1933

{

1934

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика

1935

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

1936

"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

1957

"name": "string", ~/~/ Имя датчика

1958

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,

)))

(((

~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

1963

"inputNumber": 0, ~/~/ Номер входа

1964

"pseudonym": "string", ~/~/ Псевдоним

1965

"medianDegree": 0, ~/~/ Степень медианной фильтрации

1966

"isInverted": true, ~/~/ Признак инверсии

1967

"disabled": true, ~/~/ Датчик не участвует в обработке

1968

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1969

"gradesTables": [ ~/~/ Тарировка

1970

{

1971

"grades": [ ~/~/ Таблицы тарировки

1972

{

1973

"input": 0, ~/~/ Вход

1974

"output": 0 ~/~/ Выход

1975

}

1976

],

1977

"relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

1978

}

1979

],

1980

"showInTooltip": true, ~/~/ Отображение в подсказке

1981

"showLastValid": true, ~/~/ Отображать последнее валидное значение

1982

"showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива

1983

"showWithoutIgn": true, ~/~/ Отображать без включенного зажигания

1984

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

1985

"expr": "string", ~/~/ Выражение

1986

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

1987

"string"

1988

],

1989

"customParams": { ~/~/ Дополнительные настройки

1990

"additionalProp1": "string",

1991

"additionalProp2": "string",

1992

"additionalProp3": "string"

1993

},

1994

"summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.

1995

"valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге

1996

{

1997

"from": 0, ~/~/ С какого значения

1998

"color": "string", ~/~/ Каким цветом

1999

"text": "string" ~/~/ Текст подписи к этому интервалу

}

]

}

],

"highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах

2005

"customFields": [ ~/~/ Список произвольных полей

2006

{

2007

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности

2008

"name": "string", ~/~/ Наименование произвольного поля

2009

"value": "string", ~/~/ Значение произвольного поля

2010

"forClient": true, ~/~/ Отобразить произвольное поле у клиента

2011

"forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)

2012

"forReport": true ~/~/ Отобразить произвольное поле в отчете

2013

}

2014

],

2015

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor

}

)))

**Валидация:**

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

2021

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

2022

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

2023

2024

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

2025

2026

(% class="box errormessage" %)

2027

(((

2028

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

2029

)))

2030

2031

(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.

2032

2033

(% style="color:#000000" %)Метод запроса: **DELETE**

2034

2035

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

2036

2037

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

2038

2039

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2040

2041

(% style="text-align:left" %)

2042

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

2043

2044

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

2045

2046

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

2047

2048

(% class="box infomessage" %)

2049

(((

2050

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

2051

)))

2052

2053

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.

2054

2055

(% style="color:#000000" %)Метод запроса: **GET**

2056

2057

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]

2058

2059

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2060

2061

(% style="color:#000000" %)Ответ:

2062

2063

(% style="color:#000000" %){(%%)

2064

"deviceTypeId" : "", ~/~/ ID типа устройства

2065

"deviceTypeName" : "" ~/~/ Название типа устройства

2066

(% style="color:#000000" %)}

2067

2068

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

2069

2070

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

2071

2072

(% class="box infomessage" %)

2073

(((

2074

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

2075

)))

2076

2077

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.

2078

2079

(% style="color:#000000" %)Метод запроса: **GET**

2080

2081

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

2082

2083

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2084

2085

(% style="color:#000000" %)Ответ:

2086

2087

(% style="color:#000000" %){(%%)

2088

"id": "", ~/~/ ID типа датчика

2089

"name": "", ~/~/ Название

2090

"description": "", ~/~/ Описание

2091

(% style="color:#000000" %)}

2092

2093

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

2094

2095

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

2096

2097

(% class="box infomessage" style="text-align: left;" %)

2098

(((

2099

**POST /api/v3/terminalMessages/count**

2100

)))

2101

2102

(% style="text-align: left;" %)

2103

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

2104

2105

(% style="text-align: left;" %)

2106

Метод запроса **POST**

2107

2108

(% style="text-align: left;" %)

2109

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

2110

2111

(% style="text-align: left;" %)

2112

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2113

2114

(% style="text-align: left;" %)

2115

{

2116

"vehicleIds": [

2117

id ~/~/ здесь передается список идентификаторов объектов

2118

],

2119

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

2120

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

2121

}

2122

2123

(% style="text-align: left;" %)

2124

Ответ:

2125

2126

(% style="text-align: left;" %)

2127

[

2128

{

2129

"vehicleId": 0, ~/~/ идентификатор объекта

2130

"count": 0 ~/~/ количество сообщений за период

}

]

== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==

2135

2136

(% class="box infomessage" style="text-align: left;" %)

2137

(((

2138

**POST /api/v3/terminalMessages/mapping**

2139

)))

2140

2141

Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.

2142

2143

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping

2144

2145

(% 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);" %)**Описание**

2153

|protocolType|ID типа протокола

2154

|params|(((

2155

Массив наименований параметров в сообщении

)))

Ответ:

{

"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);" %)**Описание**

2175

|protocolType|Тип протокола

2176

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2182

Перечень 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/]]

2183

2184

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2185

2186

(% class="box infomessage" %)

2187

(((

2188

**POST /api/v3/terminalMessages**

2189

)))

2190

2191

Метод возвращает список сообщений терминала объекта за выбранный период.

2192

2193

(% style="text-align: left;" %)

2194

Метод запроса **POST**

2195

2196

(% style="text-align: left;" %)

2197

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages

2198

2199

(% style="text-align: left;" %)

2200

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2201

2202

{

2203

"vehicleId": 0, ~/~/ id объекта

2204

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2205

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2206

}

2207

2208

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2209

|vehicleId|ID объекта

2210

|from|Дата и время начала периода запроса

2211

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2220

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2230

"additionalProp2": "string",

2231

"additionalProp3": "string"

2232

},

2233

"photoCount": 0,

2234

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

2242

|deviceTime|Время сообщения терминала

2243

|serverTime|Время когда сообщение поступило на сервер

2244

|speed|Скорость

2245

|altitude|Высота над уровнем моря

2246

|latitude|Широта

2247

|longitude|Долгота

2248

|satellites|Кол-во спутников

2249

|course|Курс

2250

|voltage|Бортовое напряжение

2251

|parameters|Список параметров и их значений

2252

|photoCount|Количество фото

2253

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2254

|protocolType|ID типа протокола

2255

2256

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =

2257

2258

== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==

2259

2260

(% class="box infomessage" %)

2261

(((

2262

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2263

)))

2264

2265

(% style="color:#000000" %)Метод запроса: **POST**

2266

2267

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours

2268

2269

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2270

2271

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2276

"vehicleIds": [0], ~/~/ Список ID объектов

2277

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2278

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2279

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2287

"name": "string", ~/~/ Имя ТС

2288

"periods": [ ~/~/ Периоды

2289

{

2290

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2291

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2292

"mileage": 0, ~/~/ Пробег за период, километры

2293

"mileageBegin": 0, ~/~/ Пробег на начало периода, километры

2294

"mileageEnd": 0, ~/~/ Пробег на окончание периода, километры

2295

"motohours": 0, ~/~/ Моточасы за период, секунды

2296

"motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды

2297

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==

2304

2305

(% class="box infomessage" %)

2306

(((

2307

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2308

)))

2309

2310

(% style="color:#000000" %)Метод запроса: **POST**

2311

2312

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption

2313

2314

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2315

2316

(% style="text-align:left" %)

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2321

"vehicleIds": [0], ~/~/ Список ID объектов

2322

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2323

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2324

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2332

"name": "string", ~/~/ Имя ТС

2333

"periods": [ ~/~/ Периоды

2334

{

2335

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2336

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2337

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2338

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2339

"fuelConsumption": 0, ~/~/ Расход топлива

2340

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

(% class="box warningmessage" %)

2347

(((

2348

Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".

2349

\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".

2350

)))

2351

2352

== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==

2353

2354

(% class="box infomessage" %)

2355

(((

2356

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2357

)))

2358

2359

(% style="color:#000000" %)Метод запроса: **POST**

2360

2361

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut

2362

2363

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2364

2365

(% style="text-align:left" %)

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2370

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2371

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2372

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2380

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2381

"vehicleId": 0, ~/~/ ID объекта

2382

"name": "string", ~/~/ Имя объекта

2383

"model": "string", ~/~/ Модель объекта

2384

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2385

{

2386

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2387

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2388

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2389

"valueFuel": 0, ~/~/ Количество

2390

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2391

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==

2399

2400

(% class="box infomessage" %)

2401

(((

2402

**POST /api/v3/vehicles/moveStop**

2403

)))

2404

2405

Метод запроса: **POST**

2406

2407

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2408

2409

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2416

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2417

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2418

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"vehicleId": 0, ~/~/ ID объекта

2426

"vehicleName": "string", ~/~/ Имя объекта

2427

"moves": [ ~/~/ Событие движения

2428

{

2429

"mileage": 0, ~/~/ Пробег, км

2430

"eventId": 0, ~/~/ Идентификатор события

2431

"eventName": "string", ~/~/ Название события

2432

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2433

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2434

"duration": 0 ~/~/ Продолжительность события, секунд

2435

}

2436

],

2437

"stops": [ ~/~/ События стоянок

2438

{

2439

"address": "string", ~/~/ Адрес события

2440

"eventId": 0, ~/~/ Идентификатор события

2441

"eventName": "string", ~/~/ Название события

2442

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2443

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2444

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==

2452

2453

(% class="box infomessage" %)

2454

(((

2455

**POST /api/v3/vehicles/getlastdata**

2456

)))

2457

2458

Метод запроса: **POST**

2459

2460

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2461

2462

В заголовках запроса: X-Auth: Токен авторизации

2463

2464

2465

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2470

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2471

"vehicleNumber": "string",~/~/Номер объекта.

2472

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2473

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2474

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2475

"speed": 0,~/~/Скорость объекта.

2476

"course": 0,~/~/Курс движения [0;360]

2477

"latitude": 0,~/~/Широта [-90°;90°].

2478

"longitude": 0,~/~/Долгота [-180°;180°].

2479

"address": "string",~/~/Адрес.

2480

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =

2488

2489

== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==

2490

2491

(% class="box infomessage" %)

2492

(((

2493

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2494

)))

2495

2496

(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

2497

2498

(% style="color:#000000" %)Метод запроса: **POST**

2499

2500

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find

2501

2502

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2503

2504

(% style="text-align:left" %)

2505

Тело запроса:

2506

2507

(% style="text-align:left" %)

2508

{

2509

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

2510

}

2511

2512

(% style="text-align:left" %)

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2518

"name": "string", ~/~/ Название объекта геозоны

2519

"type": 0, ~/~/ Тип объекта геозоны

2520

"fname": "string", ~/~/ Имя файла

2521

"parentId": "string", ~/~/ Идентификатор клиента

2522

"radius": 0, ~/~/ Радиус геообъекта

2523

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2524

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2525

"description": "string", ~/~/ Описание

2526

"area": 0, ~/~/ Площадь, м^^2^^

2527

"perimetr": 0, ~/~/ Периметр, м

2528

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==

2533

2534

(% class="box infomessage" %)

2535

(((

2536

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2537

)))

2538

2539

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

2540

2541

(% style="color:#000000" %)Метод запроса: **POST**

2542

2543

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

2544

2545

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2546

2547

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2552

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2553

"ids": [ ], ~/~/ Массив id объектов

2554

"byTime": 0, ~/~/ Объединение событий по времени

2555

"byDist": 0, ~/~/ Объединение событий по расстоянию

2556

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2557

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2564

"geozoneName": "string", ~/~/ Название геообъекта

2565

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2566

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2567

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2568

"vehicleId": 0, ~/~/ ID объекта

2569

"vehicleName": "string" ~/~/ Имя объекта

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2574

2575

(% class="box infomessage" %)

2576

(((

2577

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2578

)))

2579

2580

(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

2581

2582

(% style="color:#000000" %)Метод запроса: **POST**

2583

2584

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

2585

2586

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2587

2588

(% style="text-align:left" %)

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2593

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2594

"ids": [ ], ~/~/ Массив id геообъектов

2595

"byTime": 0, ~/~/ Объединение событий по времени

2596

"byDist": 0, ~/~/ Объединение событий по расстоянию

2597

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2598

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2606

"geozoneName": "string", ~/~/ Название геообъекта

2607

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2608

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2609

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2610

"vehicleId": 0, ~/~/ ID объекта

2611

"vehicleName": "string" ~/~/ Имя объекта

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =

2616

2617

== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==

2618

2619

(% class="box infomessage" %)

2620

(((

2621

**POST /api/v3/notifications/find**

2622

)))

2623

2624

Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.

2625

2626

(% style="text-align: left;" %)

2627

Метод запроса **POST**

2628

2629

(% style="text-align: left;" %)

2630

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find

2631

2632

(% style="text-align: left;" %)

2633

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2634

2635

{

2636

"parentId": "" ~/~/ id клиента

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2644

"name": "string", ~/~/ Название уведомления

2645

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2646

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2647

"userId": "", ~/~/ Пользователь, создавший уведомление

2648

"parentId": "", ~/~/ Идентификатор клиента

2649

"parentName": "string" ~/~/ Имя клиента

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==

2654

2655

(% class="box infomessage" %)

2656

(((

2657

**GET /api/v3/notifications/{id}**

2658

)))

2659

2660

Метод возвращает данные правил формирования выбранного уведомления.

2661

2662

(% style="text-align: left;" %)

2663

Метод запроса **GET**

2664

2665

(% style="text-align: left;" %)

2666

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2667

2668

(% style="text-align: left;" %)

2669

(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления

2670

2671

(% style="text-align: left;" %)

2672

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

2673

2674

(% style="text-align: left;" %)

2675

(% style="color:#000000" %)Ответ:

2676

2677

(% style="text-align: left;" %)

2678

(% style="color:#000000" %){

2679

"id": 0, ~/~/ (%%)id уведомления

2680

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2681

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2682

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2683

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2684

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2685

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2686

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2687

(% style="color:#000000" %) 0

2688

],

2689

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2690

(% style="color:#000000" %) 0

2691

],

2692

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2693

(% style="color:#000000" %) 0

2694

],

2695

"settings": { ~/~/ Список параметров уведомления

2696

"additionalProp1": "string",

2697

"additionalProp2": "string",

2698

"additionalProp3": "string"

2699

},

2700

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2701

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2702

(% style="color:#000000" %) ""

2703

],

2704

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2705

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2706

(% style="color:#000000" %) "string"

2707

],

2708

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2709

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2710

(% style="color:#000000" %) {

2711

"id": 0, ~/~/ (%%)Идентификатор участника чата

2712

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2713

(% style="color:#000000" %) }

2714

],

2715

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2716

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2717

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2718

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2719

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2720

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2721

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2722

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2723

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2724

(% style="color:#000000" %)}

2725

2726

== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==

2727

2728

(% class="box warningmessage" %)

2729

(((

2730

**PUT /api/v3/notifications/**

2731

)))

2732

2733

Метод позволяет отредактировать уведомление.

2734

2735

Метод запроса **PUT**

2736

2737

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2738

2739

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2744

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2745

"userId": "", ~/~/ Пользователь, создавший уведомление

2746

"parentId": "", ~/~/ Идентификатор клиента

2747

"parentName": "string", ~/~/ Имя клиента

2748

"name": "string", ~/~/ Название уведомления

2749

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2750

"vehicleIds": [ ~/~/ Список id объектов для анализа

2751

0

2752

],

2753

"geoids": [ ~/~/ Список id геообъектов для анализа

2754

0

2755

],

2756

"fieldids": [ ~/~/ Список id полей для анализа

2757

0

2758

],

2759

"settings": { ~/~/ Список параметров уведомления

2760

"additionalProp1": "string",

2761

"additionalProp2": "string",

2762

"additionalProp3": "string"

2763

},

2764

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2765

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2766

""

2767

],

2768

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2769

"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений

2770

"string"

2771

],

2772

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2773

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2774

{

2775

"id": 0, ~/~/ Идентификатор участника чата

2776

"info": "string" ~/~/ Дополнительные сведения

2777

}

2778

],

2779

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2780

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2781

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2782

"kind": 0, ~/~/ Определяет вид уведомления

2783

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2784

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2785

"timezone": 0, ~/~/ Сдвиг часового пояса

2786

"validity": 0, ~/~/ Срок действия в днях (1-90)

2787

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==

2796

2797

(% class="box warningmessage" %)

2798

(((

2799

**PUT** /api/v3/notifications/prolongation

2800

)))

2801

2802

Метод позволяет продлить уведомления.

2803

2804

Метод запроса **PUT**

2805

2806

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation

2807

2808

В заголовках запроса: X-Auth: Токен авторизации.

Тело запроса:

[

0

]

где 0 идентификатор ids.

2819

2820

== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==

2821

2822

(% class="box errormessage" %)

2823

(((

2824

**DELETE /api/v3/notifications/{id}**

2825

)))

2826

2827

Метод позволяет удалить выбранное уведомление.

2828

2829

Метод запроса **DELETE**

2830

2831

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2832

2833

Передаваемый параметр: {id} - id уведомления

2834

2835

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =

2843

2844

== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==

2845

2846

(% class="box infomessage" %)

2847

(((

2848

**POST /api/v3/Drivers/find**

2849

)))

2850

2851

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2858

"description": "string", ~/~/ Определяет описание

2859

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2860

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2861

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2862

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2863

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2864

"deleted": true ~/~/ Признак удаления

}

]

== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==

2869

2870

(% class="box infomessage" %)

2871

(((

2872

**GET /api/v3/Drivers/{driverGuid}**

2873

)))

2874

2875

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2881

"description": "string", ~/~/ Определяет описание

2882

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2883

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2884

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2885

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2886

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2887

"deleted": true ~/~/ Признак удаления

2888

}

2889

2890

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2891

2892

(% class="box successmessage" %)

2893

(((

2894

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2902

"hiredate": "2023-06-30T12:50:54.020Z",

2903

"chopdate": "2023-06-30T12:50:54.020Z",

2904

"exclusive": true,

2905

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2906

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2915

"hiredate": "2023-06-30T12:50:54.051Z",

2916

"chopdate": "2023-06-30T12:50:54.051Z",

2917

"exclusive": true,

2918

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2919

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2925

2926

(% class="box warningmessage" %)

2927

(((

2928

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2936

"hiredate": "2023-06-30T12:50:27.910Z",

2937

"chopdate": "2023-06-30T12:50:27.910Z",

2938

"exclusive": true,

2939

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2940

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2949

"hiredate": "2023-06-30T12:50:27.929Z",

2950

"chopdate": "2023-06-30T12:50:27.929Z",

2951

"exclusive": true,

2952

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2953

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2959

2960

(% class="box errormessage" %)

2961

(((

2962

**DELETE /api/v3/Drivers/{driverGuid}**

2963

)))

2964

2965

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2973

2974

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2975

2976

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2977

2978

(% class="box infomessage" %)

2979

(((

2980

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2988

],

2989

"BeginTime": "2023-06-30T12:49:04.365Z",

2990

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2999

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3000

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3001

"BeginTime": "2023-06-30T09:52:31.240Z",

3002

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

3008

3009

(% class="box infomessage" %)

3010

(((

3011

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

3021

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

3030

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3031

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3032

"BeginTime": "2023-06-30T09:54:01.631Z",

3033

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

3039

3040

(% class="box successmessage" %)

3041

(((

3042

**POST /api/v3/DriversVehiclesAssignments**

3043

)))

3044

3045

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

3052

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

3053

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3054

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

3055

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

3065

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3066

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3067

"BeginTime": "2023-06-30T11:04:46.903Z",

3068

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

3074

3075

(% class="box warningmessage" %)

3076

(((

3077

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

3086

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3087

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3088

"BeginTime": "2023-06-30T11:14:08.117Z",

3089

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

3099

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3100

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3101

"BeginTime": "2023-06-30T11:14:53.349Z",

3102

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

3108

3109

(% class="box errormessage" %)

3110

(((

3111

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

3126

3127

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

3128

3129

(% class="box infomessage" %)

3130

(((

3131

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3139

],

3140

"BeginTime": "2023-06-30T12:47:12.162Z",

3141

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3149

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3150

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3151

"BeginTime": "2023-06-30T11:19:40.703Z",

3152

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

3158

3159

(% class="box infomessage" %)

3160

(((

3161

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3169

],

3170

"BeginTime": "2023-06-30T12:47:12.162Z",

3171

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3179

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3180

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3181

"BeginTime": "2023-06-30T11:19:40.703Z",

3182

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

3188

3189

(% class="box successmessage" %)

3190

(((

3191

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3199

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3200

"BeginTime": "2023-06-30T11:27:08.635Z",

3201

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3210

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3211

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3212

"BeginTime": "2023-06-30T11:27:08.677Z",

3213

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3219

3220

(% class="box warningmessage" %)

3221

(((

3222

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3230

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3231

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3232

"BeginTime": "2023-06-30T11:28:43.330Z",

3233

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3242

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3243

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3244

"BeginTime": "2023-06-30T11:28:43.331Z",

3245

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3251

3252

(% class="box errormessage" %)

3253

(((

3254

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3269

3270

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3271

3272

(% class="box infomessage" %)

3273

(((

3274

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3282

],

3283

"BeginTime": "2023-06-30T12:45:10.852Z",

3284

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3292

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3293

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3294

"BeginTime": "2023-06-30T11:58:04.695Z",

3295

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3301

3302

(% class="box infomessage" %)

3303

(((

3304

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3312

],

3313

"BeginTime": "2023-06-30T12:45:10.852Z",

3314

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3322

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3323

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3324

"BeginTime": "2023-06-30T11:58:04.695Z",

3325

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3331

3332

(% class="box successmessage" %)

3333

(((

3334

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3342

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3343

"BeginTime": "2023-06-30T12:09:53.175Z",

3344

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3353

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3354

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3355

"BeginTime": "2023-06-30T12:09:53.201Z",

3356

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3362

3363

(% class="box warningmessage" %)

3364

(((

3365

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3373

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3374

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3375

"BeginTime": "2023-06-30T12:09:53.201Z",

3376

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3385

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3386

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3387

"BeginTime": "2023-06-30T12:09:53.201Z",

3388

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3394

3395

(% class="box errormessage" %)

3396

(((

3397

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3412

3413

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3414

3415

(% class="box infomessage" %)

3416

(((

3417

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3424

"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);" %)**Описание**

3430

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3431

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3432

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3433

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3440

"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",

3450

"name": "string",

3451

"rid": "string",

3452

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3453

"trailer": {

3454

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3455

"Number": "string",

3456

"Description": "string",

3457

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3458

"ExternalID": "string",

3459

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3460

"CreateTime": "2023-11-14T10:48:03.717Z",

3461

"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);" %)**Описание**

3469

|SD|Дата и время начала события

3470

|ED|Дата и время окончания события

3471

|id|ID объекта

3472

|SLat|Широта начальной координаты

3473

|SLon|Долгота начальной координаты

3474

|ELat|Широта конечной координаты

3475

|ELon|Долгота конечной координаты

3476

|mileage|Пробег

3477

|Duration|Продолжительность

3478

|Address|Адрес начального местоположения

3479

|Address2|Адрес конечного местоположения

3480

|name|Имя радиометки

3481

|rid|Номер радиометки

3482

|rguid|ID радиометки

3483

|trailer|Информация об агрегате

3484

|ModelGuid|ID агрегата

3485

|Number|Название/номер агрегата

3486

|Description|Текст примечания агрегата

3487

3488

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3489

3490

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3491

3492

(% class="box infomessage" %)

3493

(((

3494

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3511

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3516

|parentId|ID клиента

3517

|name|Название карты-метки

3518

|number|Номер

3519

|period|Период запросов в секундах (работает только для агрегатов)

3520

|id|ID карты-метки

3521

3522

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3523

3524

(% class="box infomessage" %)

3525

(((

3526

**GET /api/v3/Rfids/{rfidGuid}**

3527

)))

3528

3529

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3539

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3544

|name|Название карты-метки

3545

|number|Номер

3546

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3551

3552

(% class="box successmessage" %)

3553

(((

3554

**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",

3573

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3574

}

3575

3576

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3577

|name|Название карты-метки

3578

|number|Номер

3579

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3584

3585

(% class="box warningmessage" %)

3586

(((

3587

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3597

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3607

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3608

}

3609

3610

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3611

|name|Название карты-метки

3612

|number|Номер

3613

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3618

3619

(% class="box errormessage" %)

3620

(((

3621

**DELETE /api/v3/Rfids/{rfidGuid}**

3622

)))

3623

3624

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3632

3633

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3634

3635

(% class="box infomessage" %)

3636

(((

3637

**GET /api/v3/Billing/client/balance/{clientId}**

3638

)))

3639

3640

Параметр запроса: **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);" %)**Описание**

3650

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3651

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3652

3653

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3654

3655

(% class="box infomessage" %)

3656

(((

3657

**GET /api/v3/Billing/client/constraint/{clientId}**

3658

)))

3659

3660

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3666

"CalculationType": 0,

3667

"PermissibleBalance": 0,

3668

"DefermentDays": 0,

3669

"SendUiNotifications": true,

3670

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3675

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3676

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3677

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3678

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3679

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3680

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3681

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3682

3683

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3684

3685

(% class="box infomessage" %)

3686

(((

3687

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3693

3694

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3700

"Plan": { **~/~/ Описание тарифного плана**

3701

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3702

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3707

"PermissibleBalance": 0,

3708

"DefermentDays": 0

3709

},

3710

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3722

"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);" %)**Описание**

3738

|ClientId|Идентификатор клиента

3739

|Id|Идентификатор тарифного плана

3740

|OwnerId|Идентификатор клиента-владельца

3741

|Name|Наименование тарифного плана

3742

|IsArchived|Признак, определяющий архивный тарифный план

3743

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3744

|PermissibleBalance|Допустимый баланс

3745

|DefermentDays|Отсрочка, количество дней

3746

|Feature|Код услуги

3747

|IsEnabled|Признак, определяющий активирована ли услуга

3748

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3749

|IsFactual|Признак, определяющий расчёт по факту

3750

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3751

|Price|Цена за единицу.

3752

|DebitDate|Следующий момент времени списания с баланса за услугу.

3753

|PeriodValue|Значение периода.

3754

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3755

3756

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3757

3758

(% class="box infomessage" %)

3759

(((

3760

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3761

)))

3762

3763

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3770

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3775

"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);" %)**Описание**

3792

|ClientId|Идентификатор клиента

3793

|Id|Идентификатор тарифного плана

3794

|OwnerId|Идентификатор клиента-владельца

3795

|Name|Наименование тарифного плана

3796

|IsArchived|Признак, определяющий архивный тарифный план

3797

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3798

|PermissibleBalance|Допустимый баланс

3799

|DefermentDays|Отсрочка, количество дней

3800

|Feature|Код услуги

3801

|IsFactual|Признак, определяющий расчёт по факту

3802

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3803

|Price|Цена за единицу.

3804

|PeriodValue|Значение периода.

3805

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3806

3807

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3808

3809

(% class="box infomessage" %)

3810

(((

3811

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3812

)))

3813

3814

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3821

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3826

"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);" %)**Описание**

3843

|ClientId|Идентификатор клиента

3844

|Id|Идентификатор тарифного плана

3845

|OwnerId|Идентификатор клиента-владельца

3846

|Name|Наименование тарифного плана

3847

|IsArchived|Признак, определяющий архивный тарифный план

3848

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3849

|PermissibleBalance|Допустимый баланс

3850

|DefermentDays|Отсрочка, количество дней

3851

|Feature|Код услуги

3852

|IsFactual|Признак, определяющий расчёт по факту

3853

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3854

|Price|Цена за единицу.

3855

|PeriodValue|Значение периода.

3856

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3857

3858

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3859

3860

(% class="box warningmessage" %)

3861

(((

3862

**PUT /api/v3/Billing/client/balance**

3863

)))

3864

3865

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3877

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3878

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3879

3880

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3881

3882

(% class="box warningmessage" %)

3883

(((

3884

**PUT /api/v3/billing/client/balance/deposit**

3885

)))

3886

3887

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3899

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3900

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3901

3902

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3903

3904

Создает операцию **Списание **с указанной суммой

3905

3906

(% class="box warningmessage" %)

3907

(((

3908

**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);" %)**Описание**

3921

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3922

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3923

3924

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3925

3926

(% class="box warningmessage" %)

3927

(((

3928

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3935

"CalculationType": 0,

3936

"PermissibleBalance": 0,

3937

"DefermentDays": 0,

3938

"SendUiNotifications": true,

3939

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3946

|ClientId|Идентификатор клиента

3947

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3948

|PermissibleBalance|Допустимый баланс

3949

|DefermentDays|(((

3950

Отсрочка, количество дней

3951

)))

3952

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3953

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3954

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3955

3956

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3957

3958

(% class="box warningmessage" %)

3959

(((

3960

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3967

"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);" %)**Описание**

3985

|ClientId|Идентификатор клиента

3986

|PlanId|Идентификатор тарифного плана

3987

|Feature|Код услуги

3988

|IsEnabled|Признак, определяющий активирована ли услуга

3989

|IsFactual|Признак, определяющий расчёт по факту

3990

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3991

|Price|Цена за единицу.

3992

|DebitDate|Следующий момент времени списания с баланса за услугу.

3993

|PeriodValue|Значение периода.

3994

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3995

3996

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3997

3998

(% class="box warningmessage" %)

3999

(((

4000

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

4001

)))

4002

4003

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

4004

4005

(% class="box infomessage" %)

4006

(((

4007

**POST /api/v3/vehicles/import/{agentId}**

4008

)))

4009

4010

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

4011

4012

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4021

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

4022

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

4023

4024

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4029

|data|В значении передаем файл объекта, формат **xml** или **wlp **

4030

|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);" %)**Описание**

4041

|vehicleId|ID созданного объекта

4042

|name|Имя созданного объекта

4043

|errors|Ошибки и их описание

4044

4045

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

4046

4047

(% class="box infomessage" %)

4048

(((

4049

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

4050

)))

4051

4052

(% class="wikigeneratedid" %)

4053

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

4054

4055

(% class="wikigeneratedid" %)

4056

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

4061

4062

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4067

|**history**|В значении передавать файл с историей

4068

4069

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

4082

"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);" %)**Описание**

4090

|results|Результаты импорта в разрезе ТС

4091

|vehicleGuid|Guid ТС

4092

|vehicleId|ID ТС

4093

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

4094

|firstMessageDate|Дата первого импортированного сообщения (UTC)

4095

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

4096

|producedCount|Кол-во успешно отправленных в шину данных сообщений

4097

|msgCount|Кол-во обработанных сообщений всего

4098

4099

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

4100

4101

(% class="box infomessage" %)

4102

(((

4103

**GET /api/v3/vehicles/import/history/status**

4104

)))

4105

4106

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4117

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

4118

|progress|Guid ТС

4119

4120

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

4121

4122

(% class="box infomessage" %)

4123

(((

4124

**POST /api/v3/vehicles/export**

4125

)))

4126

4127

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

4136

4137

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

4138

4139

(% class="box infomessage" %)

4140

(((

4141

**POST /api/v3/vehicles/export/history**

4142

)))

4143

4144

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4152

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4158

4159

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4160

|vehicleId|ID объекта

4161

|asArchive|true - Архивировать файл, False - не архивировать

4162

|from|Дата и время начала запроса

4163

|to|Дата и время окончания запроса

4164

4165

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4166

4167

(% class="box infomessage" %)

4168

(((

4169

**GET /api/v3/vehicles/export/history/status**

4170

)))

4171

4172

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4183

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4184

|progress|Прогресс экспорта, от 0 до 100%

4185

|message|Текст описывающий статус

4186

4187

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4188

4189

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4190

4191

(% class="box infomessage" %)

4192

(((

4193

**POST /api/v3/EcoDriving/rating**

4194

)))

4195

4196

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

4202

"from": "2023-11-22T09:29:48.051Z",

4203

"to": "2023-11-22T09:29:48.051Z"

4204

}

4205

4206

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4207

|vehicleIds|Массив ID объектов

4208

|from|Дата начала запроса

4209

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

4217

"to": "2023-11-22T09:29:48.052Z",

4218

"vehicleId": 0,

4219

"vehicleName": "string",

4220

"vehicleModel": "string",

4221

"penalty": 0,

4222

"score": 0,

4223

"totalViolations": 0,

4224

"violationsByType": {

4225

"overspeedingViolations": 0,

4226

"accelerationViolations": 0,

4227

"brakingViolations": 0,

4228

"turningViolations": 0,

4229

"dangerousDrivingViolations": 0,

4230

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

4240

"violationsByType": {

4241

"overspeedingViolations": 0,

4242

"accelerationViolations": 0,

4243

"brakingViolations": 0,

4244

"turningViolations": 0,

4245

"dangerousDrivingViolations": 0,

4246

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4253

"endAddress": "string",

4254

"drivers": [

4255

{

4256

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4257

"driverName": "string",

4258

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4268

|from|Дата начала запроса

4269

|to|Дата окончания

4270

|vehicleId|ID объекта

4271

|vehicleName|Имя объекта

4272

|vehicleModel|Модель объекта

4273

|penalty|Сумма штрафных баллов

4274

|score|Оценка

4275

|totalViolations|Суммарное количество нарушений

4276

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4277

|overspeedingViolations|Превышение скорости

4278

|accelerationViolations|Ускорение

4279

|brakingViolations|Торможение

4280

|turningViolations|Резкий поворот

4281

|dangerousDrivingViolations|Резкое вождение

4282

|sensorViolations|Нарушение по датчику

4283

|moveTime|Время в движении

4284

|mileage|Пробег (км)

4285

|tripsCount|Количество рейсов

4286

|motohours|Моточасы

4287

|maxSpeed|Максимальная скорость

4288

|startAddress|Адрес начала рейса

4289

|endAddress|Адрес окончания рейса

4290

|drivers|Список водителей, которые были на объекте в течениии рейса

4291

|driverGuid|Guid водителя

4292

|driverName|Имя водителя

4293

|driverRfid|Номер Карты-метки

4294

4295

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4296

4297

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4298

4299

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4300

4301

(% class="box infomessage" %)

4302

(((

4303

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4309

\\В заголовках запроса: X-Auth: Токен авторизации

4310

4311

Параметры в теле запроса (JSON):

4312

4313

{

4314

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4315

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4316

"ids": [

4317

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4318

],

4319

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4326

"driver": "string", ~/~/Водители, привязанные к ТК

4327

"object": "string", ~/~/Наименование ТС

4328

"amount": 0, ~/~/Количество топлива

4329

"amountDut": 0, ~/~/Количество по ДУТ

4330

"amountDiff": 0, ~/~/Разница, л

4331

"amountDiffPerc": 0, ~/~/Разница, %

4332

"summa": 0, ~/~/Стоимость, руб

4333

"serviceName": "string", ~/~/Тип топлива

4334

"price": 0, ~/~/Цена за литр, руб

4335

"cardName": "string", ~/~/Наименование ТК

4336

"cardNum": "string", ~/~/Номер ТК

4337

"operator": "string", ~/~/Оператор ТК

4338

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4343

4344

4345

== **Получение полных данных о ретрансляторе** ==

4346

4347

(% class="box infomessage" %)

4348

(((

4349

**GET ** **/api/v3/retranslations/{id}**

4350

)))

4351

4352

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4359

"subscriberId": "", ~/~/ Подписчик

4360

"protocolType": 0, ~/~/ Тип протокола

4361

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4362

"address": "string", ~/~/ Адрес события

4363

"objects": [ ~/~/Объекты для ретрансляции

4364

{

4365

"id": "", ~/~/ Идентификатор объекта ретрансляции

4366

"name": "", ~/~/ Наименование объекта ретрансляции

4367

"imei": "", ~/~/ IMEI объекта

4368

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4369

}

4370

],

4371

"id": "", ~/~/ идентификатор пользователя

4372

"parentId": "", ~/~/Guid родителя

4373

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4378

4379

(% class="box infomessage" %)

4380

(((

4381

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4388

4389

(% class="box infomessage" %)

4390

(((

4391

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4398

"subscriberId": "", ~/~/ Подписчик

4399

"protocolType": 0, ~/~/ Тип протокола

4400

"address": "", ~/~/ Адрес ретрансляции

4401

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4402

"objects": [ ~/~/Объекты для ретрансляции

4403

{

4404

"id": "", ~/~/ идентификатор пользователя

4405

"imei": "", ~/~/IMEI объекта

4406

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4416

"subscriberId": "", ~/~/ идентификатор запроса

4417

"protocolType": 0, ~/~/ Тип протокола

4418

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4419

"address": "", ~/~/ Адрес события

4420

"objects": [ ~/~/Объекты для ретрансляции

4421

{

4422

"id": "", ~/~/ идентификатор пользователя

4423

"name": "string", ~/~/ Название уведомления

4424

"imei": "string", ~/~/IMEI объекта

4425

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4426

}

4427

],

4428

"id": "", ~/~/ идентификатор пользователя

4429

"parentId": "", ~/~/ Guid идентификатор родителя

4430

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4435

4436

(% class="box infomessage" %)

4437

(((

4438

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4445

"description": "string", ~/~/ Определяет описание

4446

"subscriberId": "", ~/~/ идентификатор запроса

4447

"protocolType": 0, ~/~/ Тип протокола

4448

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4449

"address": "string", ~/~/ Адрес события

4450

"objects": ~/~/Объекты для ретрансляции

4451

[

4452

{

4453

"id": "", ~/~/ идентификатор пользователя

4454

"imei": "", ~/~/IMEI объекта

4455

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4465

"subscriberId": "", ~/~/ идентификатор запроса

4466

"protocolType": 0, ~/~/ Тип протокола

4467

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4468

"address": "string", ~/~/ Адрес события

4469

"objects": [ ~/~/Объекты для ретрансляции

4470

{

4471

"id": "", ~/~/ идентификатор пользователя

4472

"name": "string", ~/~/ Название уведомления

4473

"imei": "", ~/~/IMEI объекта

4474

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4475

}

4476

],

4477

"id": "", ~/~/ идентификатор пользователя

4478

"parentId": "", ~/~/ Guid идентификатор родителя

4479

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4484

4485

(% class="box infomessage" %)

4486

(((

4487

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4494

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4495

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4503

"subscriberId": "", ~/~/ идентификатор запроса

4504

"protocolType": 0, ~/~/ Тип протокола

4505

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4506

"address": "string", ~/~/ Адрес события

4507

"id": "", ~/~/ идентификатор пользователя

4508

"parentId": "", ~/~/ Guid идентификатор родителя

4509

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4515

4516

== **API для отчета по выгрузке комбайнов** ==

4517

4518

(% class="box infomessage" %)

4519

(((

4520

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4527

"byDist": 0, ~/~/ Объединение событий по расстоянию

4528

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4529

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4530

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4531

"vehicleIds": [ ~/~/ Список id объектов для анализа

4532

0

4533

],

4534

"from": "", ~/~/ Дата и время начало запроса

4535

"to": "", ~/~/ Дата и время окончания запроса

4536

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4544

"harvesterId": 0, ~/~/Комбайн, id

4545

"harvesterModel": "", ~/~/ Модель комбайна

4546

"hopperCapacity": 0, ~/~/ Объем бункера м3

4547

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4548

"events": [ ~/~/Список событий в разрезе комбайна

4549

{

4550

"driverId": "", ~/~/Идентификатор водителя

4551

"driverName": "", ~/~/Водитель комбайна, ФИО

4552

"RFID": "", ~/~/ идентификатор карты-метки

4553

"rfidName": "", ~/~/Водитель комбайна, имя метки

4554

"vehicleId": 0, ~/~/идентификатор объекта

4555

"vehicleName": "string", ~/~/ Имя объекта

4556

"modelName": "string", ~/~/ Имя модели объекта

4557

"nearestVehicles": [ ~/~/Объекты рядом

4558

{

4559

"vehicleId": 0, ~/~/идентификатор объекта

4560

"vehicleName": "string" ~/~/ Имя объекта

4561

}

4562

],

4563

"fields": [ ~/~/Поля, где происходила выгрузка

4564

{

4565

"id": 0, ~/~/ идентификатор пользователя

4566

"name": "string" ~/~/ имя пользователя

4567

}

4568

],

4569

"event": "string", ~/~/Событие

4570

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4571

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4572

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4573

"cultureName": "string", ~/~/ название культуры

4574

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4575

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4576

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4577

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4578

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4579

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4580

"issued": 0, ~/~/Выдано, бункеров

4581

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4582

"latitude": 0, ~/~/Широта

4583

"longitude": 0, ~/~/ Долгота

4584

"litresAway": 0, ~/~/Отдано, л

4585

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4593

4594

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4595

4596

4597

(% class="box infomessage" %)

4598

(((

4599

GET api/v3/Vehicles/recyclebin/all

4600

)))

4601

4602

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4603

4604

Параметр запроса: {parentId} - идентификатор агента

4605

4606

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4613

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4614

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4615

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4616

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4617

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4618

"details": { ~/~/Список деталей объекта, помещённого в корзину

4619

"items": [ ~/~/

4620

nullable: true ~/~/Детали

4621

{

4622

"name": "string", ~/~/наименование столбца

4623

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4635

4636

(% class="box infomessage" %)

4637

(((

4638

POST/api/v3/Vehicles/recyclebin/erase

4639

)))

4640

4641

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4655

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4656

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4657

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4658

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4659

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4660

"details": { ~/~/Список деталей объекта, помещённого в корзину

4661

"items": [ ~/~/Детали

4662

{

4663

"name": "", ~/~/Имя свойства

4664

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4675

4676

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4677

4678

(% class="box infomessage" %)

4679

(((

4680

POST/api/v3/Vehicles/recyclebin/restore

4681

)))

4682

4683

В заголовках запроса: X-Auth: Токен авторизации

4684

4685

Параметры в теле запроса (JSON):

4686

4687

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4688

4689

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4712

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4713

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4714

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4715

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4716

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4717

"details": { ~/~/Список деталей объекта, помещённого в корзину

4718

"items": [ ~/~/Детали

4719

{

4720

"name": "string", ~/~/Имя свойства

4721

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4734

(((

4735

(% 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]] **

4736

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню