Popular Search netbellnetnetbell-wfmndiscover
View Categories

Accessing with RESTful API and XML (V5)

1 min read

API Endpoint

All API URLs listed in this documentation are relative to http://your_linortek_server/api/ api_command/

RESTful

The Linortek API is a RESTful type API. Known caveats:

  • All API calls should be made with HTTP GET
  • You can consider any non-200 HTTP response code an error

Passing Data

Request data is passed to the API by using the HTTP GET command inclusive of data. Not all commands return data.

Output Formats

Commands that return data use a format of <data_name> data </data_name>. The data name is defined within the RESTful URL description.

RESTful APIs

Fargo/Koda/Ultra 300 – Relay Output

  • To turn a relay on: your_IP_address/api/relay/relay_number/on/
  • To turn a relay off: your_IP_address/api/relay/relay_number/off/
  • To return relay state: your_IP_address/api/relay/relay_number/getstate/

Fargo/Koda – Digital Input

  • To return an input state: your_IP_address/api/digital/input_number/getstate/

Fargo / Koda / Ultra300 Temperature & Humidity (sensor required)

  • To return sensor temperature: your_IP_address/api/sensor/temperature/
  • To return sensor humidity: your_IP_address/api/sensor/humidity/

iTrixx-NHM / Ultra 300 Network Hour Meter

RESTful API commands Network Hour Meter Readings

Note: This API commands are for software: iTrixx-NHM:  Rev. 0.427 and above, iTrixx-Ultra 300: v.0.048 and above

  • Meter 1: your_IP_address/api/hourmeter/1/getcount
  • Meter 2: your_IP_address/api/hourmeter/2/getcount

Netbell, Fargo / Koda (0.448v and above)

  • To change the time zone: your_IP_address/api/timezone/<your time zone>
  • To restart the device: your _IP_address/api/reset/1/

Netbell-Ultra300 – Switch between schedules (different ring times),(v0.071 and above)

  • To receive List of schedules: your IP address/api/bells/schedules/list

Returns: {“schedules”: [ {  “idx”: 0, “name”: “1st schedule”, “desc”: “test description 1”, “active”: true},

 {“idx”: 1, “name”: “2nd sch”, “desc”: “test string 2”, “active”: false}]}

  • To switch between schedules: your IP address/api/bells/schedule/”idx” number/setactive

Returns: {“error”: false,”status”: “success”}

XML payload

Fargo / Koda / Ultra 300

  • To pull data out of the inputs: your_IP_address/p/instat.xml

iTrixx-NHM / Ultra 300 Network Hour Meter

  • To pull hours out:
    • your_IP_address/hours.xml
    • your_IP_address/hourdetail.xml
  • To pull data out of the inputs: your_IP_address/p/instat.xml

iTrixx-WFMN Wireless Hour meter

  • To pull hours with G value (impact) out: your_IP_address/hours.xml

For more information on Linortek product Manual, Video Tutorials for installation and schedule settings are available on our resources page: https://resources.linortek.com/