Методы 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 ~/~/ Макс. значение

}

],

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

1380

1381

1382

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

1383

{

1384

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

(((

(((

{

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

1401

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

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

1415

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

1416

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

1417

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

1418

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

1419

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

1420

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

1421

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

1422

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

1423

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

1424

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

1425

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

1426

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

1427

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

1428

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

1429

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

1430

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

1431

},

1432

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

1433

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

1434

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

1435

"host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.

1436

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

1437

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

1438

},

1439

"inspectionTasks": [ ~/~/ Dto для описания задачи на ТО

1440

{

1441

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

1442

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

1443

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

1444

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

1445

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

1446

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

1447

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

1448

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

1449

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

1450

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

1451

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

1452

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

1453

}

1454

],

1455

"drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.

1456

{

1457

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

1458

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

1459

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

1460

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

1461

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

1462

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

1463

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

1464

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

1465

}

1466

],

1467

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

1468

{

1469

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

1470

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

1471

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

1472

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

1473

}

1474

],

1475

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

1476

{

1477

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

1478

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

1479

"type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed

1480

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

1481

"inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual

1482

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

1483

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

1484

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

1485

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

1486

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

1487

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

1488

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

1489

{

1490

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

1491

{

1492

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

1493

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

1494

}

1495

],

1496

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

1497

}

1498

],

1499

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

1500

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

1501

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

1502

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

1503

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

1504

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

1505

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

"string"

],

"customParams": {

"additionalProp1": "string",

1510

"additionalProp2": "string",

1511

"additionalProp3": "string"

1512

},

1513

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

1514

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

1515

{

1516

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

1517

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

1518

(% style="background-color:inherit; color:inherit; font-family:Menlo,Monaco,Consolas,~"Courier New~",monospace; font-size:inherit; white-space:pre" %)"text": "string"

)))

}

]

}

],

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

1526

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

1527

{

1528

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

1529

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

1530

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

1531

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

1532

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

1533

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

1534

}

1535

],

1536

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

}

)))

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

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

1543

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

1544

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

1545

1546

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

1547

1548

(% class="box infomessage" %)

1549

(((

1550

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

1551

)))

1552

1553

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

1554

1555

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

1556

1557

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

1558

1559

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

1560

1561

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

1562

1563

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

1564

1565

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

1566

1567

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

1568

1569

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

1570

1571

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

1572

1573

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

1574

1575

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

1576

1577

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

1578

1579

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

1580

1581

{

1582

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

1583

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

1584

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

1585

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

1586

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

1587

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

1588

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

1589

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

1590

}

1591

1592

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

1593

1594

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

1595

1596

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

1597

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

1598

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

1599

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

1600

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

1601

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

1602

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

1603

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

1604

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

1605

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

1606

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

1607

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

1608

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

1609

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

1610

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

1611

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

1612

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

1613

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

1614

"customFields": [

1615

{

1616

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

1617

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

1618

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

1619

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

1620

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

1621

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

1622

}(%%)

1623

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

1624

1625

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

1626

1627

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

1628

1629

(% class="box successmessage" %)

1630

(((

1631

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

1632

)))

1633

1634

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

1635

1636

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

1637

1638

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

1639

1640

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

1641

1642

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

1643

1644

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

1645

1646

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

1647

1648

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

1649

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

1650

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

1651

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

1652

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

1653

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

1654

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

1655

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

1656

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

1657

1658

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

1659

1660

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

1661

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

1662

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

1663

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

1664

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

1665

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

1666

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

1667

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

== ==

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

1672

1673

(% class="box warningmessage" %)

1674

(((

1675

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

1676

)))

1677

1678

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

1679

1680

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

1681

1682

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

1683

1684

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

1685

1686

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

1687

1688

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

1689

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

1690

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

1691

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

1692

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

1693

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

1694

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

1695

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

1696

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

1697

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

1698

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

1699

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

1700

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

1701

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

1702

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

1703

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

1704

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

1705

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

1706

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

1707

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

1708

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

1709

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

1710

1711

"mileageCalcMethod": 0,

1712

"mileageCoeff": 0,

1713

"locationByCellId": true,

1714

"dottedLineTrackWhenNoCoords": true,

1715

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

1716

{

1717

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

1718

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

1719

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

1720

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

1721

},

1722

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

1723

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

1724

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

1725

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

1726

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

1727

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

1728

},

1729

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

1730

{

1731

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

1732

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

1733

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

1734

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

1735

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

1736

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

1737

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

1738

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

1739

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

1740

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

1741

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

1742

}

1743

1744

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

1745

{

1746

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

"isDefault": true

}

],

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

1751

{

1752

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

"name": "string",

"command": "string",

"retries": 0

}

],

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

1759

{

1760

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

1761

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

1762

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

1763

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

1764

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

1765

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

1766

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

1767

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

1768

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

1769

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

1770

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

1771

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

1772

{

1773

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

1774

{

1775

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

1776

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

1777

}

1778

],

1779

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

1780

}

1781

],

1782

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

1783

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

1784

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

1785

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

1786

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

1787

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

1788

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

1789

"string"

1790

],

1791

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

1792

"additionalProp1": "string",

1793

"additionalProp2": "string",

1794

"additionalProp3": "string"

1795

},

1796

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

1797

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

1798

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

1799

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

1800

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

1801

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

1802

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

1803

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

1804

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

1805

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

1806

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

1807

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

1808

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

}

],

(((

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

1814

)))

1815

1816

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

1817

{

1818

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

"name": "string",

"value": "string",

"forClient": true,

"forTooltip": true,

"forReport": true

}

]

}

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

(((

{

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

1833

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

1834

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

1835

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

1836

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

1837

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

1838

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

1839

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

1840

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

1841

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

1842

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

1843

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

1844

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

1845

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

1846

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

1847

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

1848

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

1849

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

1850

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

1851

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

1852

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

1853

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

1854

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

1855

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

1856

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

1857

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

1858

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

1859

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

1860

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

1861

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

1862

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

1863

},

1864

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

1865

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

1866

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

1867

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

)))

(((

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

1873

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

1874

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

1875

},

1876

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

1877

{

1878

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

1879

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

1880

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

1881

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

1882

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

1883

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

1884

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

1885

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

1886

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

1887

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

1888

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

1889

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

1890

}

1891

],

1892

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

1893

{

1894

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

1895

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

1896

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

1897

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

1898

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

1899

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

1900

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

1901

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

1902

}

1903

],

1904

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

1905

{

1906

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

1907

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

1908

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

1909

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

1910

}

1911

],

1912

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

1913

{

1914

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

1915

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

1916

"type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,

)))

(((

~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,

)))

(((

~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,

)))

(((

~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,

)))

(((

~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,

)))

(((

~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed

1937

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

1938

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

)))

(((

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

1943

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

1944

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

1945

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

1946

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

1947

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

1948

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

1949

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

1950

{

1951

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

1952

{

1953

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

1954

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

1955

}

1956

],

1957

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

1958

}

1959

],

1960

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

1961

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

1962

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

1963

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

1964

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

1965

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

1966

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

1967

"string"

1968

],

1969

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

1970

"additionalProp1": "string",

1971

"additionalProp2": "string",

1972

"additionalProp3": "string"

1973

},

1974

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

1975

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

1976

{

1977

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

1978

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

1979

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

}

]

}

],

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

1985

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

1986

{

1987

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

1988

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

1989

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

1990

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

1991

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

1992

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

1993

}

1994

],

1995

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

}

)))

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

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

2001

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

2002

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

2003

2004

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

2005

2006

(% class="box errormessage" %)

2007

(((

2008

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

2009

)))

2010

2011

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

2012

2013

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

2014

2015

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

2016

2017

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

2018

2019

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

2020

2021

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

2022

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

2023

2024

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

2025

2026

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

2027

2028

(% class="box infomessage" %)

2029

(((

2030

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

2031

)))

2032

2033

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

2034

2035

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

2036

2037

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

2038

2039

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

2040

2041

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

2042

2043

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

2044

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

2045

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

2046

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

2047

2048

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

2049

2050

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

2051

2052

(% class="box infomessage" %)

2053

(((

2054

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

2055

)))

2056

2057

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

2058

2059

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

2060

2061

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

2062

2063

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

2064

2065

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

2066

2067

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

2068

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

2069

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

2070

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

2071

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

2072

2073

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

2074

2075

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

2076

2077

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

2078

(((

2079

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

2080

)))

2081

2082

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

2083

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

2084

2085

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

2086

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

2087

2088

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

2089

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

2090

2091

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

2092

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

2093

2094

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

2095

{

2096

"vehicleIds": [

2097

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

2098

],

2099

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

2100

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

2101

}

2102

2103

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

2104

Ответ:

2105

2106

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

2107

[

2108

{

2109

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

2110

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

}

]

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

2115

2116

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

2117

(((

2118

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

2119

)))

2120

2121

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

2122

2123

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

2124

2125

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

2133

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

2134

|params|(((

2135

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

)))

Ответ:

{

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

2155

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

2156

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

|inputNumber|(((

Номер входа

)))

(% class="wikigeneratedid" %)

2162

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

2163

2164

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

2165

2166

(% class="box infomessage" %)

2167

(((

2168

**POST /api/v3/terminalMessages**

2169

)))

2170

2171

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

2172

2173

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

2174

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

2175

2176

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

2177

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

2178

2179

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

2180

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

2181

2182

{

2183

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

2184

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

2185

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

2186

}

2187

2188

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

2189

|vehicleId|ID объекта

2190

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

2191

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

Ответ:

[

{

"messages": [

{

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

2200

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

"speed": 0,

"altitude": 0,

"latitude": 0,

"longitude": 0,

"satellites": 0,

"course": 0,

"voltage": 0,

"parameters": {

"additionalProp1": "string",

2210

"additionalProp2": "string",

2211

"additionalProp3": "string"

2212

},

2213

"photoCount": 0,

2214

"lbsCorrectedCoords": true,

"protocolType": 0

}

]

}

]

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

2222

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

2223

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

2224

|speed|Скорость

2225

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

2226

|latitude|Широта

2227

|longitude|Долгота

2228

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

2229

|course|Курс

2230

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

2231

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

2232

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

2233

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

2234

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

2235

2236

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

2237

2238

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

2239

2240

(% class="box infomessage" %)

2241

(((

2242

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

2243

)))

2244

2245

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

2246

2247

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

2248

2249

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

2250

2251

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

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

{

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

2256

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

2257

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

2258

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

2259

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

}

Ответ:

[

{

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

2267

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

2268

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

2269

{

2270

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

2271

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

2272

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

2273

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

2274

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

2275

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

2276

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

2277

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

}

]

}

]

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

2284

2285

(% class="box infomessage" %)

2286

(((

2287

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

2288

)))

2289

2290

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

2291

2292

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

2293

2294

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

2295

2296

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

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

{

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

2301

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

2302

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

2303

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

2304

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

}

Ответ:

[

{

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

2312

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

2313

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

2314

{

2315

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

2316

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

2317

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

2318

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

2319

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

2320

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

}

]

}

]

(% class="box warningmessage" %)

2327

(((

2328

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

2329

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

2330

)))

2331

2332

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

2333

2334

(% class="box infomessage" %)

2335

(((

2336

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

2337

)))

2338

2339

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

2340

2341

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

2342

2343

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

2344

2345

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

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

{

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

2350

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

2351

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

2352

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

}

Ответ:

[

{

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

2360

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

2361

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

2362

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

2363

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

2364

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

2365

{

2366

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

2367

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

2368

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

2369

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

2370

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

2371

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

}

]

}

]

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

2379

2380

(% class="box infomessage" %)

2381

(((

2382

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

2383

)))

2384

2385

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

2386

2387

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

2388

2389

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

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

{

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

2396

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

2397

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

2398

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

}

Ответ:

[

{

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

2406

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

2407

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

2408

{

2409

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

2410

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

2411

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

2412

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

2413

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

2414

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

2415

}

2416

],

2417

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

2418

{

2419

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

2420

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

2421

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

2422

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

2423

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

2424

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

}

]

}

]

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

2432

2433

(% class="box infomessage" %)

2434

(((

2435

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

2436

)))

2437

2438

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

2439

2440

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

2441

2442

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

2443

2444

2445

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

Ответ:

{

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

2450

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

2451

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

2452

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

2453

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

2454

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

2455

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

2456

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

2457

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

2458

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

2459

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

2460

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

{

"id": 0,

"name": "string"

}

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

2468

2469

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

2470

2471

(% class="box infomessage" %)

2472

(((

2473

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

2474

)))

2475

2476

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

2477

2478

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

2479

2480

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

2481

2482

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

2483

2484

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

2485

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

2486

2487

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

2488

{

2489

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

2490

}

2491

2492

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

Ответ:

[

{

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

2498

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

2499

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

2500

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

2501

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

2502

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

2503

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

2504

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

2505

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

2506

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

2507

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

2508

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

}

]

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

2513

2514

(% class="box infomessage" %)

2515

(((

2516

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

2517

)))

2518

2519

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

2520

2521

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

2522

2523

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

2524

2525

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

2526

2527

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

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

{

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

2532

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

2533

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

2534

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

2535

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

2536

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

2537

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

}

Ответ:

[

{

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

2544

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

2545

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

2546

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

2547

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

2548

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

2549

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

}

]

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

2554

2555

(% class="box infomessage" %)

2556

(((

2557

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

2558

)))

2559

2560

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

2561

2562

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

2563

2564

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

2565

2566

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

2567

2568

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

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

{

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

2573

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

2574

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

2575

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

2576

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

2577

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

2578

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

}

Ответ:

[

{

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

2586

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

2587

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

2588

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

2589

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

2590

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

2591

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

}

]

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

2596

2597

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

2598

2599

(% class="box infomessage" %)

2600

(((

2601

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

2602

)))

2603

2604

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

2605

2606

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

2607

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

2608

2609

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

2610

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

2611

2612

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

2613

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

2614

2615

{

2616

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

}

Ответ:

[

{

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

2624

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

2625

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

2626

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

2627

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

2628

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

2629

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

}

]

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

2634

2635

(% class="box infomessage" %)

2636

(((

2637

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

2638

)))

2639

2640

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

2641

2642

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

2643

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

2644

2645

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

2646

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

2647

2648

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

2649

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

2650

2651

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

2652

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

2653

2654

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

2655

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

2656

2657

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

2658

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

2659

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

2660

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

2661

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

2662

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

2663

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

2664

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

2665

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

2666

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

2667

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

2668

],

2669

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

2670

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

2671

],

2672

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

2673

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

2674

],

2675

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

2676

"additionalProp1": "string",

2677

"additionalProp2": "string",

2678

"additionalProp3": "string"

2679

},

2680

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

2681

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

2682

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

2683

],

2684

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

2685

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

2686

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

2687

],

2688

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

2689

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

2690

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

2691

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

2692

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

2693

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

2694

],

2695

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

2696

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

2697

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

2698

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

2699

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

2700

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

2701

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

2702

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

2703

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

2704

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

2705

2706

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

2707

2708

(% class="box warningmessage" %)

2709

(((

2710

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

2711

)))

2712

2713

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

2714

2715

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

2716

2717

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

2718

2719

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

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

{

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

2724

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

2725

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

2726

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

2727

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

2728

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

2729

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

2730

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

2731

0

2732

],

2733

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

2734

0

2735

],

2736

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

2737

0

2738

],

2739

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

2740

"additionalProp1": "string",

2741

"additionalProp2": "string",

2742

"additionalProp3": "string"

2743

},

2744

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

2745

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

2746

""

2747

],

2748

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

2749

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

2750

"string"

2751

],

2752

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

2753

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

2754

{

2755

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

2756

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

2757

}

2758

],

2759

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

2760

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

2761

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

2762

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

2763

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

2764

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

2765

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

2766

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

2767

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

}

Ответ:

Success

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

2776

2777

(% class="box warningmessage" %)

2778

(((

2779

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

2780

)))

2781

2782

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

2783

2784

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

2785

2786

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

2787

2788

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

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

[

0

]

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

2799

2800

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

2801

2802

(% class="box errormessage" %)

2803

(((

2804

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

2805

)))

2806

2807

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

2808

2809

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

2810

2811

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

2812

2813

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

2814

2815

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

Ответ:

Success

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

2823

2824

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

2825

2826

(% class="box infomessage" %)

2827

(((

2828

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

2829

)))

2830

2831

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

Ответ:

[

{

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

2838

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

2839

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

2840

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

2841

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

2842

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

2843

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

2844

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

}

]

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

2849

2850

(% class="box infomessage" %)

2851

(((

2852

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

2853

)))

2854

2855

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

Ответ:

{

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

2861

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

2862

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

2863

"chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения

2864

"exclusive": true, ~/~/ Определяет признак "Исключительный"

2865

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя

2866

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя

2867

"deleted": true ~/~/ Признак удаления

2868

}

2869

2870

== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==

2871

2872

(% class="box successmessage" %)

2873

(((

2874

**POST /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2882

"hiredate": "2023-06-30T12:50:54.020Z",

2883

"chopdate": "2023-06-30T12:50:54.020Z",

2884

"exclusive": true,

2885

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2886

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2895

"hiredate": "2023-06-30T12:50:54.051Z",

2896

"chopdate": "2023-06-30T12:50:54.051Z",

2897

"exclusive": true,

2898

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2899

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==

2905

2906

(% class="box warningmessage" %)

2907

(((

2908

**PUT /api/v3/Drivers**

)))

Запрос:

{

"name": "string",

"description": "string",

2916

"hiredate": "2023-06-30T12:50:27.910Z",

2917

"chopdate": "2023-06-30T12:50:27.910Z",

2918

"exclusive": true,

2919

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2920

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

Ответ:

{

"name": "string",

"description": "string",

2929

"hiredate": "2023-06-30T12:50:27.929Z",

2930

"chopdate": "2023-06-30T12:50:27.929Z",

2931

"exclusive": true,

2932

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2933

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deleted": true

}

== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==

2939

2940

(% class="box errormessage" %)

2941

(((

2942

**DELETE /api/v3/Drivers/{driverGuid}**

2943

)))

2944

2945

Передается параметр: ID водителя

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =

2953

2954

== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==

2955

2956

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===

2957

2958

(% class="box infomessage" %)

2959

(((

2960

**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

2968

],

2969

"BeginTime": "2023-06-30T12:49:04.365Z",

2970

"EndTime": "2023-06-30T12:49:04.365Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:52:31.240Z",

2979

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2980

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

2981

"BeginTime": "2023-06-30T09:52:31.240Z",

2982

"EndTime": "2023-06-30T09:52:31.240Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===

2988

2989

(% class="box infomessage" %)

2990

(((

2991

**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**

)))

Запрос:

{

"Ids": [

0

],

"BeginTime": "2023-06-30T12:48:39.419Z",

3001

"EndTime": "2023-06-30T12:48:39.419Z"

}

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T09:54:01.631Z",

3010

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3011

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3012

"BeginTime": "2023-06-30T09:54:01.631Z",

3013

"EndTime": "2023-06-30T09:54:01.631Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===

3019

3020

(% class="box successmessage" %)

3021

(((

3022

**POST /api/v3/DriversVehiclesAssignments**

3023

)))

3024

3025

Передается массив назначений

Запрос:

[

{

"VehicleId": 0, ~/~/ Идентификатор объекта

3032

"CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения

3033

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3034

"BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения

3035

"EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:04:46.903Z",

3045

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3046

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3047

"BeginTime": "2023-06-30T11:04:46.903Z",

3048

"EndTime": "2023-06-30T11:04:46.903Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===

3054

3055

(% class="box warningmessage" %)

3056

(((

3057

**PUT /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:08.117Z",

3066

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3067

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3068

"BeginTime": "2023-06-30T11:14:08.117Z",

3069

"EndTime": "2023-06-30T11:14:08.117Z"

}

]

Ответ:

[

{

"VehicleId": 0,

"CreateTime": "2023-06-30T11:14:53.349Z",

3079

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3080

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3081

"BeginTime": "2023-06-30T11:14:53.349Z",

3082

"EndTime": "2023-06-30T11:14:53.349Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===

3088

3089

(% class="box errormessage" %)

3090

(((

3091

**DELETE /api/v3/DriversVehiclesAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==

3106

3107

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===

3108

3109

(% class="box infomessage" %)

3110

(((

3111

**POST /api/v3/DriversRfidsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3119

],

3120

"BeginTime": "2023-06-30T12:47:12.162Z",

3121

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3129

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3130

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3131

"BeginTime": "2023-06-30T11:19:40.703Z",

3132

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===

3138

3139

(% class="box infomessage" %)

3140

(((

3141

**POST /api/v3/DriversRfidsAssignments/GetByRfids**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3149

],

3150

"BeginTime": "2023-06-30T12:47:12.162Z",

3151

"EndTime": "2023-06-30T12:47:12.162Z"

}

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки

3159

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения

3160

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя

3161

"BeginTime": "2023-06-30T11:19:40.703Z",

3162

"EndTime": "2023-06-30T11:19:40.703Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===

3168

3169

(% class="box successmessage" %)

3170

(((

3171

**POST /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3179

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3180

"BeginTime": "2023-06-30T11:27:08.635Z",

3181

"EndTime": "2023-06-30T11:27:08.635Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3190

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3191

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3192

"BeginTime": "2023-06-30T11:27:08.677Z",

3193

"EndTime": "2023-06-30T11:27:08.677Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===

3199

3200

(% class="box warningmessage" %)

3201

(((

3202

**PUT /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3210

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3211

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3212

"BeginTime": "2023-06-30T11:28:43.330Z",

3213

"EndTime": "2023-06-30T11:28:43.330Z"

}

]

Ответ:

[

{

"Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3222

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3223

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3224

"BeginTime": "2023-06-30T11:28:43.331Z",

3225

"EndTime": "2023-06-30T11:28:43.331Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===

3231

3232

(% class="box errormessage" %)

3233

(((

3234

**DELETE /api/v3/DriversRfidsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==

3249

3250

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===

3251

3252

(% class="box infomessage" %)

3253

(((

3254

**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3262

],

3263

"BeginTime": "2023-06-30T12:45:10.852Z",

3264

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3272

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3273

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3274

"BeginTime": "2023-06-30T11:58:04.695Z",

3275

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===

3281

3282

(% class="box infomessage" %)

3283

(((

3284

**POST /api/v3/DriversFuelCardsAssignments/GetByCards**

)))

Запрос:

{

"Ids": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

3292

],

3293

"BeginTime": "2023-06-30T12:45:10.852Z",

3294

"EndTime": "2023-06-30T12:45:10.852Z"

}

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3302

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3303

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3304

"BeginTime": "2023-06-30T11:58:04.695Z",

3305

"EndTime": "2023-06-30T11:58:04.695Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===

3311

3312

(% class="box successmessage" %)

3313

(((

3314

**POST /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3322

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3323

"BeginTime": "2023-06-30T12:09:53.175Z",

3324

"EndTime": "2023-06-30T12:09:53.175Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3333

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3334

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3335

"BeginTime": "2023-06-30T12:09:53.201Z",

3336

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===

3342

3343

(% class="box warningmessage" %)

3344

(((

3345

**PUT /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3353

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3354

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3355

"BeginTime": "2023-06-30T12:09:53.201Z",

3356

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

Ответ:

[

{

"CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3365

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3366

"DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3367

"BeginTime": "2023-06-30T12:09:53.201Z",

3368

"EndTime": "2023-06-30T12:09:53.201Z"

}

]

=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===

3374

3375

(% class="box errormessage" %)

3376

(((

3377

**DELETE /api/v3/DriversFuelCardsAssignments**

)))

Запрос:

[

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =

3392

3393

== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==

3394

3395

(% class="box infomessage" %)

3396

(((

3397

**POST /api/v3/Trailers**

)))

Пример запроса:

{

"startDate": "2023-11-14T10:48:03.671Z",

3404

"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);" %)**Описание**

3410

|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса

3411

|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса

3412

|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов

3413

|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.

Пример ответа:

[

{

"SD": "2023-11-14T10:48:03.717Z",

3420

"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",

3430

"name": "string",

3431

"rid": "string",

3432

"rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3433

"trailer": {

3434

"ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3435

"Number": "string",

3436

"Description": "string",

3437

"OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3438

"ExternalID": "string",

3439

"Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3440

"CreateTime": "2023-11-14T10:48:03.717Z",

3441

"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);" %)**Описание**

3449

|SD|Дата и время начала события

3450

|ED|Дата и время окончания события

3451

|id|ID объекта

3452

|SLat|Широта начальной координаты

3453

|SLon|Долгота начальной координаты

3454

|ELat|Широта конечной координаты

3455

|ELon|Долгота конечной координаты

3456

|mileage|Пробег

3457

|Duration|Продолжительность

3458

|Address|Адрес начального местоположения

3459

|Address2|Адрес конечного местоположения

3460

|name|Имя радиометки

3461

|rid|Номер радиометки

3462

|rguid|ID радиометки

3463

|trailer|Информация об агрегате

3464

|ModelGuid|ID агрегата

3465

|Number|Название/номер агрегата

3466

|Description|Текст примечания агрегата

3467

3468

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =

3469

3470

== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==

3471

3472

(% class="box infomessage" %)

3473

(((

3474

**POST /api/v3/Rfids/find**

)))

Запрос:

{

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3491

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3496

|parentId|ID клиента

3497

|name|Название карты-метки

3498

|number|Номер

3499

|period|Период запросов в секундах (работает только для агрегатов)

3500

|id|ID карты-метки

3501

3502

== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==

3503

3504

(% class="box infomessage" %)

3505

(((

3506

**GET /api/v3/Rfids/{rfidGuid}**

3507

)))

3508

3509

Передаем параметр rfidGuid - идентификатор карты-метки

Ответ:

[

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3519

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

]

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3524

|name|Название карты-метки

3525

|number|Номер

3526

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==

3531

3532

(% class="box successmessage" %)

3533

(((

3534

**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",

3553

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3554

}

3555

3556

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3557

|name|Название карты-метки

3558

|number|Номер

3559

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==

3564

3565

(% class="box warningmessage" %)

3566

(((

3567

**PUT /api/v3/Rfids**

)))

Запрос:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3577

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

}

Ответ:

{

"name": "string",

"number": 0,

"period": 0,

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3587

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3588

}

3589

3590

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3591

|name|Название карты-метки

3592

|number|Номер

3593

|period|Период запросов в секундах (работает только для агрегатов)

|id|ID карты-метки

|parentId|ID клиента

== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==

3598

3599

(% class="box errormessage" %)

3600

(((

3601

**DELETE /api/v3/Rfids/{rfidGuid}**

3602

)))

3603

3604

Передаем параметр **rfidGuid** - идентификатор карты-метки

Ответ:

Success

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =

3612

3613

== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==

3614

3615

(% class="box infomessage" %)

3616

(((

3617

**GET /api/v3/Billing/client/balance/{clientId}**

3618

)))

3619

3620

Параметр запроса: **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);" %)**Описание**

3630

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3631

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3632

3633

== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==

3634

3635

(% class="box infomessage" %)

3636

(((

3637

**GET /api/v3/Billing/client/constraint/{clientId}**

3638

)))

3639

3640

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3646

"CalculationType": 0,

3647

"PermissibleBalance": 0,

3648

"DefermentDays": 0,

3649

"SendUiNotifications": true,

3650

"SendEmailNotifications": true,

"IsPrivate": true,

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3655

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3656

|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни

3657

|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс

3658

|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.

3659

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3660

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3661

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3662

3663

== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==

3664

3665

(% class="box infomessage" %)

3666

(((

3667

**GET /api/v3/Billing/client/plan/{clientId}**

)))

Параметры запроса:

**clientId **- идентификатор клиента.

3673

3674

**planId **- идентификатор тарифного плана.

Ответ:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3680

"Plan": { **~/~/ Описание тарифного плана**

3681

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3682

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3687

"PermissibleBalance": 0,

3688

"DefermentDays": 0

3689

},

3690

"Features": [ **~/~/ Описание шаблона услуг тарифного плана**

{

"Feature": "string",

"IsFactual": true,

"Limit": 0,

"Price": 0,

"PeriodValue": 0,

"PeriodType": 0

}

]

},

"DebitDate": "2023-10-18T12:46:24.213Z",

3702

"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);" %)**Описание**

3718

|ClientId|Идентификатор клиента

3719

|Id|Идентификатор тарифного плана

3720

|OwnerId|Идентификатор клиента-владельца

3721

|Name|Наименование тарифного плана

3722

|IsArchived|Признак, определяющий архивный тарифный план

3723

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3724

|PermissibleBalance|Допустимый баланс

3725

|DefermentDays|Отсрочка, количество дней

3726

|Feature|Код услуги

3727

|IsEnabled|Признак, определяющий активирована ли услуга

3728

|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.

3729

|IsFactual|Признак, определяющий расчёт по факту

3730

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3731

|Price|Цена за единицу.

3732

|DebitDate|Следующий момент времени списания с баланса за услугу.

3733

|PeriodValue|Значение периода.

3734

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3735

3736

== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==

3737

3738

(% class="box infomessage" %)

3739

(((

3740

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3741

)))

3742

3743

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3750

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3755

"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);" %)**Описание**

3772

|ClientId|Идентификатор клиента

3773

|Id|Идентификатор тарифного плана

3774

|OwnerId|Идентификатор клиента-владельца

3775

|Name|Наименование тарифного плана

3776

|IsArchived|Признак, определяющий архивный тарифный план

3777

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3778

|PermissibleBalance|Допустимый баланс

3779

|DefermentDays|Отсрочка, количество дней

3780

|Feature|Код услуги

3781

|IsFactual|Признак, определяющий расчёт по факту

3782

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3783

|Price|Цена за единицу.

3784

|PeriodValue|Значение периода.

3785

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3786

3787

== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==

3788

3789

(% class="box infomessage" %)

3790

(((

3791

**GET /api/v3/Billing/client/constraint/getowned/{clientId}**

3792

)))

3793

3794

Параметр запроса: **clientId **- идентификатор клиента.

Ответ:

[

{

"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3801

"OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name": "string",

"IsArchived": true,

"Constraint": {

"CalculationType": 0,

3806

"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);" %)**Описание**

3823

|ClientId|Идентификатор клиента

3824

|Id|Идентификатор тарифного плана

3825

|OwnerId|Идентификатор клиента-владельца

3826

|Name|Наименование тарифного плана

3827

|IsArchived|Признак, определяющий архивный тарифный план

3828

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3829

|PermissibleBalance|Допустимый баланс

3830

|DefermentDays|Отсрочка, количество дней

3831

|Feature|Код услуги

3832

|IsFactual|Признак, определяющий расчёт по факту

3833

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3834

|Price|Цена за единицу.

3835

|PeriodValue|Значение периода.

3836

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3837

3838

== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==

3839

3840

(% class="box warningmessage" %)

3841

(((

3842

**PUT /api/v3/Billing/client/balance**

3843

)))

3844

3845

Устанавливает указанное значение баланса не создавая операции пополнение/снятие.

Тело запроса:

{

"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);" %)**Описание**

3857

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3858

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3859

3860

== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==

3861

3862

(% class="box warningmessage" %)

3863

(((

3864

**PUT /api/v3/billing/client/balance/deposit**

3865

)))

3866

3867

Создает операцию **Пополнение **с указанной суммой

Тело запроса:

{

"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);" %)**Описание**

3879

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3880

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3881

3882

== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==

3883

3884

Создает операцию **Списание **с указанной суммой

3885

3886

(% class="box warningmessage" %)

3887

(((

3888

**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);" %)**Описание**

3901

|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента

3902

|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса

3903

3904

== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==

3905

3906

(% class="box warningmessage" %)

3907

(((

3908

**PUT /api/v3/Billing/client/constraint**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3915

"CalculationType": 0,

3916

"PermissibleBalance": 0,

3917

"DefermentDays": 0,

3918

"SendUiNotifications": true,

3919

"SendEmailNotifications": true,

"IsPrivate": true,

}

Ответ: Success

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

3926

|ClientId|Идентификатор клиента

3927

|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни

3928

|PermissibleBalance|Допустимый баланс

3929

|DefermentDays|(((

3930

Отсрочка, количество дней

3931

)))

3932

|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено

3933

|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено

3934

|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом

3935

3936

== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==

3937

3938

(% class="box warningmessage" %)

3939

(((

3940

**PUT /api/v3/Billing/client/plan**

)))

Тело запроса:

{

"ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

3947

"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);" %)**Описание**

3965

|ClientId|Идентификатор клиента

3966

|PlanId|Идентификатор тарифного плана

3967

|Feature|Код услуги

3968

|IsEnabled|Признак, определяющий активирована ли услуга

3969

|IsFactual|Признак, определяющий расчёт по факту

3970

|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.

3971

|Price|Цена за единицу.

3972

|DebitDate|Следующий момент времени списания с баланса за услугу.

3973

|PeriodValue|Значение периода.

3974

|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы

3975

3976

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =

3977

3978

(% class="box warningmessage" %)

3979

(((

3980

Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.

3981

)))

3982

3983

== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==

3984

3985

(% class="box infomessage" %)

3986

(((

3987

**POST /api/v3/vehicles/import/{agentId}**

3988

)))

3989

3990

Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**

3991

3992

В пути указывается **agentId** - id клиента.

**Заголовок**

**X-Auth: [токен авторизации]**

**Параметры**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4001

|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.

4002

|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление

4003

4004

В теле использовать тип **form-data,** тип значения** file**

**Ключи**

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4009

|data|В значении передаем файл объекта, формат **xml** или **wlp **

4010

|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);" %)**Описание**

4021

|vehicleId|ID созданного объекта

4022

|name|Имя созданного объекта

4023

|errors|Ошибки и их описание

4024

4025

== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==

4026

4027

(% class="box infomessage" %)

4028

(((

4029

**POST** **/api/v3/vehicles/import/history/{vehicleId}**

4030

)))

4031

4032

(% class="wikigeneratedid" %)

4033

Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.

4034

4035

(% class="wikigeneratedid" %)

4036

В пути указывается **vehicleId **- id объекта.

**Заголовок**

**X-Auth: [токен авторизации]**

4041

4042

В теле использовать тип **form-data.**

Ключи:

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4047

|**history**|В значении передавать файл с историей

4048

4049

В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.

Ответ:

{

"results": [

{

"vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"vehicleId": 0,

"errors": [

"string"

],

"firstMessageDate": "2023-11-28T09:27:58.949Z",

4062

"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);" %)**Описание**

4070

|results|Результаты импорта в разрезе ТС

4071

|vehicleGuid|Guid ТС

4072

|vehicleId|ID ТС

4073

|errors|Список ошибок импорта истории (если пустой - нет ошибок)

4074

|firstMessageDate|Дата первого импортированного сообщения (UTC)

4075

|lastMessageDate|Дата последнего импортированного сообщения (UTC)

4076

|producedCount|Кол-во успешно отправленных в шину данных сообщений

4077

|msgCount|Кол-во обработанных сообщений всего

4078

4079

== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==

4080

4081

(% class="box infomessage" %)

4082

(((

4083

**GET /api/v3/vehicles/import/history/status**

4084

)))

4085

4086

Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4097

|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет

4098

|progress|Guid ТС

4099

4100

== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==

4101

4102

(% class="box infomessage" %)

4103

(((

4104

**POST /api/v3/vehicles/export**

4105

)))

4106

4107

Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.

Тело запроса:

[

id

]

Ответ: Success 200, получаете файлы с настройками.

4116

4117

== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==

4118

4119

(% class="box infomessage" %)

4120

(((

4121

**POST /api/v3/vehicles/export/history**

4122

)))

4123

4124

Метод возвращает список сообщений терминала объекта за выбранный период.

Тело запроса:

{

"vehicleId": 0,

"asArchive": true,

"from": "2023-09-27T12:17:45.973Z",

4132

"to": "2023-09-27T12:17:45.973Z"

}

Ответ:

Получаете файл. Сообщение: Code 200/Success

4138

4139

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4140

|vehicleId|ID объекта

4141

|asArchive|true - Архивировать файл, False - не архивировать

4142

|from|Дата и время начала запроса

4143

|to|Дата и время окончания запроса

4144

4145

== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==

4146

4147

(% class="box infomessage" %)

4148

(((

4149

**GET /api/v3/vehicles/export/history/status**

4150

)))

4151

4152

Метод возвращает список сообщений терминала объекта за выбранный период.

Ответ:

{

"activity": true,

"progress": 0,

"message": "string"

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4163

|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.

4164

|progress|Прогресс экспорта, от 0 до 100%

4165

|message|Текст описывающий статус

4166

4167

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =

4168

4169

== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==

4170

4171

(% class="box infomessage" %)

4172

(((

4173

**POST /api/v3/EcoDriving/rating**

4174

)))

4175

4176

Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.

Тело запроса:

{

"vehicleIds": [vehicleId],

4182

"from": "2023-11-22T09:29:48.051Z",

4183

"to": "2023-11-22T09:29:48.051Z"

4184

}

4185

4186

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4187

|vehicleIds|Массив ID объектов

4188

|from|Дата начала запроса

4189

|to|Дата окончания запроса

Ответ:

{

"items": [

{

"from": "2023-11-22T09:29:48.052Z",

4197

"to": "2023-11-22T09:29:48.052Z",

4198

"vehicleId": 0,

4199

"vehicleName": "string",

4200

"vehicleModel": "string",

4201

"penalty": 0,

4202

"score": 0,

4203

"totalViolations": 0,

4204

"violationsByType": {

4205

"overspeedingViolations": 0,

4206

"accelerationViolations": 0,

4207

"brakingViolations": 0,

4208

"turningViolations": 0,

4209

"dangerousDrivingViolations": 0,

4210

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"tripsCount": 0,

"trips": [

{

"penalty": 0,

"score": 0,

"violationsCount": 0,

4220

"violationsByType": {

4221

"overspeedingViolations": 0,

4222

"accelerationViolations": 0,

4223

"brakingViolations": 0,

4224

"turningViolations": 0,

4225

"dangerousDrivingViolations": 0,

4226

"sensorViolations": 0

},

"moveTime": 0,

"mileage": 0,

"motohours": 0,

"maxSpeed": 0,

"startAddress": "string",

4233

"endAddress": "string",

4234

"drivers": [

4235

{

4236

"driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

4237

"driverName": "string",

4238

"driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

}

]

}

]

}

|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**

4248

|from|Дата начала запроса

4249

|to|Дата окончания

4250

|vehicleId|ID объекта

4251

|vehicleName|Имя объекта

4252

|vehicleModel|Модель объекта

4253

|penalty|Сумма штрафных баллов

4254

|score|Оценка

4255

|totalViolations|Суммарное количество нарушений

4256

|violationsByType|Список типов нарушений и количество нарушений для каждого типа

4257

|overspeedingViolations|Превышение скорости

4258

|accelerationViolations|Ускорение

4259

|brakingViolations|Торможение

4260

|turningViolations|Резкий поворот

4261

|dangerousDrivingViolations|Резкое вождение

4262

|sensorViolations|Нарушение по датчику

4263

|moveTime|Время в движении

4264

|mileage|Пробег (км)

4265

|tripsCount|Количество рейсов

4266

|motohours|Моточасы

4267

|maxSpeed|Максимальная скорость

4268

|startAddress|Адрес начала рейса

4269

|endAddress|Адрес окончания рейса

4270

|drivers|Список водителей, которые были на объекте в течениии рейса

4271

|driverGuid|Guid водителя

4272

|driverName|Имя водителя

4273

|driverRfid|Номер Карты-метки

4274

4275

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =

4276

4277

== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

4278

4279

Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.

4280

4281

(% class="box infomessage" %)

4282

(((

4283

POST /api/v3/fuelcards/transactions

)))

Метод запроса: POST

URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions

4289

\\В заголовках запроса: X-Auth: Токен авторизации

4290

4291

Параметры в теле запроса (JSON):

4292

4293

{

4294

"startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода

4295

"endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода

4296

"ids": [

4297

"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт

4298

],

4299

"timezone": 0 ~/~/Таймзона

}

Ответ:

{

"date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции

4306

"driver": "string", ~/~/Водители, привязанные к ТК

4307

"object": "string", ~/~/Наименование ТС

4308

"amount": 0, ~/~/Количество топлива

4309

"amountDut": 0, ~/~/Количество по ДУТ

4310

"amountDiff": 0, ~/~/Разница, л

4311

"amountDiffPerc": 0, ~/~/Разница, %

4312

"summa": 0, ~/~/Стоимость, руб

4313

"serviceName": "string", ~/~/Тип топлива

4314

"price": 0, ~/~/Цена за литр, руб

4315

"cardName": "string", ~/~/Наименование ТК

4316

"cardNum": "string", ~/~/Номер ТК

4317

"operator": "string", ~/~/Оператор ТК

4318

"address": "string" ~/~/Адрес АЗС

}

= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =

4323

4324

4325

== **Получение полных данных о ретрансляторе** ==

4326

4327

(% class="box infomessage" %)

4328

(((

4329

**GET ** **/api/v3/retranslations/{id}**

4330

)))

4331

4332

Идентификатор запроса: ID

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4339

"subscriberId": "", ~/~/ Подписчик

4340

"protocolType": 0, ~/~/ Тип протокола

4341

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4342

"address": "string", ~/~/ Адрес события

4343

"objects": [ ~/~/Объекты для ретрансляции

4344

{

4345

"id": "", ~/~/ Идентификатор объекта ретрансляции

4346

"name": "", ~/~/ Наименование объекта ретрансляции

4347

"imei": "", ~/~/ IMEI объекта

4348

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4349

}

4350

],

4351

"id": "", ~/~/ идентификатор пользователя

4352

"parentId": "", ~/~/Guid родителя

4353

"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен

}

== **Удаление данных ретранслятора** ==

4358

4359

(% class="box infomessage" %)

4360

(((

4361

**DELETE** **/api/v3/retranslations/{id}**

)))

Параметр запроса: ID

== **Создание ретранслятора** ==

4368

4369

(% class="box infomessage" %)

4370

(((

4371

**POST ** **/api/v3/retranslations/{id}**

)))

Запрос:

{

"description": "", ~/~/ Описание

4378

"subscriberId": "", ~/~/ Подписчик

4379

"protocolType": 0, ~/~/ Тип протокола

4380

"address": "", ~/~/ Адрес ретрансляции

4381

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4382

"objects": [ ~/~/Объекты для ретрансляции

4383

{

4384

"id": "", ~/~/ идентификатор пользователя

4385

"imei": "", ~/~/IMEI объекта

4386

"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Ответ:

{

"description": "string", ~/~/ Определяет описание

4396

"subscriberId": "", ~/~/ идентификатор запроса

4397

"protocolType": 0, ~/~/ Тип протокола

4398

"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен

4399

"address": "", ~/~/ Адрес события

4400

"objects": [ ~/~/Объекты для ретрансляции

4401

{

4402

"id": "", ~/~/ идентификатор пользователя

4403

"name": "string", ~/~/ Название уведомления

4404

"imei": "string", ~/~/IMEI объекта

4405

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4406

}

4407

],

4408

"id": "", ~/~/ идентификатор пользователя

4409

"parentId": "", ~/~/ Guid идентификатор родителя

4410

"deleted": true ~/~/ Признак удаления

}

== **Редактирование ретранслятора** ==

4415

4416

(% class="box infomessage" %)

4417

(((

4418

**PUT** **/api/v3/retranslations**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4425

"description": "string", ~/~/ Определяет описание

4426

"subscriberId": "", ~/~/ идентификатор запроса

4427

"protocolType": 0, ~/~/ Тип протокола

4428

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4429

"address": "string", ~/~/ Адрес события

4430

"objects": ~/~/Объекты для ретрансляции

4431

[

4432

{

4433

"id": "", ~/~/ идентификатор пользователя

4434

"imei": "", ~/~/IMEI объекта

4435

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

}

]

}

Пример ответа:

{

"description": "", ~/~/ Определяет описание

4445

"subscriberId": "", ~/~/ идентификатор запроса

4446

"protocolType": 0, ~/~/ Тип протокола

4447

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4448

"address": "string", ~/~/ Адрес события

4449

"objects": [ ~/~/Объекты для ретрансляции

4450

{

4451

"id": "", ~/~/ идентификатор пользователя

4452

"name": "string", ~/~/ Название уведомления

4453

"imei": "", ~/~/IMEI объекта

4454

"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен

4455

}

4456

],

4457

"id": "", ~/~/ идентификатор пользователя

4458

"parentId": "", ~/~/ Guid идентификатор родителя

4459

"deleted": true ~/~/ Признак удаления

}

== **Получение списка ретранслятора клиента** ==

4464

4465

(% class="box infomessage" %)

4466

(((

4467

**POST /api/v3/retranslations/find**

)))

Пример запроса:

{

"id": "", ~/~/ идентификатор пользователя

4474

"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу

4475

"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.

}

Ответ:

[

{

"description": "", ~/~/ Определяет описание

4483

"subscriberId": "", ~/~/ идентификатор запроса

4484

"protocolType": 0, ~/~/ Тип протокола

4485

"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен

4486

"address": "string", ~/~/ Адрес события

4487

"id": "", ~/~/ идентификатор пользователя

4488

"parentId": "", ~/~/ Guid идентификатор родителя

4489

"deleted": true ~/~/ Признак удаления

}

]

= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =

4495

4496

== **API для отчета по выгрузке комбайнов** ==

4497

4498

(% class="box infomessage" %)

4499

(((

4500

POST **/api/v3/Reports/harvesterUnloading**

)))

Пример запроса:

{

"byTime": 0, ~/~/ Объединение событий по времени

4507

"byDist": 0, ~/~/ Объединение событий по расстоянию

4508

"filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения

4509

"filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра

4510

"showNearestObjects": true, ~/~/Показывать объекты рядом?

4511

"vehicleIds": [ ~/~/ Список id объектов для анализа

4512

0

4513

],

4514

"from": "", ~/~/ Дата и время начало запроса

4515

"to": "", ~/~/ Дата и время окончания запроса

4516

"timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3

}

Пример ответа:

[

{

"harvesterName": "", ~/~/Комбайн, номер

4524

"harvesterId": 0, ~/~/Комбайн, id

4525

"harvesterModel": "", ~/~/ Модель комбайна

4526

"hopperCapacity": 0, ~/~/ Объем бункера м3

4527

"hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек

4528

"events": [ ~/~/Список событий в разрезе комбайна

4529

{

4530

"driverId": "", ~/~/Идентификатор водителя

4531

"driverName": "", ~/~/Водитель комбайна, ФИО

4532

"RFID": "", ~/~/ идентификатор карты-метки

4533

"rfidName": "", ~/~/Водитель комбайна, имя метки

4534

"vehicleId": 0, ~/~/идентификатор объекта

4535

"vehicleName": "string", ~/~/ Имя объекта

4536

"modelName": "string", ~/~/ Имя модели объекта

4537

"nearestVehicles": [ ~/~/Объекты рядом

4538

{

4539

"vehicleId": 0, ~/~/идентификатор объекта

4540

"vehicleName": "string" ~/~/ Имя объекта

4541

}

4542

],

4543

"fields": [ ~/~/Поля, где происходила выгрузка

4544

{

4545

"id": 0, ~/~/ идентификатор пользователя

4546

"name": "string" ~/~/ имя пользователя

4547

}

4548

],

4549

"event": "string", ~/~/Событие

4550

"start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода

4551

"end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода

4552

"durationSeconds": 0, ~/~/Продолжительность события, в секундах

4553

"cultureName": "string", ~/~/ название культуры

4554

"bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)

4555

"bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)

4556

"bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)

4557

"bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)

4558

"reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)

4559

"reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)

4560

"issued": 0, ~/~/Выдано, бункеров

4561

"issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)

4562

"latitude": 0, ~/~/Широта

4563

"longitude": 0, ~/~/ Долгота

4564

"litresAway": 0, ~/~/Отдано, л

4565

"m3Away": 0 ~/~/Отдано, м3

}

]

}

]

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =

4573

4574

== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

4575

4576

4577

(% class="box infomessage" %)

4578

(((

4579

GET api/v3/Vehicles/recyclebin/all

4580

)))

4581

4582

Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту

4583

4584

Параметр запроса: {parentId} - идентификатор агента

4585

4586

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

[

{

"recordTime": "", ~/~/Время записи

4593

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4594

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4595

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4596

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4597

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4598

"details": { ~/~/Список деталей объекта, помещённого в корзину

4599

"items": [ ~/~/

4600

nullable: true ~/~/Детали

4601

{

4602

"name": "string", ~/~/наименование столбца

4603

"value": "string" ~/~/содержание столбца

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**

4615

4616

(% class="box infomessage" %)

4617

(((

4618

POST/api/v3/Vehicles/recyclebin/erase

4619

)))

4620

4621

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

[

0

]

Пример ответа:

[

{

"recordTime": "", ~/~/Время записи

4635

"userId": "", ~/~/Guid пользователя, добавившего объект в корзину

4636

"parentId": "", ~/~/Guid агента объекта, помещённого в корзину

4637

"objectId": 0, ~/~/ID объекта, помещённого в корзин

4638

"objectGuid": "", ~/~/Guid объекта, помещённого в корзину

4639

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4640

"details": { ~/~/Список деталей объекта, помещённого в корзину

4641

"items": [ ~/~/Детали

4642

{

4643

"name": "", ~/~/Имя свойства

4644

"value": "" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

""

]

}

]

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».

4655

4656

== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==

4657

4658

(% class="box infomessage" %)

4659

(((

4660

POST/api/v3/Vehicles/recyclebin/restore

4661

)))

4662

4663

В заголовках запроса: X-Auth: Токен авторизации

4664

4665

Параметры в теле запроса (JSON):

4666

4667

Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.

4668

4669

В заголовках запроса: X-Auth: Токен авторизации

Пример запроса:

(((

[

)))

(((

0

)))

(((

]

)))

Пример ответа:

[

{

"recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи

4692

"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину

4693

"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину

4694

"objectId": 0, ~/~/ID объекта, помещённого в корзину

4695

"objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину

4696

"objectType": 1, ~/~/Тип объекта, помещённого в корзину

4697

"details": { ~/~/Список деталей объекта, помещённого в корзину

4698

"items": [ ~/~/Детали

4699

{

4700

"name": "string", ~/~/Имя свойства

4701

"value": "string" ~/~/Значение свойства

}

]

},

"errors": [ ~/~/Список ошибок удаления/восстановления объекта

"string"

]

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

4714

(((

4715

(% 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]] **

4716

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню