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

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

1602

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

1603

"customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)

1604

"vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)

1605

"vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)

1606

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные

1607

}

1608

1609

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

1610

1611

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

1612

1613

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

{

(((

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

)))

(((

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

1622

"name": "" ~/~/ наименование объекта

1623

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

1624

"deviceTypeId": "" ~/~/ идентификатор типа устройства

1625

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

1626

"sim1": "" ~/~/ первый номер телефона

1627

"sim2": "" ~/~/ второй номер телефона

1628

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

1629

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

1630

"modelId": "" ~/~/ идентификатор модели объекта

1631

"modelName": "" ~/~/ наименование модели объекта

1632

"unitId": "" ~/~/ идентификатор подразделения

1633

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

1634

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1635

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1636

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1637

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

1638

"customFields": [

1639

{

1640

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

1641

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

1642

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

1643

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

1644

"forTooltip": false, ~/~/ право на отображение в подсказке

1645

"forReport": false ~/~/ право на отображение в отчетах

)))

(((

}

],

"vehicleGroups": [ ~/~/ Группы ТС

1652

{

1653

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

1654

"name": "string" ~/~/ Наименование группы ТС

}

]

}

]

)))

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

1662

1663

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

1664

1665

(% class="box successmessage" %)

1666

(((

1667

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

1668

)))

1669

1670

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

1671

1672

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

1673

1674

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

1675

1676

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

1677

1678

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

1679

1680

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

1681

1682

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

1683

1684

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

1685

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

1686

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

1687

"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)

1688

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

1689

"data": "", ~/~/ Данные

1690

"overwrite": false, ~/~/ Флаг перезаписи

1691

"stage": "", ~/~/ Состояние, может быть null

1692

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

1693

1694

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

1695

1696

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

1697

"status": "", ~/~/ значение статуса

1698

"date": "", ~/~/ Дата смены статуса

1699

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

1700

"data": "", ~/~/ Данные

1701

"overwrite": false, ~/~/ Флаг перезаписи

1702

"stage": "", ~/~/ Состояние

1703

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

== ==

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

1708

1709

(% class="box warningmessage" %)

1710

(((

1711

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

1712

)))

1713

1714

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

1715

1716

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

1717

1718

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

1719

1720

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

1721

1722

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

1723

1724

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

1725

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

1726

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

1727

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

1728

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

1729

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

1730

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

1731

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

1732

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

1733

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

1734

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

1735

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

1736

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

1737

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

1738

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

1739

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

1740

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

1741

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

1742

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

1743

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

1744

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

1745

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

1746

1747

"mileageCalcMethod": 0,

1748

"mileageCoeff": 0,

1749

"locationByCellId": true,

1750

"dottedLineTrackWhenNoCoords": true,

1751

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

1752

{

1753

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

1754

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

1755

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

1756

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

1757

},

1758

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

1759

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

1760

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

1761

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

1762

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

1763

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

1764

},

1765

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

1766

{

1767

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

1768

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

1769

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

1770

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

1771

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

1772

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

1773

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

1774

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

1775

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

1776

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

1777

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

1778

}

1779

1780

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

1781

{

1782

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

"isDefault": true

}

],

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

1787

{

1788

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1795

{

1796

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

1797

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

1798

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

1799

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

1800

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

1801

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

1802

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

1803

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

1804

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

1805

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

1806

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

1807

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

1808

{

1809

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

1810

{

1811

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

1812

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

1813

}

1814

],

1815

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

1816

}

1817

],

1818

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

1819

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

1820

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

1821

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

1822

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

1823

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

1824

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

1825

"string"

1826

],

1827

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

1828

"additionalProp1": "string",

1829

"additionalProp2": "string",

1830

"additionalProp3": "string"

1831

},

1832

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

1833

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

1834

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

1835

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

1836

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

1837

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

1838

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

1839

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

1840

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

1841

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

1842

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

1843

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

1844

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

1845

1846

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

1847

{

1848

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

1849

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

1850

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

}

]

}

],

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

1856

1857

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

1858

{

1859

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

1860

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

1861

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

1862

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

1863

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

1864

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

}

]

}

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

(((

{

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

1875

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

1876

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

1877

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

1878

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

1879

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

1880

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

1881

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

1882

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

1883

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

1884

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

1885

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

1886

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

1887

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

1888

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

1889

"consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1890

"consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1891

"consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1892

"consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1893

"consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1894

"consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1895

"mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor

1896

"mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)

1897

"locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?

1898

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

1899

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

1900

"counters": { ~/~/ состояний счётчиков

1901

"mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"

1902

"motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"

1903

"mileage": 0, ~/~/ Пробег

1904

"motohours": 0 ~/~/ Моточасы

1905

},

1906

"cmsv6Parameters": { ~/~/ Dto для CMSv6

1907

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

1908

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

1909

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

)))

(((

~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1915

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

1916

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

1917

},

1918

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

1919

{

1920

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

1921

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

1922

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

1923

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

1924

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

1925

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

1926

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

1927

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

1928

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

1929

"kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы

1930

"lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО

1931

"maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации

1932

}

1933

],

1934

"drivers": [ ~/~/ Список водителей

1935

{

1936

"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.

1937

"inputNumber": 0, ~/~/ № входа.

1938

"createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.

1939

"comment": "string", ~/~/ Комментарий.

1940

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.

1941

"driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.

1942

"beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.

1943

"endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.

1944

}

1945

],

1946

"commandTemplates": [ ~/~/ Список шаблонов команд

1947

{

1948

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона

1949

"name": "string", ~/~/ Название шаблона команд

1950

"command": "string", ~/~/ Команда на выполнение

1951

"retries": 0 ~/~/ Лимит попыток отправки

1952

}

1953

],

1954

"sensors": [ ~/~/ Список датчиков

1955

{

1956

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

1957

"kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite

1958

"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

1979

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

1980

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,

)))

(((

~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

1985

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

1986

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

1987

"medianDegree": 0, ~/~/ Степень медианной фильтрации

1988

"isInverted": true, ~/~/ Признак инверсии

1989

"disabled": true, ~/~/ Датчик не участвует в обработке

1990

"gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs

1991

"gradesTables": [ ~/~/ Тарировка

1992

{

1993

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

1994

{

1995

"input": 0, ~/~/ Вход

1996

"output": 0 ~/~/ Выход

1997

}

1998

],

1999

"relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки

2000

}

2001

],

2002

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

2003

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

2004

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

2005

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

2006

"agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION

2007

"expr": "string", ~/~/ Выражение

2008

"children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков

2009

"string"

2010

],

2011

"customParams": { ~/~/ Дополнительные настройки

2012

"additionalProp1": "string",

2013

"additionalProp2": "string",

2014

"additionalProp3": "string"

2015

},

2016

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

2017

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

2018

{

2019

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

2020

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

2021

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

}

]

}

],

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

2027

"customFields": [ ~/~/ Список произвольных полей

2028

{

2029

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

2030

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

2031

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

2032

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

2033

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

2034

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

2035

}

2036

],

2037

"motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor

}

)))

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

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

2043

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

2044

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

2045

2046

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

2047

2048

(% class="box errormessage" %)

2049

(((

2050

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

2051

)))

2052

2053

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

2054

2055

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

2056

2057

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

2058

2059

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

2060

2061

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

2062

2063

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

2064

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

2065

2066

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

2067

2068

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

2069

2070

(% class="box infomessage" %)

2071

(((

2072

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

2073

)))

2074

2075

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

2076

2077

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

2078

2079

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

2080

2081

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

2082

2083

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

2084

2085

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

2086

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

2087

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

2088

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

2089

2090

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

2091

2092

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

2093

2094

(% class="box infomessage" %)

2095

(((

2096

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

2097

)))

2098

2099

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

2100

2101

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

2102

2103

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

2104

2105

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

2106

2107

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

2108

2109

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

2110

"id": "", ~/~/ ID типа датчика

2111

"name": "", ~/~/ Название

2112

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

2113

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

2114

2115

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =

2116

2117

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

2118

2119

(% class="box infomessage" style="text-align: left;" %)

2120

(((

2121

**POST /api/v3/terminalMessages/count**

2122

)))

2123

2124

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

2125

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.

2126

2127

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

2128

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

2129

2130

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

2131

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

2132

2133

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

2134

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

2135

2136

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

2137

{

2138

"vehicleIds": [

2139

id ~/~/ здесь передается список идентификаторов объектов

2140

],

2141

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

2142

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

2143

}

2144

2145

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

2146

Ответ:

2147

2148

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

2149

[

2150

{

2151

"vehicleId": 0, ~/~/ идентификатор объекта

2152

"count": 0 ~/~/ количество сообщений за период

}

]

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

2157

2158

(% class="box infomessage" style="text-align: left;" %)

2159

(((

2160

**POST /api/v3/terminalMessages/mapping**

2161

)))

2162

2163

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

2164

2165

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

2166

2167

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

2175

|protocolType|ID типа протокола

2176

|params|(((

2177

Массив наименований параметров в сообщении

)))

Ответ:

{

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

2197

|protocolType|Тип протокола

2198

|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2204

Перечень 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/]]

2205

2206

== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==

2207

2208

(% class="box infomessage" %)

2209

(((

2210

**POST /api/v3/terminalMessages**

2211

)))

2212

2213

Метод возвращает список сообщений терминала объекта за выбранный период.

2214

2215

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

2216

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

2217

2218

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

2219

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

2220

2221

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

2222

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

2223

2224

{

2225

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

2226

"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса

2227

"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса

2228

}

2229

2230

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

2231

|vehicleId|ID объекта

2232

|from|Дата и время начала периода запроса

2233

|to|Дата и время окончания периода запроса

Ответ:

[

{

"messages": [

{

"deviceTime": "2023-11-29T07:40:44.052Z",

2242

"serverTime": "2023-11-29T07:40:44.052Z",

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2252

"additionalProp2": "string",

2253

"additionalProp3": "string"

2254

},

2255

"photoCount": 0,

2256

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

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

2264

|deviceTime|Время сообщения терминала

2265

|serverTime|Время когда сообщение поступило на сервер

2266

|speed|Скорость

2267

|altitude|Высота над уровнем моря

2268

|latitude|Широта

2269

|longitude|Долгота

2270

|satellites|Кол-во спутников

2271

|course|Курс

2272

|voltage|Бортовое напряжение

2273

|parameters|Список параметров и их значений

2274

|photoCount|Количество фото

2275

|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы

2276

|protocolType|ID типа протокола

2277

2278

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

2279

2280

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

2281

2282

(% class="box infomessage" %)

2283

(((

2284

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**

2285

)))

2286

2287

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

2288

2289

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

2290

2291

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

2292

2293

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

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2298

"vehicleIds": [0], ~/~/ Список ID объектов

2299

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2300

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2301

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

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

2309

"name": "string", ~/~/ Имя ТС

2310

"periods": [ ~/~/ Периоды

2311

{

2312

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2313

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2314

"mileage": 0, ~/~/ Пробег за период, километры

2315

"mileageBegin": 0, ~/~/ Пробег на начало периода, километры

2316

"mileageEnd": 0, ~/~/ Пробег на окончание периода, километры

2317

"motohours": 0, ~/~/ Моточасы за период, секунды

2318

"motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды

2319

"motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды

}

]

}

]

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

2326

2327

(% class="box infomessage" %)

2328

(((

2329

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**

2330

)))

2331

2332

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

2333

2334

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

2335

2336

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

2337

2338

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

Тело запроса:

{

"sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.

2343

"vehicleIds": [0], ~/~/ Список ID объектов

2344

"from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода

2345

"to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода

2346

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

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

2354

"name": "string", ~/~/ Имя ТС

2355

"periods": [ ~/~/ Периоды

2356

{

2357

"start": "2023-08-09T14:23:14.574Z", ~/~/ Начало

2358

"end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание

2359

"fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода

2360

"fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода

2361

"fuelConsumption": 0, ~/~/ Расход топлива

2362

"fuelConsumptionMove": 0 ~/~/ Расход топлива в движении

}

]

}

]

(% class="box warningmessage" %)

2369

(((

2370

Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".

2371

\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".

2372

)))

2373

2374

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

2375

2376

(% class="box infomessage" %)

2377

(((

2378

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**

2379

)))

2380

2381

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

2382

2383

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

2384

2385

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

2386

2387

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

Тело запроса:

{

"vehicleIds": [0], ~/~/ Список ID объектов

2392

"from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса

2393

"to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса

2394

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

"start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода

2402

"end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода

2403

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

2404

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

2405

"model": "string", ~/~/ Модель объекта

2406

"fuels": [ ~/~/ Массив данным по заправкам и сливам

2407

{

2408

"event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив

2409

"startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало

2410

"endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание

2411

"valueFuel": 0, ~/~/ Количество

2412

"fuelStart": 0, ~/~/ Уровень топлива на начало события

2413

"fuelEnd": 0 ~/~/ Уровень топливо на конец события

}

]

}

]

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

2421

2422

(% class="box infomessage" %)

2423

(((

2424

**POST /api/v3/vehicles/moveStop**

2425

)))

2426

2427

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

2428

2429

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop

2430

2431

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

Тело запроса:

{

"vehicleIds": [ ], ~/~/ Список ID объектов

2438

"from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса

2439

"to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса

2440

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Ответ:

[

{

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

2448

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

2449

"moves": [ ~/~/ Событие движения

2450

{

2451

"mileage": 0, ~/~/ Пробег, км

2452

"eventId": 0, ~/~/ Идентификатор события

2453

"eventName": "string", ~/~/ Название события

2454

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2455

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2456

"duration": 0 ~/~/ Продолжительность события, секунд

2457

}

2458

],

2459

"stops": [ ~/~/ События стоянок

2460

{

2461

"address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты

2462

"eventId": 0, ~/~/ Идентификатор события

2463

"eventName": "string", ~/~/ Название события

2464

"start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события

2465

"end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события

2466

"duration": 0 ~/~/ Продолжительность события, секунд

}

]

}

]

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

2474

2475

(% class="box infomessage" %)

2476

(((

2477

**POST /api/v3/vehicles/getlastdata**

2478

)))

2479

2480

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

2481

2482

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata

2483

2484

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

2485

2486

2487

В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.

Ответ:

{

"vehicleId": 0, ~/~/Идентификатор объекта.

2492

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.

2493

"vehicleNumber": "string",~/~/Номер объекта.

2494

"receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер

2495

"recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.

2496

"state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.

2497

"speed": 0,~/~/Скорость объекта.

2498

"course": 0,~/~/Курс движения [0;360]

2499

"latitude": 0,~/~/Широта [-90°;90°].

2500

"longitude": 0,~/~/Долгота [-180°;180°].

2501

"address": "string",~/~/Адрес.

2502

"geozones": [ ~/~/Сведения по геозонам.

{

"id": 0,

"name": "string"

}

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

2510

2511

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

2512

2513

(% class="box infomessage" %)

2514

(((

2515

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**

2516

)))

2517

2518

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

2519

2520

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

2521

2522

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

2523

2524

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

2525

2526

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

2527

Тело запроса:

2528

2529

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

2530

{

2531

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

2532

}

2533

2534

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

Ответ:

[

{

"id": 0, ~/~/ Идентификатор объекта геозоны

2540

"name": "string", ~/~/ Название объекта геозоны

2541

"type": 0, ~/~/ Тип объекта геозоны

2542

"fname": "string", ~/~/ Имя файла

2543

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

2544

"radius": 0, ~/~/ Радиус геообъекта

2545

"beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета

2546

"endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета

2547

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

2548

"area": 0, ~/~/ Площадь, м^^2^^

2549

"perimetr": 0, ~/~/ Периметр, м

2550

"createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания

}

]

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

2555

2556

(% class="box infomessage" %)

2557

(((

2558

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**

2559

)))

2560

2561

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

2562

2563

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

2564

2565

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

2566

2567

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

2568

2569

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

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2574

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2575

"ids": [ ], ~/~/ Массив id объектов

2576

"byTime": 0, ~/~/ Объединение событий по времени

2577

"byDist": 0, ~/~/ Объединение событий по расстоянию

2578

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2579

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2586

"geozoneName": "string", ~/~/ Название геообъекта

2587

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2588

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2589

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2590

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

2591

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

}

]

== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==

2596

2597

(% class="box infomessage" %)

2598

(((

2599

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**

2600

)))

2601

2602

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

2603

2604

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

2605

2606

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

2607

2608

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

2609

2610

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

Тело запроса:

{

"startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса

2615

"endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания

2616

"ids": [ ], ~/~/ Массив id геообъектов

2617

"byTime": 0, ~/~/ Объединение событий по времени

2618

"byDist": 0, ~/~/ Объединение событий по расстоянию

2619

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

2620

"filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра

}

Ответ:

[

{

"geozoneId": 0, ~/~/ ID геообъекта

2628

"geozoneName": "string", ~/~/ Название геообъекта

2629

"startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда

2630

"endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда

2631

"duration": 0, ~/~/ Продолжительность нахождения в геообъекте

2632

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

2633

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

}

]

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

2638

2639

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

2640

2641

(% class="box infomessage" %)

2642

(((

2643

**POST /api/v3/notifications/find**

2644

)))

2645

2646

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

2647

2648

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

2649

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

2650

2651

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

2652

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

2653

2654

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

2655

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

2656

2657

{

2658

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

}

Ответ:

[

{

"id": 0, ~/~/ ID уведомления

2666

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

2667

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2668

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2669

"userId": "", ~/~/ Пользователь, создавший уведомление

2670

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

2671

"parentName": "string" ~/~/ Имя клиента

}

]

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

2676

2677

(% class="box infomessage" %)

2678

(((

2679

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

2680

)))

2681

2682

Метод возвращает данные правил формирования выбранного уведомления.

2683

2684

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

2685

Метод запроса **GET**

2686

2687

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

2688

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

2689

2690

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

2691

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

2692

2693

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

2694

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

2695

2696

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

2697

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

2698

2699

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

2700

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

2701

"id": 0, ~/~/ (%%)id уведомления

2702

(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2703

(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление

2704

(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента

2705

(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента

2706

(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления

2707

(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован

2708

(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа

2709

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

2710

],

2711

"geoids": [ ~/~/ (%%)Список id геообъектов для анализа

2712

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

2713

],

2714

"fieldids": [ ~/~/ (%%)Список id полей для анализа

2715

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

2716

],

2717

"settings": { ~/~/ Список параметров уведомления

2718

"additionalProp1": "string",

2719

"additionalProp2": "string",

2720

"additionalProp3": "string"

2721

},

2722

"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2723

(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2724

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

2725

],

2726

"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2727

(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений

2728

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

2729

],

2730

"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram

2731

(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.

2732

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

2733

"id": 0, ~/~/ (%%)Идентификатор участника чата

2734

(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения

2735

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

2736

],

2737

"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение

2738

(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы

2739

(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2740

(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления

2741

(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2742

(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)

2743

(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса

2744

(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)

2745

(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия

2746

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

2747

2748

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

2749

2750

(% class="box warningmessage" %)

2751

(((

2752

**PUT /api/v3/notifications/**

2753

)))

2754

2755

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

2756

2757

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

2758

2759

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications

2760

2761

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

Тело запроса:

{

"id": 0, ~/~/ id уведомления

2766

"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО

2767

"userId": "", ~/~/ Пользователь, создавший уведомление

2768

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

2769

"parentName": "string", ~/~/ Имя клиента

2770

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

2771

"active": true, ~/~/ Состояние true - активен, false - деактивирован

2772

"vehicleIds": [ ~/~/ Список id объектов для анализа

2773

0

2774

],

2775

"geoids": [ ~/~/ Список id геообъектов для анализа

2776

0

2777

],

2778

"fieldids": [ ~/~/ Список id полей для анализа

2779

0

2780

],

2781

"settings": { ~/~/ Список параметров уведомления

2782

"additionalProp1": "string",

2783

"additionalProp2": "string",

2784

"additionalProp3": "string"

2785

},

2786

"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"

2787

"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила

2788

""

2789

],

2790

"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"

2791

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

2792

"string"

2793

],

2794

"toTelegram": true, ~/~/ Флаг активности отправки в Telegram

2795

"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.

2796

{

2797

"id": 0, ~/~/ Идентификатор участника чата

2798

"info": "string" ~/~/ Дополнительные сведения

2799

}

2800

],

2801

"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение

2802

"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы

2803

"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.

2804

"kind": 0, ~/~/ Определяет вид уведомления

2805

"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время

2806

"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)

2807

"timezone": 0, ~/~/ Сдвиг часового пояса

2808

"validity": 0, ~/~/ Срок действия в днях (1-90)

2809

"autoProlongation": true ~/~/ Автопродление срока действия

}

Ответ:

Success

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

2818

2819

(% class="box warningmessage" %)

2820

(((

2821

**PUT** /api/v3/notifications/prolongation

2822

)))

2823

2824

Метод позволяет продлить уведомления.

2825

2826

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

2827

2828

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation

2829

2830

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

Тело запроса:

[

0

]

где 0 идентификатор ids.

2841

2842

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

2843

2844

(% class="box errormessage" %)

2845

(((

2846

**DELETE /api/v3/notifications/{id}**

2847

)))

2848

2849

Метод позволяет удалить выбранное уведомление.

2850

2851

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

2852

2853

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}

2854

2855

Передаваемый параметр: {id} - id уведомления

2856

2857

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

Ответ:

Success

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

2865

2866

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

2867

2868

(% class="box infomessage" %)

2869

(((

2870

**POST /api/v3/Drivers/find**

2871

)))

2872

2873

Передается параметр: parentId - ID клиента-родителя

Ответ:

[

{

"name": "string", ~/~/ Определяет наименование

2880

"description": "string", ~/~/ Определяет описание

2881

"hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма

2882

"chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения

2883

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2884

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2885

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2886

"deleted": true ~/~/ Признак удаления

}

]

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

2891

2892

(% class="box infomessage" %)

2893

(((

2894

**GET /api/v3/Drivers/{driverGuid}**

2895

)))

2896

2897

Передается параметр: ID водителя

Ответ:

{

"name": "string", ~/~/ Определяет наименование

2903

"description": "string", ~/~/ Определяет описание

2904

"hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма

2905

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2906

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2907

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2908

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2909

"deleted": true ~/~/ Признак удаления

2910

}

2911

2912

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

2913

2914

(% class="box successmessage" %)

2915

(((

2916

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2924

"hiredate": "2023-06-30T12:50:54.020Z",

2925

"chopdate": "2023-06-30T12:50:54.020Z",

2926

"exclusive": true,

2927

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

2928

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2937

"hiredate": "2023-06-30T12:50:54.051Z",

2938

"chopdate": "2023-06-30T12:50:54.051Z",

2939

"exclusive": true,

2940

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

2941

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

"deleted": true

}

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

2947

2948

(% class="box warningmessage" %)

2949

(((

2950

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2958

"hiredate": "2023-06-30T12:50:27.910Z",

2959

"chopdate": "2023-06-30T12:50:27.910Z",

2960

"exclusive": true,

2961

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

2962

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2971

"hiredate": "2023-06-30T12:50:27.929Z",

2972

"chopdate": "2023-06-30T12:50:27.929Z",

2973

"exclusive": true,

2974

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

2975

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

"deleted": true

}

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

2981

2982

(% class="box errormessage" %)

2983

(((

2984

**DELETE /api/v3/Drivers/{driverGuid}**

2985

)))

2986

2987

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2995

2996

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2997

2998

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

2999

3000

(% class="box infomessage" %)

3001

(((

3002

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3010

],

3011

"BeginTime": "2023-06-30T12:49:04.365Z",

3012

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

3021

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

3022

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

3023

"BeginTime": "2023-06-30T09:52:31.240Z",

3024

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

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

3030

3031

(% class="box infomessage" %)

3032

(((

3033

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

3043

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

3052

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

3053

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

3054

"BeginTime": "2023-06-30T09:54:01.631Z",

3055

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

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

3061

3062

(% class="box successmessage" %)

3063

(((

3064

**POST /api/v3/DriversVehiclesAssignments**

3065

)))

3066

3067

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

3074

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

3075

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3076

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

3077

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

3087

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

3088

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

3089

"BeginTime": "2023-06-30T11:04:46.903Z",

3090

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

3096

3097

(% class="box warningmessage" %)

3098

(((

3099

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

3108

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3109

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

3110

"BeginTime": "2023-06-30T11:14:08.117Z",

3111

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

3121

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

3122

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

3123

"BeginTime": "2023-06-30T11:14:53.349Z",

3124

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

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

3130

3131

(% class="box errormessage" %)

3132

(((

3133

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

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

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

3148

3149

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

3150

3151

(% class="box infomessage" %)

3152

(((

3153

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3161

],

3162

"BeginTime": "2023-06-30T12:47:12.162Z",

3163

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3171

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3172

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3173

"BeginTime": "2023-06-30T11:19:40.703Z",

3174

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

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

3180

3181

(% class="box infomessage" %)

3182

(((

3183

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3191

],

3192

"BeginTime": "2023-06-30T12:47:12.162Z",

3193

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3201

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3202

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3203

"BeginTime": "2023-06-30T11:19:40.703Z",

3204

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

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

3210

3211

(% class="box successmessage" %)

3212

(((

3213

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

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

3221

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

3222

"BeginTime": "2023-06-30T11:27:08.635Z",

3223

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

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

3232

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

3233

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

3234

"BeginTime": "2023-06-30T11:27:08.677Z",

3235

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

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

3241

3242

(% class="box warningmessage" %)

3243

(((

3244

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

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

3252

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

3253

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

3254

"BeginTime": "2023-06-30T11:28:43.330Z",

3255

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

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

3264

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

3265

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

3266

"BeginTime": "2023-06-30T11:28:43.331Z",

3267

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

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

3273

3274

(% class="box errormessage" %)

3275

(((

3276

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3291

3292

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

3293

3294

(% class="box infomessage" %)

3295

(((

3296

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3304

],

3305

"BeginTime": "2023-06-30T12:45:10.852Z",

3306

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

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

3314

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

3315

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

3316

"BeginTime": "2023-06-30T11:58:04.695Z",

3317

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

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

3323

3324

(% class="box infomessage" %)

3325

(((

3326

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3334

],

3335

"BeginTime": "2023-06-30T12:45:10.852Z",

3336

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

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

3344

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

3345

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

3346

"BeginTime": "2023-06-30T11:58:04.695Z",

3347

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

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

3353

3354

(% class="box successmessage" %)

3355

(((

3356

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

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

3364

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

3365

"BeginTime": "2023-06-30T12:09:53.175Z",

3366

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

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

3375

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

3376

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

3377

"BeginTime": "2023-06-30T12:09:53.201Z",

3378

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

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

3384

3385

(% class="box warningmessage" %)

3386

(((

3387

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

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

3395

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

3396

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

3397

"BeginTime": "2023-06-30T12:09:53.201Z",

3398

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

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

3407

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

3408

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

3409

"BeginTime": "2023-06-30T12:09:53.201Z",

3410

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

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

3416

3417

(% class="box errormessage" %)

3418

(((

3419

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

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

3434

3435

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

3436

3437

(% class="box infomessage" %)

3438

(((

3439

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3446

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

3452

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3453

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3454

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3455

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

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

[

{

"SD": "2023-11-14T10:48:03.717Z",

3462

"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",

3472

"name": "string",

3473

"rid": "string",

3474

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

3475

"trailer": {

3476

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

3477

"Number": "string",

3478

"Description": "string",

3479

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

3480

"ExternalID": "string",

3481

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

3482

"CreateTime": "2023-11-14T10:48:03.717Z",

3483

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

3491

|SD|Дата и время начала события

3492

|ED|Дата и время окончания события

3493

|id|ID объекта

3494

|SLat|Широта начальной координаты

3495

|SLon|Долгота начальной координаты

3496

|ELat|Широта конечной координаты

3497

|ELon|Долгота конечной координаты

3498

|mileage|Пробег

3499

|Duration|Продолжительность

3500

|Address|Адрес начального местоположения

3501

|Address2|Адрес конечного местоположения

3502

|name|Имя радиометки

3503

|rid|Номер радиометки

3504

|rguid|ID радиометки

3505

|trailer|Информация об агрегате

3506

|ModelGuid|ID агрегата

3507

|Number|Название/номер агрегата

3508

|Description|Текст примечания агрегата

3509

3510

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

3511

3512

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

3513

3514

(% class="box infomessage" %)

3515

(((

3516

**POST /api/v3/Rfids/find**

)))

Запрос:

{

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

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

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

3533

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

}

]

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

3538

|parentId|ID клиента

3539

|name|Название карты-метки

3540

|number|Номер

3541

|period|Период запросов в секундах (работает только для агрегатов)

3542

|id|ID карты-метки

3543

3544

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

3545

3546

(% class="box infomessage" %)

3547

(((

3548

**GET /api/v3/Rfids/{rfidGuid}**

3549

)))

3550

3551

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

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

3561

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

}

]

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

3566

|name|Название карты-метки

3567

|number|Номер

3568

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

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

3573

3574

(% class="box successmessage" %)

3575

(((

3576

**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",

3595

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

3596

}

3597

3598

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

3599

|name|Название карты-метки

3600

|number|Номер

3601

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

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

3606

3607

(% class="box warningmessage" %)

3608

(((

3609

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

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

3619

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

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

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

3629

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

3630

}

3631

3632

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

3633

|name|Название карты-метки

3634

|number|Номер

3635

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

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

3640

3641

(% class="box errormessage" %)

3642

(((

3643

**DELETE /api/v3/Rfids/{rfidGuid}**

3644

)))

3645

3646

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

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

3654

3655

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

3656

3657

(% class="box infomessage" %)

3658

(((

3659

**GET /api/v3/Billing/client/balance/{clientId}**

3660

)))

3661

3662

Параметр запроса: **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);" %)**Описание**

3672

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

3673

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3674

3675

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

3676

3677

(% class="box infomessage" %)

3678

(((

3679

**GET /api/v3/Billing/client/constraint/{clientId}**

3680

)))

3681

3682

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

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

3688

"CalculationType": 0,

3689

"PermissibleBalance": 0,

3690

"DefermentDays": 0,

3691

"SendUiNotifications": true,

3692

"SendEmailNotifications": true,

"IsPrivate": true,

}

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

3697

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

3698

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3699

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3700

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3701

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3702

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3703

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3704

3705

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

3706

3707

(% class="box infomessage" %)

3708

(((

3709

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3715

3716

**planId **- идентификатор тарифного плана.

Ответ:

{

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

3722

"Plan": { **~/~/ Описание тарифного плана**

3723

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

3724

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

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3729

"PermissibleBalance": 0,

3730

"DefermentDays": 0

3731

},

3732

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3744

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

3760

|ClientId|Идентификатор клиента

3761

|Id|Идентификатор тарифного плана

3762

|OwnerId|Идентификатор клиента-владельца

3763

|Name|Наименование тарифного плана

3764

|IsArchived|Признак, определяющий архивный тарифный план

3765

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3766

|PermissibleBalance|Допустимый баланс

3767

|DefermentDays|Отсрочка, количество дней

3768

|Feature|Код услуги

3769

|IsEnabled|Признак, определяющий активирована ли услуга

3770

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3771

|IsFactual|Признак, определяющий расчёт по факту

3772

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3773

|Price|Цена за единицу.

3774

|DebitDate|Следующий момент времени списания с баланса за услугу.

3775

|PeriodValue|Значение периода.

3776

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3777

3778

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3779

3780

(% class="box infomessage" %)

3781

(((

3782

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3783

)))

3784

3785

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

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

3792

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

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3797

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

3814

|ClientId|Идентификатор клиента

3815

|Id|Идентификатор тарифного плана

3816

|OwnerId|Идентификатор клиента-владельца

3817

|Name|Наименование тарифного плана

3818

|IsArchived|Признак, определяющий архивный тарифный план

3819

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3820

|PermissibleBalance|Допустимый баланс

3821

|DefermentDays|Отсрочка, количество дней

3822

|Feature|Код услуги

3823

|IsFactual|Признак, определяющий расчёт по факту

3824

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3825

|Price|Цена за единицу.

3826

|PeriodValue|Значение периода.

3827

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3828

3829

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

3830

3831

(% class="box infomessage" %)

3832

(((

3833

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3834

)))

3835

3836

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

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

3843

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

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3848

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

3865

|ClientId|Идентификатор клиента

3866

|Id|Идентификатор тарифного плана

3867

|OwnerId|Идентификатор клиента-владельца

3868

|Name|Наименование тарифного плана

3869

|IsArchived|Признак, определяющий архивный тарифный план

3870

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3871

|PermissibleBalance|Допустимый баланс

3872

|DefermentDays|Отсрочка, количество дней

3873

|Feature|Код услуги

3874

|IsFactual|Признак, определяющий расчёт по факту

3875

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3876

|Price|Цена за единицу.

3877

|PeriodValue|Значение периода.

3878

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3879

3880

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

3881

3882

(% class="box warningmessage" %)

3883

(((

3884

**PUT /api/v3/Billing/client/balance**

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

(% class="box warningmessage" %)

3905

(((

3906

**PUT /api/v3/billing/client/balance/deposit**

3907

)))

3908

3909

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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

Создает операцию **Списание **с указанной суммой

3927

3928

(% class="box warningmessage" %)

3929

(((

3930

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

3943

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

3944

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3945

3946

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3947

3948

(% class="box warningmessage" %)

3949

(((

3950

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

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

3957

"CalculationType": 0,

3958

"PermissibleBalance": 0,

3959

"DefermentDays": 0,

3960

"SendUiNotifications": true,

3961

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

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

3968

|ClientId|Идентификатор клиента

3969

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3970

|PermissibleBalance|Допустимый баланс

3971

|DefermentDays|(((

3972

Отсрочка, количество дней

3973

)))

3974

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3975

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3976

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3977

3978

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3979

3980

(% class="box warningmessage" %)

3981

(((

3982

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

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

3989

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

4007

|ClientId|Идентификатор клиента

4008

|PlanId|Идентификатор тарифного плана

4009

|Feature|Код услуги

4010

|IsEnabled|Признак, определяющий активирована ли услуга

4011

|IsFactual|Признак, определяющий расчёт по факту

4012

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

4013

|Price|Цена за единицу.

4014

|DebitDate|Следующий момент времени списания с баланса за услугу.

4015

|PeriodValue|Значение периода.

4016

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

4017

4018

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

4019

4020

(% class="box warningmessage" %)

4021

(((

4022

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

4023

)))

4024

4025

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

4026

4027

(% class="box infomessage" %)

4028

(((

4029

**POST /api/v3/vehicles/import/{agentId}**

4030

)))

4031

4032

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

4033

4034

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

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

4043

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

4044

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

4045

4046

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

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

4051

|data|В значении передаем файл объекта, формат **xml** или **wlp **

4052

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

4063

|vehicleId|ID созданного объекта

4064

|name|Имя созданного объекта

4065

|errors|Ошибки и их описание

4066

4067

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

4068

4069

(% class="box infomessage" %)

4070

(((

4071

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

4072

)))

4073

4074

(% class="wikigeneratedid" %)

4075

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

4076

4077

(% class="wikigeneratedid" %)

4078

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

4083

4084

В теле использовать тип **form-data.**

Ключи:

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

4089

|**history**|В значении передавать файл с историей

4090

4091

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

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

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

4104

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

4112

|results|Результаты импорта в разрезе ТС

4113

|vehicleGuid|Guid ТС

4114

|vehicleId|ID ТС

4115

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

4116

|firstMessageDate|Дата первого импортированного сообщения (UTC)

4117

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

4118

|producedCount|Кол-во успешно отправленных в шину данных сообщений

4119

|msgCount|Кол-во обработанных сообщений всего

4120

4121

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

4122

4123

(% class="box infomessage" %)

4124

(((

4125

**GET /api/v3/vehicles/import/history/status**

4126

)))

4127

4128

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

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

4139

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

4140

|progress|Guid ТС

4141

4142

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

4143

4144

(% class="box infomessage" %)

4145

(((

4146

**POST /api/v3/vehicles/export**

4147

)))

4148

4149

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

4158

4159

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

4160

4161

(% class="box infomessage" %)

4162

(((

4163

**POST /api/v3/vehicles/export/history**

4164

)))

4165

4166

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4174

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4180

4181

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

4182

|vehicleId|ID объекта

4183

|asArchive|true - Архивировать файл, False - не архивировать

4184

|from|Дата и время начала запроса

4185

|to|Дата и время окончания запроса

4186

4187

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4188

4189

(% class="box infomessage" %)

4190

(((

4191

**GET /api/v3/vehicles/export/history/status**

4192

)))

4193

4194

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

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

4205

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4206

|progress|Прогресс экспорта, от 0 до 100%

4207

|message|Текст описывающий статус

4208

4209

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4210

4211

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4212

4213

(% class="box infomessage" %)

4214

(((

4215

**POST /api/v3/EcoDriving/rating**

4216

)))

4217

4218

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId], ~/~/Массив ID объектов

4224

"from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса

4225

"to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса

}

Ответ:

{

"items": [ ~/~/ Список в разрезе ТС

4232

{

4233

"from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода

4234

"to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода

4235

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

4236

"vehicleName": "string", ~/~/ Название ТС

4237

"vehicleModel": "string", ~/~/ Модель ТС

4238

"penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС

4239

"score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС

4240

"totalViolations": 0, ~/~/ Нарушений всего

4241

"violationsByType": { ~/~/ Информация о нарушениях по типу

4242

"overspeedingViolations": 0, ~/~/ Нарушений превышения скорости

4243

"accelerationViolations": 0, ~/~/ Нарушений ускорения

4244

"brakingViolations": 0, ~/~/ Нарушений торможения

4245

"turningViolations": 0, ~/~/ Нарушений опасного поворота

4246

"dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения

4247

"sensorViolations": 0 ~/~/ Нарушений по датчику

},

(((

)))

"moveTime": 0, ~/~/ Продолжительность движения, сек

4255

"mileage": 0, ~/~/ Пробег, м

4256

"tripsCount": 0, ~/~/ Кол-во рейсов

4257

"trips": [ ~/~/ Информация по рейсу

4258

{

4259

"penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс

4260

"score": 0, ~/~/ Рассчитанная оценка вождения за рейс

4261

"violationsCount": 0, ~/~/ Всего нарушений

4262

"violationsByType": { ~/~/ Информация о нарушениях по типу

4263

"overspeedingViolations": 0, ~/~/ Нарушений превышения скорости

4264

"accelerationViolations": 0, ~/~/ Нарушений ускорения

4265

"brakingViolations": 0, ~/~/ Нарушений торможения

4266

"turningViolations": 0, ~/~/ Нарушений опасного поворота

4267

"dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения

4268

"sensorViolations": 0 ~/~/ Нарушений по датчику

4269

},

4270

4271

"startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки

4272

"endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки

4273

"moveTime": 0, ~/~/ Продолжительность движения, сек

4274

"mileage": 0, ~/~/ Пробег, м

4275

"motohours": 0, ~/~/ Моточасы, секунды

4276

"maxSpeed": 0, ~/~/ Максимальная скорость за рейс

4277

"startAddress": "string", ~/~/ Адрес начала рейса

4278

"endAddress": "string", ~/~/ Адрес конца рейса

4279

"drivers": [ ~/~/ Список водителей

4280

{

4281

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя

4282

"driverName": "string", ~/~/ФИО водителя

4283

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки

}

]

}

]

}

]

}

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

4293

4294

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4295

4296

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4297

4298

(% class="box infomessage" %)

4299

(((

4300

POST /api/v3/fuelcards/transactions

)))

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

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4306

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

4307

4308

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

4309

4310

{

4311

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4312

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4313

"ids": [

4314

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4315

],

4316

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4323

"driver": "string", ~/~/Водители, привязанные к ТК

4324

"object": "string", ~/~/Наименование ТС

4325

"amount": 0, ~/~/Количество топлива

4326

"amountDut": 0, ~/~/Количество по ДУТ

4327

"amountDiff": 0, ~/~/Разница, л

4328

"amountDiffPerc": 0, ~/~/Разница, %

4329

"summa": 0, ~/~/Стоимость, руб

4330

"serviceName": "string", ~/~/Тип топлива

4331

"price": 0, ~/~/Цена за литр, руб

4332

"cardName": "string", ~/~/Наименование ТК

4333

"cardNum": "string", ~/~/Номер ТК

4334

"operator": "string", ~/~/Оператор ТК

4335

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4340

4341

4342

== **Получение полных данных о ретрансляторе** ==

4343

4344

(% class="box infomessage" %)

4345

(((

4346

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

4347

)))

4348

4349

Идентификатор запроса: ID

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

{

"description": "", ~/~/ Определяет описание

4356

"subscriberId": "", ~/~/ Подписчик

4357

"protocolType": 0, ~/~/ Тип протокола

4358

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4359

"address": "string", ~/~/ Адрес события

4360

"objects": [ ~/~/Объекты для ретрансляции

4361

{

4362

"id": "", ~/~/ Идентификатор объекта ретрансляции

4363

"name": "", ~/~/ Наименование объекта ретрансляции

4364

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

4365

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4366

}

4367

],

4368

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

4369

"parentId": "", ~/~/Guid родителя

4370

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4375

4376

(% class="box infomessage" %)

4377

(((

4378

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4385

4386

(% class="box infomessage" %)

4387

(((

4388

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

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

4395

"subscriberId": "", ~/~/ Подписчик

4396

"protocolType": 0, ~/~/ Тип протокола

4397

"address": "", ~/~/ Адрес ретрансляции

4398

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4399

"objects": [ ~/~/Объекты для ретрансляции

4400

{

4401

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

4402

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

4403

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4413

"subscriberId": "", ~/~/ идентификатор запроса

4414

"protocolType": 0, ~/~/ Тип протокола

4415

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4416

"address": "", ~/~/ Адрес события

4417

"objects": [ ~/~/Объекты для ретрансляции

4418

{

4419

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

4420

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

4421

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

4422

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4423

}

4424

],

4425

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

4426

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

4427

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4432

4433

(% class="box infomessage" %)

4434

(((

4435

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

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

4442

"description": "string", ~/~/ Определяет описание

4443

"subscriberId": "", ~/~/ идентификатор запроса

4444

"protocolType": 0, ~/~/ Тип протокола

4445

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4446

"address": "string", ~/~/ Адрес события

4447

"objects": ~/~/Объекты для ретрансляции

4448

[

4449

{

4450

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

4451

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

4452

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

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

{

"description": "", ~/~/ Определяет описание

4462

"subscriberId": "", ~/~/ идентификатор запроса

4463

"protocolType": 0, ~/~/ Тип протокола

4464

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4465

"address": "string", ~/~/ Адрес события

4466

"objects": [ ~/~/Объекты для ретрансляции

4467

{

4468

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

4469

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

4470

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

4471

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4472

}

4473

],

4474

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

4475

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

4476

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4481

4482

(% class="box infomessage" %)

4483

(((

4484

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

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

4491

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4492

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4500

"subscriberId": "", ~/~/ идентификатор запроса

4501

"protocolType": 0, ~/~/ Тип протокола

4502

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4503

"address": "string", ~/~/ Адрес события

4504

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

4505

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

4506

"deleted": true ~/~/ Признак удаления

}

]

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

4512

4513

== **API для отчета по выгрузке комбайнов** ==

4514

4515

(% class="box infomessage" %)

4516

(((

4517

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4524

"byDist": 0, ~/~/ Объединение событий по расстоянию

4525

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4526

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4527

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4528

"vehicleIds": [ ~/~/ Список id объектов для анализа

4529

0

4530

],

4531

"from": "", ~/~/ Дата и время начало запроса

4532

"to": "", ~/~/ Дата и время окончания запроса

4533

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

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

[

{

"harvesterName": "", ~/~/Комбайн, номер

4541

"harvesterId": 0, ~/~/Комбайн, id

4542

"harvesterModel": "", ~/~/ Модель комбайна

4543

"hopperCapacity": 0, ~/~/ Объем бункера м3

4544

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4545

"events": [ ~/~/Список событий в разрезе комбайна

4546

{

4547

"driverId": "", ~/~/Идентификатор водителя

4548

"driverName": "", ~/~/Водитель комбайна, ФИО

4549

"RFID": "", ~/~/ идентификатор карты-метки

4550

"rfidName": "", ~/~/Водитель комбайна, имя метки

4551

"vehicleId": 0, ~/~/идентификатор объекта

4552

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

4553

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

4554

"nearestVehicles": [ ~/~/Объекты рядом

4555

{

4556

"vehicleId": 0, ~/~/идентификатор объекта

4557

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

4558

}

4559

],

4560

"fields": [ ~/~/Поля, где происходила выгрузка

4561

{

4562

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

4563

"name": "string" ~/~/ имя пользователя

4564

}

4565

],

4566

"event": "string", ~/~/Событие

4567

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4568

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4569

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4570

"cultureName": "string", ~/~/ название культуры

4571

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4572

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4573

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4574

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4575

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4576

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4577

"issued": 0, ~/~/Выдано, бункеров

4578

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4579

"latitude": 0, ~/~/Широта

4580

"longitude": 0, ~/~/ Долгота

4581

"litresAway": 0, ~/~/Отдано, л

4582

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

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

4590

4591

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

4592

4593

4594

(% class="box infomessage" %)

4595

(((

4596

GET api/v3/Vehicles/recyclebin/all

4597

)))

4598

4599

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4600

4601

Параметр запроса: {parentId} - идентификатор агента

4602

4603

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

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4610

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4611

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4612

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4613

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4614

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4615

"details": { ~/~/Список деталей объекта, помещённого в корзину

4616

"items": [ ~/~/

4617

nullable: true ~/~/Детали

4618

{

4619

"name": "string", ~/~/наименование столбца

4620

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

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

4632

4633

(% class="box infomessage" %)

4634

(((

4635

POST/api/v3/Vehicles/recyclebin/erase

4636

)))

4637

4638

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

Пример запроса:

[

0

]

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

[

{

"recordTime": "", ~/~/Время записи

4652

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4653

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4654

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4655

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4656

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4657

"details": { ~/~/Список деталей объекта, помещённого в корзину

4658

"items": [ ~/~/Детали

4659

{

4660

"name": "", ~/~/Имя свойства

4661

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

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

4672

4673

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

4674

4675

(% class="box infomessage" %)

4676

(((

4677

POST/api/v3/Vehicles/recyclebin/restore

4678

)))

4679

4680

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

4681

4682

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

4683

4684

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4685

4686

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

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

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

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4709

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4710

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4711

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4712

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4713

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4714

"details": { ~/~/Список деталей объекта, помещённого в корзину

4715

"items": [ ~/~/Детали

4716

{

4717

"name": "string", ~/~/Имя свойства

4718

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4731

(((

4732

(% 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]] **

4733

)))

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

Меню