SearchContent

Description

The method used to get a list of CatalogItem from the GVP using a term, filterBy and searchFields. The result is an array of CatalogItem that contains all movies that respect the term and field filled.

The result is default ordered by the Unknow sort, it means that the result is returned by the registered order in the data base.

The method can be used by logged or anonymous user.

Parameters

• token (String, required)

A valid token for identifying the API session context. The token can be anonymous or logged.

• term (String, required)

A term that wants to request.

• filterBy (CatalogItemType, required)

• searchFields (SearchFieldType, required)

• sortBy (SearchFieldType, optional)

Default value is SearchFieldType.Unknown

• sortOrder (bool, optional)

Default value is false (ascending)

• includeAdult (bool, optional)

Default value is false

• imageType (ImageType, optional)

Default value is ImageType.Unknown

• width (int, optional)

Default value is 0 (zero)

• height (int, optional)

Default value is 0 (zero)

• offset (int, optional)

offset to use when returning data

• limit (int, optional)

number of results to return

Returns

Returns a JSON object containing an array of CatalogItem object.

Example:

{

Content: [

Array of CatalogItem

]

}

Exceptions

None

Caching

This method is cached.

Known issues

None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral