ioThinx 4510 Series Appendix
RESTful API Rules
Supported Request Method
Request Description
GET The GET method is used to retrieve information from the given server using a given URI.
Requests using GET should only retrieve data and should have no other effect on the data.
PUT Replaces all the current representations of the target resource with the uploaded content.
OPTIONS Describe the communication options for the target resource.
GET Request Components
Component Content Description
Request Method GET Use GET request to retrieve information
URL http://{IP address}/{RESTful API} Refer to RESTful API List
Headers Accept: vdn.dac.v2
Content-Type: application/json
Headers are mandatory for all RESTful API requests
PUT Request Components
Component Content Description
Request Method PUT Use PUT request to replace current representation
URL http://{IP address}/{RESTful API} Refer to RESTful API List
Headers Accept: vdn.dac.v2
Content-Type: application/json
Headers are mandatory for all RESTful API requests
Body {"value":1} Uploaded content for replacing current
representation
RESTful API List
Here lists the RESTful APIs supported by this device. The {ioName} is composed with three elements,
including Module_Name, @, and I/O_Channel_Name. For example, the {ioName} of the module name
“45MR-1600-0” and the DI channel name “DI-00” is 45MR-1600-0@DI-00.
RESTful API Description Access Format
/api/sysInfo All system information R
/api/sysInfo/device Device name R
Device local date and time R yyyy/mm/dd
hh:mm:ss
Device up time R hh:mm:ss
Firmware version R
Serial number R
System error R
/api/sysInfo/network All network information R
/api/sysInfo/network/LAN All LAN information R
/api/sysInfo/network/LAN/1 MAC address R xx:xx:xx:xx:xx:xx
IP address R xxx.xxx.xxx.xxx
/api/io/ir/{ioName} IR - value R By data type
/api/io/ir/{ioname}/irvalue IR - value RW By data type
/api/io/sp/{ioName}/spStatus SP - system power Status R 0, 1, 2
/api/io/sp/{ioName}/spLowerLimitValue SP - system power lower
limit value
R Float