# IEI iSDV API
> Created By Nayana
> Database: iei-isdv-db
> API Port: 1212
### isdv-device
#### Get List of Devices
**Note :** *Collect device info and setting details from BlueRiver API *
```
Url: http://127.0.0.1:1212/isdv/isdv-device/getDeviceList
Method: Get
Body: None
```
### setting-management
#### Audio setting
##### Add Audio
```
Url: http://127.0.0.1:1212/isdv/setting-management/group/addGroup
Method: Post
Body: {
"deviceId": "",
settingName: "",
"version": "V1.0.1",
"transmitterMode": "Multichannel HDMI Audio",
"receiverMode": "HDMI Multichannel and analog audio"
}
```
##### Get List of Audio
```
Url: https://127.0.0.1:1212/isdv/setting-management/audio
Method: Get
Body: None
```
@@@@@@@@@@@@@@@@
#### Config setting
##### Add Config
```
Url: https://127.0.0.1:1212/isdv/setting-management/config/addConfig
Method: Post
Body: {
"deviceId": "",
"settingName": "",
"version": "",
"operationId": "",
"serialNo": "",
"data":{
}
}
```
##### Get List of Config
```
Url: http://127.0.0.1:1212/isdv/setting-management/config
Method: Get
Body: None
```
@@@@@@@@@@@@@@@@
#### Firmware setting
##### Add Firmware
```
Url: http://127.0.0.1:1212/isdv/setting-management/firmware/addFirmware
Method: Post
Body: {
"deviceId": "",
"settingName": "",
"version": "V1.0.1",
"currentVersion": "version_1",
"selectedVersion": "version_2",
"filePath": "D://isdv//firmware//firmwareUpdate.txt"
}
```
##### Get List of Firmware
```
Url: http://127.0.0.1:1212/isdv/setting-management/firmware
Method: Get
Body: None
```
@@@@@@@@@@@@@@@@
#### Group setting
##### Add Group
```
Url: http://127.0.0.1:1212/isdv/setting-management/group/addGroup
Method: Post
Body: {
"groupName": ""
}
```
##### Get List of Group
```
Url: http://127.0.0.1:1212/isdv/setting-management/group
Method: Get
Body: None
```
##### Get Group info by group ID
```
Url: http://127.0.0.1:1212/isdv/setting-management/group/{groupId}
Method: Get
Body: None
```
##### Update Group name
```
Url: http://127.0.0.1:1212/isdv/setting-management/group/updateGroup
Method: Post
Body: {
"groupName": "Updated name",
"groupId" : ""
}
```
@@@@@@@@@@@@@@@@
#### Hardware setting
##### Add Hardware
```
Url: https://127.0.0.1:1212/isdv/setting-management/hardware/addHardware
Method: Post
Body: {
"deviceId": "",
"settingName": "",
"version": "V1.0.1",
"deviceMode": ['transmitter'/'receiver'/'transceiver'],
"deviceCliam": true/false
}
```
##### Get List of Hardware
```
Url: http://127.0.0.1:1212/isdv/setting-management/hardware
Method: Get
Body: None
```
@@@@@@@@@@@@@@@@
#### Network setting
##### Add Network
```
Url: https://127.0.0.1:1212/isdv/setting-management/network/addNetwork
Method: Post
Body: {
"deviceId": "",
"settingName": "",
"version": "",
"startIp" : "",
endIp: "",
gateway: "",
subnet: "",
allocateIp: true/false
port1G: true/false
}
```
##### Get List of Network
```
Url: http://127.0.0.1:1212/isdv/setting-management/network
Method: Get
Body: None
```
@@@@@@@@@@@@@@@@
#### RS232 setting
##### Add RS232
```
Url: http://127.0.0.1:1212/isdv/setting-management/rs232/addRs232
Method: Post
Body: {
"deviceId" : "D1001",
"settingName" : "Setting_A",
"version": "V1.0.0",
"port": 1,
"baud": [110, 300, 600, 1200, 2400, 4800, 9600, 14400, 38400, 57600, 115200],
"databit": [5, 6, 7, 8],
"stopbit": ['none', 'odd', 'even', 'mask', 'space'],
"parity": [1, 1.5, 2],
```
##### Get List of RS232
```
Url: http://127.0.0.1:1212/isdv/setting-management/rs232
Method: Get
Body: None
```
@@@@@@@@@@@@@@@@
#### USB setting
##### Add USB
```
Url: https://127.0.0.1:1212/isdv/setting-management/usb/addUsb
Method: Post
Body: {
"deviceId" : "D1001",
"settingName" : "Setting_A",
"version": "V1.0.1",
"usbRole": ['DISABLED', 'LOCAL', 'REMOTE']
}
```
##### Get List of USB
```
Url: http://127.0.0.1:1212/isdv/setting-management/usb
Method: Get
Body: None
```
---
### device-management
#### Get List of Devices
```
Url: http://127.0.0.1:1212/isdv/device-management/device
Method: Get
Body: None
```
#### Add device info
**Note:** *Need to define device Info structure*
```
Url: http://127.0.0.1:1212/isdv/device-management/device/addDevice
Method: Post
Body: {
"deviceId" : "",
"ip" : "",
"mask" : "",
"port1G" : false/false,
"claim": "true/false",
"firmwareVersion" : ""
}
```
---
### log-management
#### Get All logs
```
Url: http://localhost:1212/isdv/log-management/log
Method: Get
Body: None
Response: {
status: "success/failure",
data: [{}],
error: ""
}
```
#### Add Logs
```
Url: http://127.0.0.1:1212/isdv/log-management/log/addLog
Method: Post
Body: {
"messageType": "info/warning/error",
"description": "Login Error"
}
```
---
### user-management
#### Generate Salt Value
```
Url: http://127.0.0.1:1212/isdv/user-management/auth
Method: Post
Body: None
```
#### Create User
```
Url: http://127.0.0.1:1212/isdv/user-management/user
Method: Post
Body: {
"firstName": "Admin user",
"lastName": "Iei",
"userName": "IEI_amin",
"password": "nanananaannanananannanannannana",
"email": "admin@ieiworld.com",
"phone": "+886934205119",
"role": "admin",
"description": "IEI Admin user",
"saltValue": "9QIQjQ9hFT9EZc3mAgIIdw=="
}
```
#### Get All Users
```
Url: http://127.0.0.1:1212/isdv/user-management/user
Method: GET
Body: None
```
#### Generate User by name
```
Url: http://127.0.0.1:1212/isdv/user-management/user/{user_name}
sample url: http://127.0.0.1:1212/isdv/user-management/user/IEI_amin
Method: Post
Body: None
```
#### Login User
```
Url: http://127.0.0.1:1212/isdv/user-management/user/userLogin
Method: Post
Body: {
"userName" : ""
, "password": ""
}
```
#### Delete User
```
Url: http://127.0.0.1:1212/isdv/user-management/user/{User_Name}
Method: Delete
Body: None
```
#### Update User Info
```
Url: http://127.0.0.1:1212/isdv/user-management/auth
Method: Put
Body: {
"firstName" : "",
"lastName" : "",
"userName" : "User_Name",
"password" : "",
"email" : "",
"phone" : "",
"saltValue" : "",
"role" : "",
"locked" : true/false
}
```
#### Login History
```
Url: http://127.0.0.1:1212/isdv/user-management/login/history
Method: GET
Body: None
```
Google Drive
Gist
Clipboard
Sign in with Wallet
