Channels API (ENG)

INTRODUCTION

Channels API is used to get Linear Channels related metadata from Icareus Suite.

API PATH

/api/channels/

All API calls are done as GET calls

API METHODS

GET CHANNELS

Name	Requirement	Description	Values
action	Mandatory	Action call to make	getChannels
version	Mandatory	Version to use	04
organizationId	Mandatory	The ID of the account/organization	Number
pfEvents	Optional	Whether to return present and next events along with channel	0 or 1
limit	Optional	Limit the results	Number
orderBy	Optional	Order the results with a parameter	logicalChannelNumber (only one supported for now)
order	Optional	Type of ordering	asc or desc
userId	Optional	User ID of the user to check access	Number

RESPONSE

{
  "status": "ok",
  "channels": [
    {
      "logicalChannel": 9,
      "imageLarge": "http://127.0.0.1/image/image_gallery?img_id=69093",
      "imageMedium": "http://127.0.0.1/image/image_gallery?img_id=69094",
      "expirationDate": 1496134681949,
      "packages": [
        {
          "name": "Package 1"
        },
        {
          "name": "Package 2"
        }

       ],
      "urls": [
        {
          "id": 517762,
          "name": "Desktop - Windows",
          "url": "http://192.168.1.1:1935/testplaylistlive/file/playlist.m3u8"
        }
      ],
      "networkId": 0,
      "aspectRatio": "",
      "onId": 0,
      "imageSmall": "http://127.0.0.1/image/image_gallery?img_id=69095",
      "primaryLanguage": "en_US",
      "title": "Playlist channel",
      "serviceId": 517760,
      "tsId": 0,
      "description": "Playlist channel",
      "quality": 0,
      "bsId": 0,
      "timeshift": false,
      "categories": [ ],
      "startOver": 0,
      "audioOnly": 0
    }
  ]
}

GET EVENTS

Name	Requirement	Description	Values
action	Mandatory	Action call to make	getEvents
version	Mandatory	Version to use	04
organizationId	Mandatory	The ID of the account/organization	Number
lcId	Mandatory	The ID of the channel (returned in getChannels as serviceId)	Number
from	Optional	Timestamp (ms) from which to return events	Timestamp (ms)
to	Optional	Timestamp (ms) till which to return events	Timestamp (ms)

RESPONSE

{
"status": "ok",
"events": [
    {
      "productionCountries": "",
      "genres": "558644",
      "assetId": 0,
      "serviceId": 150749,
      "eventId": 2441018,
      "description": {
        "en_US": {
          "category": "",
          "episodeSeries": "",
          "episodeSeason": "",
          "episodeTitle": "",
          "shortDescription": "",
          "name": "Z widokiem na Wawel",
          "longDescription": "",
          "episodeNumber": "56",
          "episodeDescription": ""
        }
      },
      "persons": {},
      "ratings": [
        {
          "rating": 0,
          "country": 902
        }
      ],
      "avMood": "",
      "info": {
        "startTime": "2021-01-28T10:55:00Z",
        "imageLarge": "https://suiterc.icareus.com/image/image_gallery?img_id=/image/image_gallery?img_id=2441017%22,
        "duration": 1800,
        "imageMedium": "https://suiterc.icareus.com/image/image_gallery?img_id=/image/image_gallery?img_id=2441017%22,
        "freeCaMode": 0,
        "contentType": 600,
        "imageSmall": "https://suiterc.icareus.com/image/image_gallery?img_id=/image/image_gallery?img_id=2441017%22
      }
    }
],
"serverTime": 1611828319870,
"totalEvents": 1,
"eventsLanguage": "en_US"
}

GET CHANNEL

Name	Requirement	Description	Values
action	Mandatory	Action call to make	getChannel
version	Mandatory	Version to use	04
organizationId	Mandatory	The ID of the account/organization	Number
lcId	Mandatory	The ID of the channel (returned in getChannels as serviceId)	Number
pfEvents	Optional	Whether to return present and next events along with channel	0 or 1
userId	Optional	User ID of the user to check access	Number

RESPONSE

{
  "status": "ok",
  "access": 1,
  "channel": {
    "logicalChannel": 0,
    "imageLarge": "",
    "imageMedium": "https://suiterc.icareus.com/image/image_gallery?img_id=660619%22,
    "urls": [
      {
        "id": 2101007,
        "name": "Desktop - OS X",
        "url": "https://suiterc2.icareus.com/suitelive/163139/playlist.m3u8?organizationId=13509&suiteItemId=163139&DVR&wowzadvrplayliststart=20201111115500%22
      }
    ],
    "networkId": 1,
    "aspectRatio": "",
    "onId": 1,
    "timeshift": false,
    "imageSmall": "https://suiterc.icareus.com/image/image_gallery?img_id=660619%22,",
    "primaryLanguage": "en_US",
    "title": "Icareus HD",
    "serviceId": 163139,
    "tsId": 1,
    "description": "Icareus HD for testing",
    "quality": 1,
    "startOver": 1,
    "audioOnly": 0,
    "bsId": 1
  }
}

GET CATEGORIES

Name	Requirement	Description	Values
action	Mandatory	Action call to make	getCategories
version	Mandatory	Version to use	04
organizationId	Mandatory	The ID of the account/organization	Number

RESPONSE

{
"status": "ok",
"categories": [
    {
      "id": 83111,
      "title": "Movies",
      "level": 1,
      "image": "",
      "categories": [
        {
          "id": 590058,
          "title": "Action",
          "level": 2,
          "image": "",
          "categories": []
        },
        {
          "id": 675903,
          "title": "Horror",
          "level": 2,
          "image": "",
          "categories": []
        }
      ]
    },
    {
      "id": 83455,
      "title": "Sport",
      "level": 1,
      "image": "",
      "categories": []
    },
    {
      "id": 83755,
      "title": "News",
      "level": 1,
      "image": "",
      "categories": []
    }
]
}