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

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

1379

{

1380

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1391

1392

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

1393

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

1394

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

1395

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

1396

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

1397

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

1398

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

1399

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

1400

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

1401

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

1402

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

1403

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

1404

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

1405

"mileageEnabled": true,

1406

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

1411

"id": null,

1412

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

1413

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

1414

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

1415

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

1416

},

1417

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

1418

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

1419

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

1420

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

1421

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

1422

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

1423

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

1424

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

1425

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

1426

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

1427

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

1428

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

1429

}

1430

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

1431

1432

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

1433

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

1434

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

1435

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

1436

1437

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

1438

1439

(% class="box infomessage" %)

1440

(((

1441

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

1442

)))

1443

1444

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

1445

1446

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

1447

1448

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

1449

1450

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

1451

1452

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

1453

1454

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

1455

1456

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

1457

1458

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

1459

1460

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

1461

1462

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

1463

1464

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

1465

1466

(% style="color:#000000" %)− X-Auth: Токен авторизации

1467

1468

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

1469

1470

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

1471

1472

{

1473

"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

1474

"name": null, ~/~/ Имя ТС (string, опционально)

1475

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

1476

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

1477

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

1478

"parentId": null, ~/~/ ID клиента (Guid, опционально)

1479

"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)

1480

"customFields": null ~/~/ значение любого из произвольных полей ТС

1481

}

1482

1483

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

1484

1485

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

1486

1487

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

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

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

1495

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

1496

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

1497

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

1498

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

1499

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

1500

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

1501

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

1502

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

1503

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

1504

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

1505

"customFields": [

1506

{

1507

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

1508

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

1509

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

1510

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

1511

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

1512

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

1513

}(%%)

1514

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

1515

1516

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

1517

1518

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

1519

1520

(% class="box successmessage" %)

1521

(((

1522

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

1523

)))

1524

1525

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

1526

1527

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

1528

1529

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

1530

1531

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

1532

1533

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

1534

1535

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

1536

1537

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

1538

1539

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

1540

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

1541

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

1542

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

1543

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

1544

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

1545

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

1546

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

1547

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

1548

1549

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

1550

1551

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

1552

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

1553

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

1554

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

1555

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

1556

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

1557

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

1558

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

== ==

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

1563

1564

(% class="box warningmessage" %)

1565

(((

1566

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

1567

)))

1568

1569

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

1570

1571

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

1572

1573

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

1574

1575

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

1576

1577

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

1578

1579

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

1580

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

1581

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

1582

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

1583

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

1584

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

1585

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

1586

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

1587

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

1588

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

1589

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

1590

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

1591

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

1592

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

1593

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

1594

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

1595

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

1596

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

1597

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

1598

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

1599

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

1600

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

1601

1602

"mileageCalcMethod": 0,

1603

"mileageCoeff": 0,

1604

"locationByCellId": true,

1605

"dottedLineTrackWhenNoCoords": true,

1606

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

1607

{

1608

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

1609

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

1610

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

1611

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

1612

},

1613

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

1614

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

1615

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

1616

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

1617

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

1618

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

1619

},

1620

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

1621

{

1622

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

1623

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

1624

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

1625

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

1626

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

1627

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

1628

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

1629

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

1630

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

1631

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

1632

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

1633

}

1634

1635

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

1636

{

1637

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

"isDefault": true

}

],

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

1642

{

1643

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1650

{

1651

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

1652

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

1653

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

1654

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

1655

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

1656

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

1657

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

1658

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

1659

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

1660

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

1661

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

1662

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

1663

{

1664

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

1665

{

1666

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

1667

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

1668

}

1669

],

1670

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

1671

}

1672

],

1673

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

1674

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

1675

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

1676

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

1677

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

1678

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

1679

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

1680

"string"

1681

],

1682

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

1683

"additionalProp1": "string",

1684

"additionalProp2": "string",

1685

"additionalProp3": "string"

1686

},

1687

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

1688

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

1689

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

1690

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

1691

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

1692

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

1693

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

1694

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

1695

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

1696

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

1697

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

1698

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

1699

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

1700

}

1701

],

1702

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

1703

{

1704

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

1715

1716

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

1717

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

1718

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

1719

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

1720

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

1721

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

1722

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

1723

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

1724

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

1725

"sim1": "", ~/~/ SIM 1

1726

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

1727

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

1728

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

1729

"counters":

1730

{

1731

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

1732

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

1733

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

1734

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

1735

}

1736

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

1737

{

1738

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

1739

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

1740

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

1741

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

1742

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

1743

}

1744

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

1745

{

1746

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

1747

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

1748

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

1749

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

1750

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

1751

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

1752

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

1753

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

1754

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

1755

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

1756

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

1757

}

1758

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

1759

1760

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

1761

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

1762

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

1763

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

1764

1765

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

1766

1767

(% class="box errormessage" %)

1768

(((

1769

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

1770

)))

1771

1772

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

1773

1774

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

1775

1776

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

1777

1778

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

1779

1780

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

1781

1782

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

1783

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

1784

1785

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

1786

1787

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

1788

1789

(% class="box infomessage" %)

1790

(((

1791

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

1792

)))

1793

1794

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

1795

1796

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

1797

1798

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

1799

1800

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

1801

1802

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

1803

1804

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

1805

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

1806

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

1807

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

1808

1809

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

1810

1811

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

1812

1813

(% class="box infomessage" %)

1814

(((

1815

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

1816

)))

1817

1818

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

1819

1820

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

1821

1822

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

1823

1824

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

1825

1826

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

1827

1828

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

1829

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

1830

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

1831

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

1832

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

1833

1834

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

1835

1836

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

1837

1838

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

1839

(((

1840

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

1841

)))

1842

1843

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

1844

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

1845

1846

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

1847

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

1848

1849

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

1850

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

1851

1852

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

1853

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

1854

1855

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

1856

{

1857

"vehicleIds": [

1858

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

1859

],

1860

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

1861

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

1862

}

1863

1864

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

1865

Ответ:

1866

1867

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

1868

[

1869

{

1870

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

1871

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

}

]

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

1876

1877

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

1878

(((

1879

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

1880

)))

1881

1882

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

1883

1884

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

1885

1886

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

1894

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

1895

|params|(((

1896

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

)))

Ответ:

{

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

1916

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

1917

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

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

1923

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

1924

1925

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

1926

1927

(% class="box infomessage" %)

1928

(((

1929

**POST /api/v3/terminalMessages**

1930

)))

1931

1932

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

1933

1934

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

1935

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

1936

1937

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

1938

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

1939

1940

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

1941

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

1942

1943

{

1944

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

1945

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

1946

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

1947

}

1948

1949

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

1950

|vehicleId|ID объекта

1951

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

1952

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

Ответ:

[

{

"messages": [

{

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

1961

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

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

1971

"additionalProp2": "string",

1972

"additionalProp3": "string"

1973

},

1974

"photoCount": 0,

1975

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

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

1983

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

1984

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

1985

|speed|Скорость

1986

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

1987

|latitude|Широта

1988

|longitude|Долгота

1989

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

1990

|course|Курс

1991

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

1992

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

1993

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

1994

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

1995

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

1996

1997

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

1998

1999

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

2000

2001

(% class="box infomessage" %)

2002

(((

2003

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

2004

)))

2005

2006

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

2007

2008

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

2009

2010

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

2011

2012

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

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

{

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

2017

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

2018

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

2019

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

2020

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

}

Ответ:

[

{

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

2028

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

2029

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

2030

{

2031

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

2032

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

2033

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

2034

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

2035

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

2036

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

2037

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

2038

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

}

]

}

]

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

2045

2046

(% class="box infomessage" %)

2047

(((

2048

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

2049

)))

2050

2051

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

2052

2053

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

2054

2055

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

2056

2057

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

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

{

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

2062

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

2063

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

2064

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

2065

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

}

Ответ:

[

{

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

2073

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

2074

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

2075

{

2076

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

2077

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

2078

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

2079

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

2080

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

2081

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

}

]

}

]

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

2088

2089

(% class="box infomessage" %)

2090

(((

2091

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

2092

)))

2093

2094

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

2095

2096

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

2097

2098

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

2099

2100

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

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

{

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

2105

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

2106

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

2107

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

}

Ответ:

[

{

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

2115

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

2116

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

2117

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

2118

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

2119

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

2120

{

2121

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

2122

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

2123

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

2124

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

2125

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

2126

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

}

]

}

]

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

2134

2135

(% class="box infomessage" %)

2136

(((

2137

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

2138

)))

2139

2140

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

2141

2142

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

2143

2144

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

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

{

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

2151

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

2152

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

2153

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

}

Ответ:

[

{

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

2161

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

2162

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

2163

{

2164

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

2165

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

2166

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

2167

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

2168

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

2169

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

2170

}

2171

],

2172

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

2173

{

2174

"address": "string", ~/~/ Адрес события

2175

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

2176

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

2177

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

2178

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

2179

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

}

]

}

]

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

2187

2188

(% class="box infomessage" %)

2189

(((

2190

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

2191

)))

2192

2193

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

2194

2195

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

2196

2197

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

2198

2199

2200

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

Ответ:

{

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

2205

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

2206

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

2207

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

2208

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

2209

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

2210

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

2211

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

2212

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

2213

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

2214

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

2215

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

{

"id": 0,

"name": "string"

}

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

2223

2224

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

2225

2226

(% class="box infomessage" %)

2227

(((

2228

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

2229

)))

2230

2231

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

2232

2233

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

2234

2235

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

2236

2237

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

2238

2239

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

2240

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

2241

2242

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

2243

{

2244

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

2245

}

2246

2247

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

Ответ:

[

{

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

2253

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

2254

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

2255

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

2256

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

2257

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

2258

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

2259

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

2260

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

2261

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

2262

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

2263

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

}

]

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

2268

2269

(% class="box infomessage" %)

2270

(((

2271

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

2272

)))

2273

2274

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

2275

2276

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

2277

2278

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

2279

2280

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

2281

2282

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

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

{

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

2287

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

2288

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

2289

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

2290

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

2291

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

2292

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

}

Ответ:

[

{

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

2299

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

2300

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

2301

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

2302

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

2303

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

2304

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

}

]

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

2309

2310

(% class="box infomessage" %)

2311

(((

2312

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

2313

)))

2314

2315

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

2316

2317

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

2318

2319

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

2320

2321

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

2322

2323

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

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

{

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

2328

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

2329

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

2330

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

2331

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

2332

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

2333

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

}

Ответ:

[

{

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

2341

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

2342

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

2343

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

2344

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

2345

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

2346

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

}

]

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

2351

2352

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

2353

2354

(% class="box infomessage" %)

2355

(((

2356

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

2357

)))

2358

2359

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

2360

2361

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

2362

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

2363

2364

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

2365

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

2366

2367

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

2368

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

2369

2370

{

2371

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

}

Ответ:

[

{

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

2379

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

2380

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

2381

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

2382

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

2383

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

2384

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

}

]

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

2389

2390

(% class="box infomessage" %)

2391

(((

2392

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

2393

)))

2394

2395

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

2396

2397

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

2398

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

2399

2400

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

2401

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

2402

2403

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

2404

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

2405

2406

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

2407

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

2408

2409

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

2410

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

2411

2412

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

2413

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

2414

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

2415

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

2416

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

2417

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

2418

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

2419

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

2420

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

2421

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

2422

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

2423

],

2424

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

2425

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

2426

],

2427

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

2428

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

2429

],

2430

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

2431

"additionalProp1": "string",

2432

"additionalProp2": "string",

2433

"additionalProp3": "string"

2434

},

2435

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

2436

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

2437

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

2438

],

2439

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

2440

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

2441

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

2442

],

2443

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

2444

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

2445

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

2446

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

2447

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

2448

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

2449

],

2450

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

2451

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

2452

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

2453

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

2454

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

2455

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

2456

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

2457

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

2458

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

2459

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

2460

2461

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

2462

2463

(% class="box warningmessage" %)

2464

(((

2465

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

2466

)))

2467

2468

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

2469

2470

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

2471

2472

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

2473

2474

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

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

{

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

2479

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

2480

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

2481

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

2482

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

2483

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

2484

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

2485

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

2486

0

2487

],

2488

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

2489

0

2490

],

2491

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

2492

0

2493

],

2494

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

2495

"additionalProp1": "string",

2496

"additionalProp2": "string",

2497

"additionalProp3": "string"

2498

},

2499

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

2500

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

2501

""

2502

],

2503

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

2504

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

2505

"string"

2506

],

2507

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

2508

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

2509

{

2510

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

2511

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

2512

}

2513

],

2514

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

2515

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

2516

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

2517

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

2518

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

2519

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

2520

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

2521

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

2522

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

}

Ответ:

Success

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

2531

2532

(% class="box warningmessage" %)

2533

(((

2534

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

2535

)))

2536

2537

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

2538

2539

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

2540

2541

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

2542

2543

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

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

[

0

]

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

2554

2555

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

2556

2557

(% class="box errormessage" %)

2558

(((

2559

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

2560

)))

2561

2562

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

2563

2564

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

2565

2566

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

2567

2568

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

2569

2570

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

Ответ:

Success

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

2578

2579

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

2580

2581

(% class="box infomessage" %)

2582

(((

2583

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

2584

)))

2585

2586

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

Ответ:

[

{

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

2593

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

2594

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

2595

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

2596

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

2597

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

2598

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

2599

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

}

]

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

2604

2605

(% class="box infomessage" %)

2606

(((

2607

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

2608

)))

2609

2610

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

Ответ:

{

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

2616

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

2617

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

2618

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

2619

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

2620

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

2621

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

2622

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

2623

}

2624

2625

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

2626

2627

(% class="box successmessage" %)

2628

(((

2629

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2637

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

2638

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

2639

"exclusive": true,

2640

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

2641

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2650

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

2651

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

2652

"exclusive": true,

2653

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

2654

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

"deleted": true

}

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

2660

2661

(% class="box warningmessage" %)

2662

(((

2663

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2671

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

2672

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

2673

"exclusive": true,

2674

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

2675

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

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2684

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

2685

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

2686

"exclusive": true,

2687

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

2688

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

"deleted": true

}

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

2694

2695

(% class="box errormessage" %)

2696

(((

2697

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

2698

)))

2699

2700

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

Ответ:

Success

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

2708

2709

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

2710

2711

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

2712

2713

(% class="box infomessage" %)

2714

(((

2715

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

)))

Запрос:

{

"Ids": [

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

2723

],

2724

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

2725

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

}

Ответ:

[

{

"VehicleId": 0,

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

2734

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

2735

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

2736

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

2737

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

}

]

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

2743

2744

(% class="box infomessage" %)

2745

(((

2746

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

)))

Запрос:

{

"Ids": [

0

],

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

2756

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

}

Ответ:

[

{

"VehicleId": 0,

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

2765

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

2766

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

2767

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

2768

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

}

]

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

2774

2775

(% class="box successmessage" %)

2776

(((

2777

**POST /api/v3/DriversVehiclesAssignments**

2778

)))

2779

2780

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

Запрос:

[

{

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

2787

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

2788

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

2789

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

2790

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

}

]

Ответ:

[

{

"VehicleId": 0,

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

2800

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

2801

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

2802

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

2803

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

}

]

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

2809

2810

(% class="box warningmessage" %)

2811

(((

2812

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

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

2821

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

2822

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

2823

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

2824

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

}

]

Ответ:

[

{

"VehicleId": 0,

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

2834

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

2835

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

2836

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

2837

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

}

]

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

2843

2844

(% class="box errormessage" %)

2845

(((

2846

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

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

]

Ответ:

Success

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

2861

2862

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

2863

2864

(% class="box infomessage" %)

2865

(((

2866

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

)))

Запрос:

{

"Ids": [

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

2874

],

2875

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

2876

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

}

Ответ:

[

{

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

2884

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

2885

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

2886

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

2887

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

}

]

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

2893

2894

(% class="box infomessage" %)

2895

(((

2896

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

)))

Запрос:

{

"Ids": [

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

2904

],

2905

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

2906

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

}

Ответ:

[

{

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

2914

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

2915

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

2916

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

2917

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

}

]

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

2923

2924

(% class="box successmessage" %)

2925

(((

2926

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

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

2934

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

2935

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

2936

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

}

]

Ответ:

[

{

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

2945

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

2946

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

2947

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

2948

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

}

]

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

2954

2955

(% class="box warningmessage" %)

2956

(((

2957

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

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

2965

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

2966

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

2967

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

2968

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

}

]

Ответ:

[

{

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

2977

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

2978

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

2979

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

2980

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

}

]

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

2986

2987

(% class="box errormessage" %)

2988

(((

2989

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

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

]

Ответ:

Success

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

3004

3005

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

3006

3007

(% class="box infomessage" %)

3008

(((

3009

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

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

3017

],

3018

"BeginTime": "2023-06-30T12:45:10.852Z",

3019

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

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

3027

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

3028

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

3029

"BeginTime": "2023-06-30T11:58:04.695Z",

3030

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

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

3036

3037

(% class="box infomessage" %)

3038

(((

3039

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

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

3047

],

3048

"BeginTime": "2023-06-30T12:45:10.852Z",

3049

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

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

3057

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

3058

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

3059

"BeginTime": "2023-06-30T11:58:04.695Z",

3060

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

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

3066

3067

(% class="box successmessage" %)

3068

(((

3069

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

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

3077

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

3078

"BeginTime": "2023-06-30T12:09:53.175Z",

3079

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

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

3088

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

3089

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

3090

"BeginTime": "2023-06-30T12:09:53.201Z",

3091

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

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

3097

3098

(% class="box warningmessage" %)

3099

(((

3100

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

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

3108

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

3109

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

3110

"BeginTime": "2023-06-30T12:09:53.201Z",

3111

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

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

3120

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

3121

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

3122

"BeginTime": "2023-06-30T12:09:53.201Z",

3123

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

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

3129

3130

(% class="box errormessage" %)

3131

(((

3132

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

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

]

Ответ:

Success

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

3147

3148

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

3149

3150

(% class="box infomessage" %)

3151

(((

3152

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3159

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

3165

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3166

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3167

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3168

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

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

[

{

"SD": "2023-11-14T10:48:03.717Z",

3175

"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",

3185

"name": "string",

3186

"rid": "string",

3187

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

3188

"trailer": {

3189

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3190

"Number": "string",

3191

"Description": "string",

3192

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3193

"ExternalID": "string",

3194

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3195

"CreateTime": "2023-11-14T10:48:03.717Z",

3196

"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);" %)**Описание**

3204

|SD|Дата и время начала события

3205

|ED|Дата и время окончания события

3206

|id|ID объекта

3207

|SLat|Широта начальной координаты

3208

|SLon|Долгота начальной координаты

3209

|ELat|Широта конечной координаты

3210

|ELon|Долгота конечной координаты

3211

|mileage|Пробег

3212

|Duration|Продолжительность

3213

|Address|Адрес начального местоположения

3214

|Address2|Адрес конечного местоположения

3215

|name|Имя радиометки

3216

|rid|Номер радиометки

3217

|rguid|ID радиометки

3218

|trailer|Информация об агрегате

3219

|ModelGuid|ID агрегата

3220

|Number|Название/номер агрегата

3221

|Description|Текст примечания агрегата

3222

3223

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3224

3225

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3226

3227

(% class="box infomessage" %)

3228

(((

3229

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3246

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3251

|parentId|ID клиента

3252

|name|Название карты-метки

3253

|number|Номер

3254

|period|Период запросов в секундах (работает только для агрегатов)

3255

|id|ID карты-метки

3256

3257

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3258

3259

(% class="box infomessage" %)

3260

(((

3261

**GET /api/v3/Rfids/{rfidGuid}**

3262

)))

3263

3264

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3274

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3279

|name|Название карты-метки

3280

|number|Номер

3281

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3286

3287

(% class="box successmessage" %)

3288

(((

3289

**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",

3308

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3309

}

3310

3311

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3312

|name|Название карты-метки

3313

|number|Номер

3314

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3319

3320

(% class="box warningmessage" %)

3321

(((

3322

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3332

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3342

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3343

}

3344

3345

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3346

|name|Название карты-метки

3347

|number|Номер

3348

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3353

3354

(% class="box errormessage" %)

3355

(((

3356

**DELETE /api/v3/Rfids/{rfidGuid}**

3357

)))

3358

3359

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3367

3368

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3369

3370

(% class="box infomessage" %)

3371

(((

3372

**GET /api/v3/Billing/client/balance/{clientId}**

3373

)))

3374

3375

Параметр запроса: **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);" %)**Описание**

3385

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3386

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3387

3388

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3389

3390

(% class="box infomessage" %)

3391

(((

3392

**GET /api/v3/Billing/client/constraint/{clientId}**

3393

)))

3394

3395

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3401

"CalculationType": 0,

3402

"PermissibleBalance": 0,

3403

"DefermentDays": 0,

3404

"SendUiNotifications": true,

3405

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3410

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3411

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3412

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3413

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3414

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3415

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3416

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3417

3418

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3419

3420

(% class="box infomessage" %)

3421

(((

3422

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3428

3429

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3435

"Plan": { **~/~/ Описание тарифного плана**

3436

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3437

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3442

"PermissibleBalance": 0,

3443

"DefermentDays": 0

3444

},

3445

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3457

"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);" %)**Описание**

3473

|ClientId|Идентификатор клиента

3474

|Id|Идентификатор тарифного плана

3475

|OwnerId|Идентификатор клиента-владельца

3476

|Name|Наименование тарифного плана

3477

|IsArchived|Признак, определяющий архивный тарифный план

3478

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3479

|PermissibleBalance|Допустимый баланс

3480

|DefermentDays|Отсрочка, количество дней

3481

|Feature|Код услуги

3482

|IsEnabled|Признак, определяющий активирована ли услуга

3483

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3484

|IsFactual|Признак, определяющий расчёт по факту

3485

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3486

|Price|Цена за единицу.

3487

|DebitDate|Следующий момент времени списания с баланса за услугу.

3488

|PeriodValue|Значение периода.

3489

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3490

3491

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3492

3493

(% class="box infomessage" %)

3494

(((

3495

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3496

)))

3497

3498

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3505

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3510

"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);" %)**Описание**

3527

|ClientId|Идентификатор клиента

3528

|Id|Идентификатор тарифного плана

3529

|OwnerId|Идентификатор клиента-владельца

3530

|Name|Наименование тарифного плана

3531

|IsArchived|Признак, определяющий архивный тарифный план

3532

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3533

|PermissibleBalance|Допустимый баланс

3534

|DefermentDays|Отсрочка, количество дней

3535

|Feature|Код услуги

3536

|IsFactual|Признак, определяющий расчёт по факту

3537

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3538

|Price|Цена за единицу.

3539

|PeriodValue|Значение периода.

3540

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3541

3542

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3543

3544

(% class="box infomessage" %)

3545

(((

3546

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3547

)))

3548

3549

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3556

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3561

"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);" %)**Описание**

3578

|ClientId|Идентификатор клиента

3579

|Id|Идентификатор тарифного плана

3580

|OwnerId|Идентификатор клиента-владельца

3581

|Name|Наименование тарифного плана

3582

|IsArchived|Признак, определяющий архивный тарифный план

3583

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3584

|PermissibleBalance|Допустимый баланс

3585

|DefermentDays|Отсрочка, количество дней

3586

|Feature|Код услуги

3587

|IsFactual|Признак, определяющий расчёт по факту

3588

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3589

|Price|Цена за единицу.

3590

|PeriodValue|Значение периода.

3591

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3592

3593

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3594

3595

(% class="box warningmessage" %)

3596

(((

3597

**PUT /api/v3/Billing/client/balance**

3598

)))

3599

3600

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3612

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3613

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3614

3615

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3616

3617

(% class="box warningmessage" %)

3618

(((

3619

**PUT /api/v3/billing/client/balance/deposit**

3620

)))

3621

3622

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3634

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3635

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3636

3637

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3638

3639

Создает операцию **Списание **с указанной суммой

3640

3641

(% class="box warningmessage" %)

3642

(((

3643

**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);" %)**Описание**

3656

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3657

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3658

3659

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3660

3661

(% class="box warningmessage" %)

3662

(((

3663

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3670

"CalculationType": 0,

3671

"PermissibleBalance": 0,

3672

"DefermentDays": 0,

3673

"SendUiNotifications": true,

3674

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3681

|ClientId|Идентификатор клиента

3682

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3683

|PermissibleBalance|Допустимый баланс

3684

|DefermentDays|(((

3685

Отсрочка, количество дней

3686

)))

3687

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3688

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3689

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3690

3691

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3692

3693

(% class="box warningmessage" %)

3694

(((

3695

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3702

"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);" %)**Описание**

3720

|ClientId|Идентификатор клиента

3721

|PlanId|Идентификатор тарифного плана

3722

|Feature|Код услуги

3723

|IsEnabled|Признак, определяющий активирована ли услуга

3724

|IsFactual|Признак, определяющий расчёт по факту

3725

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3726

|Price|Цена за единицу.

3727

|DebitDate|Следующий момент времени списания с баланса за услугу.

3728

|PeriodValue|Значение периода.

3729

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3730

3731

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3732

3733

(% class="box warningmessage" %)

3734

(((

3735

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3736

)))

3737

3738

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3739

3740

(% class="box infomessage" %)

3741

(((

3742

**POST /api/v3/vehicles/import/{agentId}**

3743

)))

3744

3745

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

3746

3747

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3756

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

3757

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

3758

3759

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3764

|data|В значении передаем файл объекта, формат **xml** или **wlp **

3765

|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);" %)**Описание**

3776

|vehicleId|ID созданного объекта

3777

|name|Имя созданного объекта

3778

|errors|Ошибки и их описание

3779

3780

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

3781

3782

(% class="box infomessage" %)

3783

(((

3784

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

3785

)))

3786

3787

(% class="wikigeneratedid" %)

3788

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

3789

3790

(% class="wikigeneratedid" %)

3791

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

3796

3797

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3802

|**history**|В значении передавать файл с историей

3803

3804

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

3817

"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);" %)**Описание**

3825

|results|Результаты импорта в разрезе ТС

3826

|vehicleGuid|Guid ТС

3827

|vehicleId|ID ТС

3828

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

3829

|firstMessageDate|Дата первого импортированного сообщения (UTC)

3830

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

3831

|producedCount|Кол-во успешно отправленных в шину данных сообщений

3832

|msgCount|Кол-во обработанных сообщений всего

3833

3834

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

3835

3836

(% class="box infomessage" %)

3837

(((

3838

**GET /api/v3/vehicles/import/history/status**

3839

)))

3840

3841

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3852

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

3853

|progress|Guid ТС

3854

3855

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

3856

3857

(% class="box infomessage" %)

3858

(((

3859

**POST /api/v3/vehicles/export**

3860

)))

3861

3862

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

3871

3872

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

3873

3874

(% class="box infomessage" %)

3875

(((

3876

**POST /api/v3/vehicles/export/history**

3877

)))

3878

3879

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

3887

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

3893

3894

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3895

|vehicleId|ID объекта

3896

|asArchive|true - Архивировать файл, False - не архивировать

3897

|from|Дата и время начала запроса

3898

|to|Дата и время окончания запроса

3899

3900

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

3901

3902

(% class="box infomessage" %)

3903

(((

3904

**GET /api/v3/vehicles/export/history/status**

3905

)))

3906

3907

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3918

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

3919

|progress|Прогресс экспорта, от 0 до 100%

3920

|message|Текст описывающий статус

3921

3922

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

3923

3924

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

3925

3926

(% class="box infomessage" %)

3927

(((

3928

**POST /api/v3/EcoDriving/rating**

3929

)))

3930

3931

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

3937

"from": "2023-11-22T09:29:48.051Z",

3938

"to": "2023-11-22T09:29:48.051Z"

3939

}

3940

3941

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3942

|vehicleIds|Массив ID объектов

3943

|from|Дата начала запроса

3944

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

3952

"to": "2023-11-22T09:29:48.052Z",

3953

"vehicleId": 0,

3954

"vehicleName": "string",

3955

"vehicleModel": "string",

3956

"penalty": 0,

3957

"score": 0,

3958

"totalViolations": 0,

3959

"violationsByType": {

3960

"overspeedingViolations": 0,

3961

"accelerationViolations": 0,

3962

"brakingViolations": 0,

3963

"turningViolations": 0,

3964

"dangerousDrivingViolations": 0,

3965

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

3975

"violationsByType": {

3976

"overspeedingViolations": 0,

3977

"accelerationViolations": 0,

3978

"brakingViolations": 0,

3979

"turningViolations": 0,

3980

"dangerousDrivingViolations": 0,

3981

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

3988

"endAddress": "string",

3989

"drivers": [

3990

{

3991

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3992

"driverName": "string",

3993

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4003

|from|Дата начала запроса

4004

|to|Дата окончания

4005

|vehicleId|ID объекта

4006

|vehicleName|Имя объекта

4007

|vehicleModel|Модель объекта

4008

|penalty|Сумма штрафных баллов

4009

|score|Оценка

4010

|totalViolations|Суммарное количество нарушений

4011

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4012

|overspeedingViolations|Превышение скорости

4013

|accelerationViolations|Ускорение

4014

|brakingViolations|Торможение

4015

|turningViolations|Резкий поворот

4016

|dangerousDrivingViolations|Резкое вождение

4017

|sensorViolations|Нарушение по датчику

4018

|moveTime|Время в движении

4019

|mileage|Пробег (км)

4020

|tripsCount|Количество рейсов

4021

|motohours|Моточасы

4022

|maxSpeed|Максимальная скорость

4023

|startAddress|Адрес начала рейса

4024

|endAddress|Адрес окончания рейса

4025

|drivers|Список водителей, которые были на объекте в течениии рейса

4026

|driverGuid|Guid водителя

4027

|driverName|Имя водителя

4028

|driverRfid|Номер Карты-метки

4029

4030

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4031

4032

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4033

4034

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4035

4036

(% class="box infomessage" %)

4037

(((

4038

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4044

\\В заголовках запроса: X-Auth: Токен авторизации

4045

4046

Параметры в теле запроса (JSON):

4047

4048

{

4049

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4050

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4051

"ids": [

4052

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4053

],

4054

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4061

"driver": "string", ~/~/Водители, привязанные к ТК

4062

"object": "string", ~/~/Наименование ТС

4063

"amount": 0, ~/~/Количество топлива

4064

"amountDut": 0, ~/~/Количество по ДУТ

4065

"amountDiff": 0, ~/~/Разница, л

4066

"amountDiffPerc": 0, ~/~/Разница, %

4067

"summa": 0, ~/~/Стоимость, руб

4068

"serviceName": "string", ~/~/Тип топлива

4069

"price": 0, ~/~/Цена за литр, руб

4070

"cardName": "string", ~/~/Наименование ТК

4071

"cardNum": "string", ~/~/Номер ТК

4072

"operator": "string", ~/~/Оператор ТК

4073

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4078

4079

4080

== **Получение полных данных о ретрансляторе** ==

4081

4082

(% class="box infomessage" %)

4083

(((

4084

**GET ** **/api/v3/retranslations/{id}**

4085

)))

4086

4087

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4094

"subscriberId": "", ~/~/ Подписчик

4095

"protocolType": 0, ~/~/ Тип протокола

4096

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4097

"address": "string", ~/~/ Адрес события

4098

"objects": [ ~/~/Объекты для ретрансляции

4099

{

4100

"id": "", ~/~/ Идентификатор объекта ретрансляции

4101

"name": "", ~/~/ Наименование объекта ретрансляции

4102

"imei": "", ~/~/ IMEI объекта

4103

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4104

}

4105

],

4106

"id": "", ~/~/ идентификатор пользователя

4107

"parentId": "", ~/~/Guid родителя

4108

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4113

4114

(% class="box infomessage" %)

4115

(((

4116

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4123

4124

(% class="box infomessage" %)

4125

(((

4126

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4133

"subscriberId": "", ~/~/ Подписчик

4134

"protocolType": 0, ~/~/ Тип протокола

4135

"address": "", ~/~/ Адрес ретрансляции

4136

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4137

"objects": [ ~/~/Объекты для ретрансляции

4138

{

4139

"id": "", ~/~/ идентификатор пользователя

4140

"imei": "", ~/~/IMEI объекта

4141

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4151

"subscriberId": "", ~/~/ идентификатор запроса

4152

"protocolType": 0, ~/~/ Тип протокола

4153

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4154

"address": "", ~/~/ Адрес события

4155

"objects": [ ~/~/Объекты для ретрансляции

4156

{

4157

"id": "", ~/~/ идентификатор пользователя

4158

"name": "string", ~/~/ Название уведомления

4159

"imei": "string", ~/~/IMEI объекта

4160

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4161

}

4162

],

4163

"id": "", ~/~/ идентификатор пользователя

4164

"parentId": "", ~/~/ Guid идентификатор родителя

4165

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4170

4171

(% class="box infomessage" %)

4172

(((

4173

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4180

"description": "string", ~/~/ Определяет описание

4181

"subscriberId": "", ~/~/ идентификатор запроса

4182

"protocolType": 0, ~/~/ Тип протокола

4183

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4184

"address": "string", ~/~/ Адрес события

4185

"objects": ~/~/Объекты для ретрансляции

4186

[

4187

{

4188

"id": "", ~/~/ идентификатор пользователя

4189

"imei": "", ~/~/IMEI объекта

4190

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4200

"subscriberId": "", ~/~/ идентификатор запроса

4201

"protocolType": 0, ~/~/ Тип протокола

4202

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4203

"address": "string", ~/~/ Адрес события

4204

"objects": [ ~/~/Объекты для ретрансляции

4205

{

4206

"id": "", ~/~/ идентификатор пользователя

4207

"name": "string", ~/~/ Название уведомления

4208

"imei": "", ~/~/IMEI объекта

4209

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4210

}

4211

],

4212

"id": "", ~/~/ идентификатор пользователя

4213

"parentId": "", ~/~/ Guid идентификатор родителя

4214

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4219

4220

(% class="box infomessage" %)

4221

(((

4222

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4229

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4230

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4238

"subscriberId": "", ~/~/ идентификатор запроса

4239

"protocolType": 0, ~/~/ Тип протокола

4240

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4241

"address": "string", ~/~/ Адрес события

4242

"id": "", ~/~/ идентификатор пользователя

4243

"parentId": "", ~/~/ Guid идентификатор родителя

4244

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4250

4251

== **API для отчета по выгрузке комбайнов** ==

4252

4253

(% class="box infomessage" %)

4254

(((

4255

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4262

"byDist": 0, ~/~/ Объединение событий по расстоянию

4263

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4264

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4265

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4266

"vehicleIds": [ ~/~/ Список id объектов для анализа

4267

0

4268

],

4269

"from": "", ~/~/ Дата и время начало запроса

4270

"to": "", ~/~/ Дата и время окончания запроса

4271

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4279

"harvesterId": 0, ~/~/Комбайн, id

4280

"harvesterModel": "", ~/~/ Модель комбайна

4281

"hopperCapacity": 0, ~/~/ Объем бункера м3

4282

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4283

"events": [ ~/~/Список событий в разрезе комбайна

4284

{

4285

"driverId": "", ~/~/Идентификатор водителя

4286

"driverName": "", ~/~/Водитель комбайна, ФИО

4287

"RFID": "", ~/~/ идентификатор карты-метки

4288

"rfidName": "", ~/~/Водитель комбайна, имя метки

4289

"vehicleId": 0, ~/~/идентификатор объекта

4290

"vehicleName": "string", ~/~/ Имя объекта

4291

"modelName": "string", ~/~/ Имя модели объекта

4292

"nearestVehicles": [ ~/~/Объекты рядом

4293

{

4294

"vehicleId": 0, ~/~/идентификатор объекта

4295

"vehicleName": "string" ~/~/ Имя объекта

4296

}

4297

],

4298

"fields": [ ~/~/Поля, где происходила выгрузка

4299

{

4300

"id": 0, ~/~/ идентификатор пользователя

4301

"name": "string" ~/~/ имя пользователя

4302

}

4303

],

4304

"event": "string", ~/~/Событие

4305

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4306

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4307

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4308

"cultureName": "string", ~/~/ название культуры

4309

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4310

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4311

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4312

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4313

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4314

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4315

"issued": 0, ~/~/Выдано, бункеров

4316

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4317

"latitude": 0, ~/~/Широта

4318

"longitude": 0, ~/~/ Долгота

4319

"litresAway": 0, ~/~/Отдано, л

4320

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4328

4329

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4330

4331

4332

(% class="box infomessage" %)

4333

(((

4334

GET api/v3/Vehicles/recyclebin/all

4335

)))

4336

4337

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4338

4339

Параметр запроса: {parentId} - идентификатор агента

4340

4341

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4348

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4349

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4350

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4351

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4352

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4353

"details": { ~/~/Список деталей объекта, помещённого в корзину

4354

"items": [ ~/~/

4355

nullable: true ~/~/Детали

4356

{

4357

"name": "string", ~/~/наименование столбца

4358

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4370

4371

(% class="box infomessage" %)

4372

(((

4373

POST/api/v3/Vehicles/recyclebin/erase

4374

)))

4375

4376

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4390

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4391

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4392

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4393

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4394

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4395

"details": { ~/~/Список деталей объекта, помещённого в корзину

4396

"items": [ ~/~/Детали

4397

{

4398

"name": "", ~/~/Имя свойства

4399

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4410

4411

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4412

4413

(% class="box infomessage" %)

4414

(((

4415

POST/api/v3/Vehicles/recyclebin/restore

4416

)))

4417

4418

В заголовках запроса: X-Auth: Токен авторизации

4419

4420

Параметры в теле запроса (JSON):

4421

4422

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4423

4424

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4447

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4448

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4449

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4450

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4451

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4452

"details": { ~/~/Список деталей объекта, помещённого в корзину

4453

"items": [ ~/~/Детали

4454

{

4455

"name": "string", ~/~/Имя свойства

4456

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4469

(((

4470

(% 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]] **

4471

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft