/typeahead
- Mount Point: /resource/rest/typeahead
The following operations are supported on this resource:
GET
- Aliases: POST
Retrieves title information for all content that satisfies query:
- Order of words does not matter
- Logical OR operator is used for words
- Search is performed by start of the words
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 |
---|---|---|---|
regionId | EPG Region identifier. | query | |
q | Term found at the start of sg field. | query | |
entityType | Type of content to search for; VOD, EPG or not specified. If not specified, implies both are searched. | query | |
filters | Program Fields available for filtering: - pid, peid, pt, st, ts, tm, tl, srseid, sn, ept, epn, rtv, rmp, fanm, fbw, fm, fsprt, fk, k, cf_int_*, cf_float_*, cf_text_*,paids_*, g, r Notes: - cf_xxx_* set of fields refer to custom fields. You must know what the name of the custom field and its type in order to filter onit. The * is replaced with the name of the custom field. - paids_* refers to custom identifiers. Once again, you must know the name of identifier in order to filter on it. |
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 | |
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 |
subcodes | This parameter expects values in the following format "operation:comma delimited list of codes" where the operator can beone of the following:
|
query | |
products | This parameter accepts the following values (case insensitive):
|
query | ONLY |
Output Payload
element | produceable content type(s) |
---|---|
(custom) |
|
description | |
Return titles (values in the sg field) matching query in requested format. |
Exceptions
name | description |
---|---|
com.extend.opencase.occ.client.web.exception.RESTWebserviceException | Thrown if exception occurs. |