http_api |
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
http_api [2025/01/07 16:54] cflintiii [GetNFSMount] |
http_api [2025/01/07 18:17] (current) cflintiii [UpdateTerm] |
||
|---|---|---|---|
| Line 20582: | Line 20582: | ||
| ---- | ---- | ||
| - | |||
| - | ==== UpdateTerm ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Control serial port terminal server for VISCA | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**data**// Parse the JSON formatted data and retrieve the terminal server values. | ||
| - | |||
| - | //**term_mode**// Possible values: client, server | ||
| - | |||
| - | //**term_protocol**// Possible values: clearchannel, telnet | ||
| - | |||
| - | //**term_localport**// Local TCP port (for server mode) | ||
| - | |||
| - | //**term_servaddr**// Remote IP address (for client mode only) | ||
| - | |||
| - | //**term_servport**// Remote TCP port (for client mode only) | ||
| - | |||
| - | //**term_data_bits**// number of data bits. | ||
| - | |||
| - | //**term_parity**// Possible values: None, Odd, Even, Mark, Space | ||
| - | |||
| - | //**term_stop_bits**// Stop bits sent at the end of every character. | ||
| - | |||
| - | //**term_baudrate**// Possible values: 9600, 19200, 38400, 57600, 115200 | ||
| - | |||
| - | //**term_devicefile**// device fine name | ||
| - | |||
| - | //**term_function**// functionality | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== user_add ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Add a new user in the Database. | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**Name**// Get new user name | ||
| - | |||
| - | //**Level**// Get the level of permission for the new user name. Possible value: 0 to 7. | ||
| - | |||
| - | //**Password**// Get the password for the new user name. | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== user_remove ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Remove the user from the database. | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**data **// Parse the JSON formatted data and retrieve the user name. | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== user_update_level ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Update/change the level of permission to the given user name. | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**data **// Parse the JSON formatted data and retrieve the user name and level of the permission. | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== user_update_password ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Update/change the password to the given user name. | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**data **// Parse the JSON formatted data and retrieve the user name and password. | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== download_remove ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | <code html4strict> | ||
| - | http://Encoder_IP/cgi-bin/control.cgi?action=download_remove&data=FILENAME | ||
| - | |||
| - | http://192.168.0.120/cgi-bin/control.cgi?action=download_remove&data=/media/sda/MOV1_000040.mp4 | ||
| - | |||
| - | |||
| - | </code> | ||
| - | |||
| - | remove the downloaded media content from the usb drive or sd card. | ||
| - | |||
| - | == Parameters: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | //**data **// Filename from the downloaded media content to be removed from the removable media device. | ||
| - | == Returns: == | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | **//ret//** Custom return code of the HTTP POST request. 0 on success, 1 on failure. | ||
| - | |||
| - | **//status//** String describing the failure when **ret** is 1. "OK" on success. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | |||
| - | ===== Generic Control (GET) ===== | ||
| - | |||
| - | ==== 8021x ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Get the exthernet 802x information from the Database. | ||
| - | |||
| - | === Parameters: === | ||
| - | |||
| - | ---- | ||
| - | |||
| - | === Returns: === | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. | ||
| - | |||
| - | //**interface**// TEXT, | ||
| - | |||
| - | **//enable//** TEXT. | ||
| - | |||
| - | //**eap**// TEXT. | ||
| - | |||
| - | **//anonymous_identity//** TEXT. | ||
| - | |||
| - | //**identity**// TEXT. | ||
| - | |||
| - | //**password**// TEXT. | ||
| - | |||
| - | //**private_key_password**// TEXT. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | |||
| - | ==== GetCronJobs ==== | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Get the schedule job from the Database. | ||
| - | |||
| - | === Parameters: === | ||
| - | |||
| - | ---- | ||
| - | |||
| - | === Returns: === | ||
| - | |||
| - | ---- | ||
| - | |||
| - | JSON formatted table with values below | ||
| - | |||
| - | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. | ||
| - | |||
| - | **//enable//** INTEGER, | ||
| - | |||
| - | //**cron**// TEXT. | ||
| - | |||
| - | //**func**// TEXT. | ||
| - | |||
| - | **//func_args//** TEXT. | ||
| - | |||
| - | //**type**// TEXT. | ||
| - | |||
| - | //**minutes**// INTEGER. | ||
| - | |||
| - | //**hours**// INTEGER. | ||
| - | |||
| - | //**day**// INTEGER. | ||
| - | |||
| - | //**month**// INTEGER. | ||
| - | |||
| - | //**cron**// TEXT. | ||
| - | |||
| - | ---- | ||
| - | |||
http_api.1736268849.txt.gz ยท Last modified: 2025/01/07 16:54 by cflintiii
Page Tools
