Channel Config

GET channels/config

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of all channels in the system, with its main configuration data. If a stack is defined, the list will include all devices on that stack.

Resource URL

http://{host}/api/2.0/channels/config/.format

Example Request

GET

http://44.235.52.211/api/2.0/channels/config/.json

[
    {
	    
        "ChannelSource": {
            "id": 59,
            "access_type_id": 3,
            "title": "new_GEvPd339fg",
            "uuid": "B3FF2503-9466-4B8C-9A3D-5D7F33F41486",
            "network_id": 1,
            "snooze_on_profile_change": 10,
            "channel_source_pid_behavior_id": 1,
            "monitoring_level": 1,
            "audio_standard_type_id": 1,
            "service_type_id": 1,
            "standard_type_id": 1,
            "is_monitored": 0,
            "device_id": null,
            "is_record_enabled": 0,
            "is_scanned": 0,
            "is_descrambling_enabled": 0,
            "t2mi_plp": -1,
            "encryption_type_id": 0,
            "parent_id": null,
            "note": "",
            "tally_settings": "",
            "modified": "1611142282208",
            "created": "1611142282208",
            "main_url": "234.22.22.22",
            "bandwidth": null,
            "program_id": null,
            "codec": null,
            "audio": null,
            "resolution": null,
            "stream_url": null,
            "is_scrambled": 0,
            "session_ttl": 0,
            "ChannelProfile": [
                {
                    "id": 61,
                    "title": "new_xZsd1gOBpV",
                    "notification_set_id": 4,
                    "event_rule_set_id": 2,
                    "title_color_id": 5,
                    "border_color_id": 4,
                    "is_default": 0,
                    "rst_running_state_id": 0,
                    "is_scanned": 0,
                    "is_scrambled": 0
                }
            ]
        }
    },
    {
        "ChannelSource": {
            "id": 60,
            "access_type_id": 2,
            "title": "test_Channel1",
            "uuid": "E7B4DAB3-7496-460B-9601-316173C7943B",
            "network_id": 1,
            "snooze_on_profile_change": 10,
            "channel_source_pid_behavior_id": 1,
            "monitoring_level": 1,
            "audio_standard_type_id": 1,
            "service_type_id": 1,
            "standard_type_id": 1,
            "is_monitored": 1,
            "device_id": 9011,
            "is_record_enabled": 0,
            "is_scanned": 0,
            "is_descrambling_enabled": 0,
            "t2mi_plp": -1,
            "encryption_type_id": 0,
            "parent_id": null,
            "note": null,
            "tally_settings": null,
            "modified": "1619182767517",
            "created": "1619182700771",
            "ip_address": "224.0.1.1",
            "ssm_ip_address": null,
            "port": 1000,
            "program_number": 200,
            "ts_id": 1,
            "secondary_ip_address": null,
            "secondary_ssm_ip_address": null,
            "secondary_port": null,
            "secondary_network_id": 0,
            "ChannelProfile": []
        }
    }
]

GET channels/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns an extended single channel configuration view, specified by the required {id} parameter.

Resource URL

http://{host}/api/2.0/channels/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired channel.

Example Request

GET

http://44.235.52.211/api/2.0/channels/config/1/.json

{
    "ChannelSource": {
        "id": 60,
        "access_type_id": 2,
        "title": "test_Channel1",
        "uuid": "E7B4DAB3-7496-460B-9601-316173C7943B",
        "network_id": 1,
        "snooze_on_profile_change": 10,
        "channel_source_pid_behavior_id": 1,
        "monitoring_level": 1,
        "audio_standard_type_id": 1,
        "service_type_id": 1,
        "standard_type_id": 1,
        "is_monitored": 1,
        "device_id": 9011,
        "is_record_enabled": 0,
        "is_scanned": 0,
        "is_descrambling_enabled": 0,
        "t2mi_plp": -1,
        "encryption_type_id": 0,
        "encryption_constant_cw": null,
        "parent_id": null,
        "note": null,
        "tally_settings": null,
        "modified": "1619182767517",
        "created": "1619182700771",
        "is_scheduling_enabled": 1,
        "cut_margin": 0,
        "ip_address": "224.0.1.1",
        "ssm_ip_address": null,
        "port": 1000,
        "program_number": 200,
        "ts_id": 1,
        "ts_bitrate": 0,
        "carrier_encoder_manufacturer": "",
        "carrier_encoder_serial_number": "",
        "carrier_identifier": "",
        "carrier_telephone_number": "",
        "carrier_longitude": "",
        "carrier_latitude": "",
        "carrier_user_information": "",
        "atsc_vct_type_id": 0,
        "atsc_service_type": null,
        "atsc_source_id": null,
        "atsc_major_channel_number": null,
        "atsc_minor_channel_number": null,
        "sdt_name": null,
        "sdt_provider": null,
        "secondary_ip_address": null,
        "secondary_ssm_ip_address": null,
        "secondary_port": null,
        "secondary_network_id": 0,
        "channel_source_rtp_mode_id": 1,
        "ChannelProfile": [
            {
                "id": 62,
                "title": "Default",
                "notification_set_id": 1,
                "event_rule_set_id": 1,
                "is_default": 1,
                "is_scanned": 0,
                "title_color_id": 0,
                "border_color_id": 0,
                "pixelate_level": 0,
                "service_bitrate_min": 0,
                "service_bitrate_max": 0,
                "rst_running_state_id": 0,
                "is_scrambled": 0,
                "ProfileEvent": [],
                "ProfilePid": []
            }
        ]
    }
}

POST channels/config

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Add a new channel, configured according to the attached data request.

Resource URL

http://{host}/api/2.0/channels/config/.format

Example Request

POST

http://192.168.0.203/api/2.0/channels/config/.json

{
    "ChannelSource": {
        "id": 60,
        "access_type_id": 2,
        "title": "test_Channel_POST",
        "network_id": 1,
        "snooze_on_profile_change": 10,
        "channel_source_pid_behavior_id": 1,
        "monitoring_level": 1,
        "audio_standard_type_id": 1,
        "service_type_id": 1,
        "standard_type_id": 1,
        "is_monitored": 1,
        "device_id": 9011,
        "is_record_enabled": 0,
        "is_scanned": 0,
        "is_descrambling_enabled": 0,
        "t2mi_plp": -1,
        "encryption_type_id": 0,
        "encryption_constant_cw": null,
        "parent_id": null,
        "note": null,
        "tally_settings": null,
        "modified": "1619182767517",
        "created": "1619182700771",
        "is_scheduling_enabled": 1,
        "cut_margin": 0,
        "ip_address": "224.0.1.1",
        "ssm_ip_address": null,
        "port": 1000,
        "program_number": 200,
        "ts_id": 1,
        "ts_bitrate": 0,
        "carrier_encoder_manufacturer": "",
        "carrier_encoder_serial_number": "",
        "carrier_identifier": "",
        "carrier_telephone_number": "",
        "carrier_longitude": "",
        "carrier_latitude": "",
        "carrier_user_information": "",
        "atsc_vct_type_id": 0,
        "atsc_service_type": null,
        "atsc_source_id": null,
        "atsc_major_channel_number": null,
        "atsc_minor_channel_number": null,
        "sdt_name": null,
        "sdt_provider": null,
        "secondary_ip_address": null,
        "secondary_ssm_ip_address": null,
        "secondary_port": null,
        "secondary_network_id": 0,
        "channel_source_rtp_mode_id": 1,
        "ChannelProfile": [
            {
                "id": 62,
                "title": "Default",
                "notification_set_id": 1,
                "event_rule_set_id": 1,
                "is_default": 1,
                "is_scanned": 0,
                "title_color_id": 0,
                "border_color_id": 0,
                "pixelate_level": 0,
                "service_bitrate_min": 0,
                "service_bitrate_max": 0,
                "rst_running_state_id": 0,
                "is_scrambled": 0,
                "ProfileEvent": [],
                "ProfilePid": []
            }
        ]
    }
}

POST channels/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Copies a channel configuration to a new channel.

Resource URL

http://{host}/api/2.0/channels/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the channel to be copied.

Example Request

POST

http://44.235.52.211/api/2.0/channels/config/60/.json

PUT channels/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Edit a channel configuration.

Resource URL

http://{host}/api/2.0/channels/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The Id of the channel to be edited.

Example Request

PUT

http://44.235.52.211/api/2.0/channels/config/61/.json

DELETE channels/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Delete a specific channel.

Resource URL

http://{host}/api/2.0/channels/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the channel to be deleted.

Example Request

DELETE

http://44.235.52.211/api/2.0/channels/config/61/.json

Multi DELETE channels/config/.format?remove[]={id}&remove[]{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Delete a multiple channel.

Resource URL

http://{host}/api/2.0/channels/config/.format?remove[]={id}&remove[]{id}

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the channel to be deleted.

Example Request

DELETE

http://192.168.10.132/api/2.0/channels/config/.json?remove[]=2&remove[]3

GET channels/config/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns all meta data used by channel configuration.

Resource URL

http://{host}/api/2.0/channels/config/meta/.format

Example Request

GET

http://44.235.52.211/api/2.0/channels/config/meta/.json