/related
- Mount Point: /resource/rest/related
The following operations are supported on this resource:
Get related content for a specific region. Both VOD and EPG content is searched.
For VOD only bundles with active licensing window are returned. No licensing window implies unlimited window.
Note: this API might use caching configured in web.xml.
Parameters
name |
description |
type |
default |
id |
Set of identifiers. |
query |
|
regionId |
EPG Region identifier |
query |
|
entityType |
Type of content to search for; VOD, EPG or not specified. If not specified, implies both are searched. |
query |
|
start |
0..N - start offset for returned documents. Default value is 0. |
query |
0 |
count |
1..N - number of documents to return. By default, return all documents. |
query |
|
filters |
Program fields available for filtering. |
query |
|
sort |
Comma delimited list of sort order and priority. Order is by default ascending. To designate descending order, prepend '-'character to field name. E.g. field_name,-field_name. |
query |
|
locale |
Locale to search and return data for. If not specified, default chosen at install time is used. |
query |
|
formatCode |
Code of format in which result should be shown. |
query |
|
subType |
This is a convenience parameter that will filter VOD content based on bundle type. This parameter is case insensitive andaccepts a comma delimited list of values where comma is analogous to an OR operation, i.e. bundle type matches any of the valuesprovided is a candidate for return. |
query |
|
subcodes |
This parameter expects values in the following format "operation:comma delimited list of codes" where the operator can beone of the following:- EQUALS - return only those bundles that have one of the codes in the list.
- NOT - return bundles that are available by product offer window or via an active subscription and do not have codes from thesupplied list.
- ADD - return bundles that are available by product offer window or via an active subscription or have codes from the suppliedlist.
|
query |
|
epgSubTypes |
This parameter will filter EPG content based on program subtype. This parameter is case insensitive and accepts a commadelimited list of values where comma is analogous to an OR operation. Defaults to "SINGLE" value if parameter is notprovided. |
query |
SINGLE |
products |
This parameter accepts the following values (case insensitive):- any - return any bundle regardless if it has products or not.
- only - default value. Return only those bundles that have products.
- none - return only those bundles that have no products.
Default value is ONLY. |
query |
ONLY |
Output Payload
element |
produceable content type(s) |
(custom) |
|
description |
Return programs and products in requested format. |
Exceptions
name |
description |
com.extend.opencase.occ.client.web.exception.RESTWebserviceException |
Thrown if exception occurs. |