Q. How do I get a list of channels for a platform?

A. In order to retrieve a list of channels for a platform the user must first retrieve the platform ID from the Platform Collection Resource.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/platform"

Using this ID, the user can now query the Channel Collection with the platformId query parameter.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/channel?platformId=<PLATFORM ID>"

Q. How do I get a schedule for a platform and region I am interested in?

A. Firstly a user must lookup the platform and region they are interested in, this can be done by using the Platform Collection and Platform Region Collection resources.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/platform"

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/platform/<PLATFORM ID>/region"

Now a user can pass both the platformId and regionId to the Schedule Collection endpoint.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/schedule?platformId=<PLATFORM ID>&regionId=<REGION ID>"

*Please note it is recommended to use start and end dates when querying the schedule endpoint, the user should also make use ofPagination to help with handling large datasets.

Q. How do I search schedules by an Actor of interest?

A. To search the schedules for an actor of your interest you must first look up the actor's ID using the Contributor Collection endpoint. This resource allows you to search across PA's achieve of contributors.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/contributor?query=<ACTORS NAME>

Once you have retrieved the actor's ID you can pass this ID into the Schedule Collection resource using the contributorId query parameter. You must also specify a platformId and RegionId or a channelId when querying the schedule resource with the contributorId query parameter.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/schedule?platformId=<PLATFORM ID>&regionId=<REGION ID>&contributorId=<CONTRIBUTOR ID>"

Q. How do I search schedules by a Film of my interest?

A. Similar to the search schedules by Actor, a user must first lookup the asset ID for the film of interest. This can be done using the Asset Collection resource.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/asset?type=movie&query=<FILM NAME>"

Once the user has selected the asset ID they can pass this on to the Schedule Collection endpoint using the assetId query parameter.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/schedule?platformId=<PLATFORM ID>&regionId=<REGION ID>&assetId=<ASSET ID>"

Q. How would I create a 2-way scrollable EPG using the API?

A. Most EPGs expose schedule data in a tabular format, displaying the channels down the left and the schedule for each channel to the right. As the EPG scrolls down, more channels enter the view as a user scrolls to the right, the schedule moves forward in time.

In order to achieve this functionally using the API, it is recommended that a user renders the schedules using the channelId query param.

Firstly retrieve the channel list for the platform/region of your interest, this result can be paginated so make sure a note is kept of where you are so as you scroll you can ask for the next set of channels.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/channel?platformId=<PLATFORM ID>&regionId=<REGION ID>&limit=20&offset=20"

Now for each channel go get the schedule data for a date range you require, most probably the next 24 hours.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/schedule?channelId=<CHANNEL ID>&start=now&end=now.plus.24&limit=1000"

As the user scrolls to the right, each channel would then request the next 24 hours worth of data.

Q. How do I return a list of movies within a genre?

A. The first step is to lookup the relevant tag for the genre of your choosing. You can do this using the Tag Collection endpoint.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/tag?query=<GENRE NAME>"

Now using this ID you can pass this to the Asset Collection along with the movie type.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/asset?tag=<TAG ID>&type=movie"

Q. How do I return a list of assets containing a specific word?

A. If you want to free text search the Asset Collection this can be done by simply using the 'query' query parameter.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/asset?query=<QUERY STRING>"

Q. How do I return a list of features for the week?

A. The API exposes the concept of features using the Feature Collection resource. A feature is a curated list of assets scheduled in a week. Using the Feature data dictionary, a user can pass a tag to the feature collection endpoint. When using features a user should provide a week date range as features are selected on a weekly basis.

curl \
  -H "Accept: application/json" \
  -H "apikey: <API KEY>" \
  "http://tv.api.press.net/v1/feature?tag=<FEATURE TAG>&start=<START DATE>&end=<END DATE>"