API 4.1

Version 6.0.4 onwards, MCM9000 supports API 4.1.

API 4.1 is a replica of API 4.0 that allows,

  • Capitalization of UUID. For example, uuid : A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9

  • Allows single quotes. For example, don't care and dont care will be considered same.

Version 6.0.5 onwards MCM9000 supports, JXS TR-07 and TR-08 code type on API 4.1.

 

GET receivers

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/.json

[ { "Receiver": { "receiver_uuid": "007FA955-7AEB-41EE-AFE9-424B6BD5574D", "receiver_label": "6945_1-2318", "channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9", "channel_label": "6945_1", "enabled": true, "sdp_file": null, "stream_type": "MPEG-TS/Video", "program_number": 6945, "network": [ { "multicast_ip": "238.20.20.20", "interface_ip": "192.168.10.132", "source_ip": "0.0.0.0", "multicast_port": 2000 }, { "multicast_ip": "0.0.0.0", "interface_ip": null, "source_ip": "0.0.0.0", "multicast_port": 0 } ] } }, { "Receiver": { "receiver_uuid": "1225DEC3-0B91-4B9F-A42C-047CD48C7A7A", "receiver_label": "mdash_1-7001", "channel_uuid": "89E451E5-42D7-4978-9514-C5A562ACB6E3", "channel_label": "mdash_1", "enabled": true, "sdp_file": null, "stream_type": "MPEG-DASH/Video", "url": "https://tv2-play-ew-live-aws-arn-dash.secure.footprint.net/__cl/cg:live/__c/tv2_fyn/__op/nd/__f/dash.mpd", "index": "video_1_720p5400", "attributes": { "bandwidth": 5400000, "codecs": "avc1.640020", "audio": null, "resolution": "1280x720" }, "network": [ { "interface_ip": "192.168.10.132" } ] } }, { "Receiver": { "receiver_uuid": "A9ED621C-B9D2-4627-B29E-6B59D8E8F09C", "receiver_label": "News-HD-501", "channel_uuid": "39CC542B-A530-4237-8627-832AD883E391", "channel_label": "News-HD", "enabled": true, "sdp_file": null, "stream_type": "MPEG-TS/Video", "program_number": 5, "network": [ { "multicast_ip": "239.10.10.20", "interface_ip": "192.168.10.132", "source_ip": "0.0.0.0", "multicast_port": 2000 }, { "multicast_ip": "225.0.1.1", "interface_ip": null, "source_ip": "0.0.0.0", "multicast_port": 2000 } ] } }, { "Receiver": { "receiver_uuid": "BD4AF8BE-0669-4D0A-A59B-D9363BDDFD4F", "receiver_label": "kan_3-7001", "channel_uuid": "A9501290-24B6-471B-A593-7FC52732A859", "channel_label": "kan_3", "enabled": true, "sdp_file": null, "stream_type": "HLS/Video", "url": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/master.m3u8", "variant_url": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/source1_350/chunklist.m3u8", "attributes": { "bandwidth": 600000, "codecs": "avc1.77.21,mp4a.40.2", "audio": null, "resolution": "426x240" }, "network": [ { "interface_ip": "192.168.10.132" } ] } }, { "Receiver": { "receiver_uuid": "C89EAC11-8CA3-4C27-BD17-DBF225595CA8", "receiver_label": "BBC 1 CI-2315", "channel_uuid": "4AD1E355-1895-444C-A1DA-DA808D406853", "channel_label": "BBC 1 CI", "enabled": true, "sdp_file": null, "stream_type": "MPEG-TS/Video", "program_number": 6904, "network": [ { "multicast_ip": "239.10.10.20", "interface_ip": "192.168.10.132", "source_ip": "0.0.0.0", "multicast_port": 2000 }, { "multicast_ip": "225.0.1.1", "interface_ip": null, "source_ip": "0.0.0.0", "multicast_port": 2000 } ] } } ]

 


  

GET receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired receiver.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/007FA955-7AEB-41EE-AFE9-424B6BD5574D/.json

{ "Receiver": { "receiver_uuid": "007FA955-7AEB-41EE-AFE9-424B6BD5574D", "receiver_label": "6945_1-2318", "channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9", "channel_label": "6945_1", "enabled": true, "sdp_file": null, "stream_type": "MPEG-TS/Video", "program_number": 6945, "network": [ { "multicast_ip": "238.20.20.20", "interface_ip": "192.168.10.132", "source_ip": "0.0.0.0", "multicast_port": 2000 }, { "multicast_ip": "0.0.0.0", "interface_ip": null, "source_ip": "0.0.0.0", "multicast_port": 0 } ] } }

 


 

PUT receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the receivers.

Resource URL

http://{host}/api/4.1/receivers/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired receiver to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/receivers/A9ED621C-B9D2-4627-B29E-6B59D8E8F09C/.json

{ "Receiver": { "receiver_label": "News-HD-501", "channel_label": "News-HD", "enabled": true, "sdp_file": null, "stream_type": "MPEG-TS/Video", "program_number": 5, "network": [ { "multicast_ip": "239.10.10.21", "interface_ip": "192.168.10.132", "source_ip": "0.0.0.0", "multicast_port": 1000 }, { "multicast_ip": "225.0.1.1", "interface_ip": null, "source_ip": "0.0.0.0", "multicast_port": 2000 } ] } }

 


 

GET senders

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of senders configuration data.

Resource URL

http://{host}/api/4.1/senders/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/senders/.json

 


   

GET senders/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific senders configuration data.

Resource URL

http://{host}/api/4.1/senders/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired senders.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

 


 

PUT senders/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the senders.

Resource URL

http://{host}/api/4.1/senders/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired sender to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

 


 

GET Layouts

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of layouts configuration data.

Resource URL

http://{host}/api/4.1/layouts/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layouts/.json

 


   

GET layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific layouts configuration data.

Resource URL

http://{host}/api/4.1/layouts/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired layouts.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layouts/F45D9708-B192-4A30-964A-38113ED9B633/.json

 


 

PUT layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the layouts.

Resource URL

http://{host}/api/4.1/layouts/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired layouts to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

 


  

GET layout_types

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific layout_types configuration data.

Resource URL

http://{host}/api/4.1/layout_types/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layout_types/.json

 


 

GET channels/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of channels configuration data.

Resource URL

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

Example Request

GET 

  1. http://192.168.10.132/api/4.1/channels/config/.json

 


   

GET channels/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific channels configuration data.

Resource URL

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

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired channel configuration.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/channels/config/F45D9708-B192-4A30-964A-38113ED9B633/.json

 


 

GET outputs/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of outputs configuration data.

Resource URL

http://{host}/api/4.1/outputs/config/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/outputs/config/.json

 


   

GET outputs/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific outputs configuration data.

Resource URL

http://{host}/api/4.1/outputs/config/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired output configuration.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/outputs/config/880D1D99-0066-422E-BA42-2541E515D662/.json