Table of Contents

API : IPTV : Base Channel : Headend Modules

Introduction

This request will return a list of the modules in the headend that the channel is located on.

Request

URL https://api.telecomx.dk/iptv/basechannel/BASECHANNEL_ID/headendmodules
URL https://api.telecomx.dk/iptv/basechannel/BASECHANNEL_ID/headendmodules/HEADEND_ID
Method GET
Access level ADMIN.
Params BASECHANNEL_ID Number Id of the base channel.
HEADEND_ID Number Id of headend. Needed when base channel has not yet been created.

Query example

https://api.telecomx.dk/iptv/basechannel/7/headendmodules
https://api.telecomx.dk/iptv/basechannel/7/headendmodules/3

Response

Object with an object inside for each of the 6 modules.

JSON for a module object
id Number Index of module 1-6.
unitid String ID of module.
current_ip String IP address currently assigned to the module.
linklocal_ip String Local link IP address.
linklocal_vlanid String Local link VLAN ID.
static_ip String Static IP address assigned to the module.
state Number State of the module.
productcode String Product code / type/model of module.
enabled Number 1 if modules is enabled.
resetting Number 1 if module is currently resetting.
rescue Number 1 if module is currently in rescue mode.
error_link_failed Number 1 if link local has failed.
error_read_status Number 1 if chassic failed to read status from module.
error_write_config Number 1 if chassic failed to write config to module.
error_invalid_ip Number 1 if module has an invalid IP address.
error_module_general Number 1 if module has failed.
error_unable_to_connect Number 1 if chassic is unable to connect to the module.
fw_name String Firmware version on the module.

Example

{
  "1": {
    "id": "1",
    "unitid": "0550113052300002",
    "current_ip": "203.0.113.21",
    "linklocal_ip": "169.254.248.68",
    "linklocal_vlanid": "1",
    "static_ip": "203.0.113.21",
    "state": "7",
    "productcode": "055",
    "enabled": "1",
    "resetting": "0",
    "rescue": "0",
    "error_link_failed": "0",
    "error_read_status": "0",
    "error_write_config": "0",
    "error_invalid_ip": "0",
    "error_module_general": "0",
    "error_unable_to_connect": "0",
    "fw_name": "3.2.2"
  },
  "2": {
    "id": "2",
    "unitid": "0550113061900017",
    "current_ip": "203.0.113.22",
    "linklocal_ip": "169.254.48.74",
    "linklocal_vlanid": "1",
    "static_ip": "203.0.113.22",
    "state": "7",
    "productcode": "055",
    "enabled": "1",
    "resetting": "0",
    "rescue": "0",
    "error_link_failed": "0",
    "error_read_status": "0",
    "error_write_config": "0",
    "error_invalid_ip": "0",
    "error_module_general": "0",
    "error_unable_to_connect": "0",
    "fw_name": "3.2.2"
  },
  "3": {
    "id": "3",
    "unitid": "0550217012000006",
    "current_ip": "203.0.113.23",
    "linklocal_ip": "169.254.204.166",
    "linklocal_vlanid": "1",
    "static_ip": "203.0.113.23",
    "state": "7",
    "productcode": "055",
    "enabled": "1",
    "resetting": "0",
    "rescue": "0",
    "error_link_failed": "0",
    "error_read_status": "0",
    "error_write_config": "0",
    "error_invalid_ip": "0",
    "error_module_general": "0",
    "error_unable_to_connect": "0",
    "fw_name": "3.2.2"
  },
  "4": {
    "id": "4",
    "unitid": "0550113061900018",
    "current_ip": "203.0.113.24",
    "linklocal_ip": "169.254.52.74",
    "linklocal_vlanid": "1",
    "static_ip": "203.0.113.24",
    "state": "7",
    "productcode": "055",
    "enabled": "1",
    "resetting": "0",
    "rescue": "0",
    "error_link_failed": "0",
    "error_read_status": "0",
    "error_write_config": "0",
    "error_invalid_ip": "0",
    "error_module_general": "0",
    "error_unable_to_connect": "0",
    "fw_name": "3.2.2"
  },
  "5": {
    "id": "5",
    "unitid": "0500112120300002",
    "current_ip": "203.0.113.25",
    "linklocal_ip": "169.254.92.43",
    "linklocal_vlanid": "1",
    "static_ip": "203.0.113.25",
    "state": "7",
    "productcode": "050",
    "enabled": "1",
    "resetting": "0",
    "rescue": "0",
    "error_link_failed": "0",
    "error_read_status": "0",
    "error_write_config": "0",
    "error_invalid_ip": "0",
    "error_module_general": "0",
    "error_unable_to_connect": "0",
    "fw_name": "3.1.1"
  },
  "6": {
    "id": "6",
    "unitid": "0500114020700014",
    "current_ip": "203.0.113.26",
    "linklocal_ip": "169.254.227.116",
    "linklocal_vlanid": "1",
    "static_ip": "203.0.113.26",
    "state": "7",
    "productcode": "050",
    "enabled": "1",
    "resetting": "0",
    "rescue": "0",
    "error_link_failed": "0",
    "error_read_status": "0",
    "error_write_config": "0",
    "error_invalid_ip": "0",
    "error_module_general": "0",
    "error_unable_to_connect": "0",
    "fw_name": "3.2"
  }
}

Errors

Error code Message Description
404 id Not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>