All Media Data

The Media API also exposes an Endpoint "allmedia", that is able to handle Results from multiple Streamtypes at once. Above all, it is very usefull for Union Queries, where multiple Streamtype Results should be ordered. It is also heavily connected to the "GlobalID" System, which gives every Media Element a global, unique ID, without the need for a Streamtype.

The All Media Endpoint accepts (mostly) all Parameters of the Standard Media Endpoints - streamtype specific Parameters and Output Modifiers are not supported.

Each All Media API Endpoint supports the special Query Parameter "selectedStreamtypes". With this Parameter, the calling Domain can control, what kind of Media shall be returned. It it is omitted, all possible Media Items will be returned.

The All Media API supports most of the default Media API Endpoints in exactly the same Way with the same Parameters - except the Need for a Streamtype.

Single Item Call

This API Calls will return only one the referenced Item (if available and accessible with the calling Domain). The Result Set Format will be an Object.

/byglobalid

GET https://api.nexx.cloud/v3.1/allmedia/byglobalid/:globalid

Path Parameters

Name	Type	Description
globalid	number	The GlobalID of the target Media Item

200

Item found

404

Default Item List Calls

/all

GET https://api.nexx.cloud/v3.1/allmedia/all

200

Item found

404

/latest

GET https://api.nexx.cloud/v3.1/allmedia/latest

returns "all" Items, sorted by Creation Date (ignores the "order" Parameters).

200

/picked

GET https://api.nexx.cloud/v3.1/allmedia/picked

returns all "picked" Items (ignores the "order" Parameter).

200

Item found

404

/evergreens

GET https://api.nexx.cloud/v3.1/allmedia/evergreens

returns all "Evergreen" Items.

200

/forkids

GET https://api.nexx.cloud/v3.1/allmedia/forkids

returns all Items, marked as "created for Kids". This is NOT connected to any Age Restriction.

200

/withawards

GET https://api.nexx.cloud/v3.1/allmedia/withawards

returns all Items, thave have been added Awards to

200

/byquery

GET https://api.nexx.cloud/v3.1/allmedia/byquery/:query

performs a regular Query on all Items. The "order" Parameters are ignored, if querymode is set to "fulltext".

Path Parameters

Name	Type	Description
streamtype	string	the Media Streamtype
query	string	the targetthe Item Slug

Query Parameters

Name	Type	Description
queryMode	string	[classicwithand, classicwithor, fulltext] defines the Way, the Query is executed. Fore more results, "classicwithor" is optiomal. For a Lucense Search with Relevance, use "fulltext"
queryFields	string	a comma seperated List of Attributes, to search within. If omitted, the Search will use all available Text Attributes.
minimalQueryScore	integer	skip Results with a Query Score lower than the given Value. Only usefull for querymode "fulltext".
includeSubstringMatches	boolean	By default, the Query will only return REsults on full Words. If also Subsctring Matches shall be returned, set this Parameter to 1. Only usefull, if querymode is not "fulltext".
skipReporting	boolean	if set to 0 or omitted, the Call will implictily report this Query to the nexxOMIA Reporting System.

200

/random

GET https://api.nexx.cloud/v3.1/allmedia/random

/mostactive

GET https://api.nexx.cloud/v3.1/allmedia/mostactive

"mostactive" refers to the Number of "Views" of each Media Item. The "order" Parameters will be ignored.

Query Parameters

Name	Type	Description
timeframe	integer	[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set.

/mostactiveexternal

GET https://api.nexx.cloud/v3.1/allmedia/mostactiveexternal

"mostactive" refers to the Number of "Views" of each Media Item (on external Platforms). The "order" Parameters will be ignored.

Query Parameters

Name	Type	Description
timeframe	integer	[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set.

Reference Item List Calls

/bytag

GET https://api.nexx.cloud/v3.1/allmedia/bytag/:tag

Path Parameters

Name	Type	Description
tag	string	the Tag to query for

/byperson

GET https://api.nexx.cloud/v3.1/allmedia/byperson/:person

Path Parameters

Name	Type	Description
person	string	the Name of the Person to query for

/bypersonid

GET https://api.nexx.cloud/v3.1/allmedia/bypersonid/:personid

Path Parameters

Name	Type	Description
personid	integer	the ID of the Person to query for

/byshow

GET https://api.nexx.cloud/v3.1/allmedia/byshow/:show

Path Parameters

Name	Type	Description
show	string	the Name of the Show to query for

/byshowid

GET https://api.nexx.cloud/v3.1/allmedia/byshowid/:showid

Path Parameters

Name	Type	Description
showid	number	the ID of the Show to query for

/byplace

GET https://api.nexx.cloud/v3.1/allmedia/byplace/:place

Path Parameters

Name	Type	Description
place	string	the Name of the Place to query for

/byplaceid

GET https://api.nexx.cloud/v3.1/allmedia/byplaceid/:placeid

Path Parameters

Name	Type	Description
placeid	number	the ID of the Place to query for

/byproduct

GET https://api.nexx.cloud/v3.1/allmedia/byproduct/:product

Path Parameters

Name	Type	Description
product*	string	the Name of the Product to query for

200

/byproductid

GET https://api.nexx.cloud/v3.1/allmedia/byproductid/:productid

Path Parameters

Name	Type	Description
productid*	number	the ID of the Product to query for

200

/byfile

GET https://api.nexx.cloud/v3.1/allmedia/byfile/:file

Path Parameters

Name	Type	Description
file*	string	the Name of the File to query for

200

/byfileid

GET https://api.nexx.cloud/v3.1/allmedia/byfileid/:fileid

Path Parameters

Name	Type	Description
fileid*	number	the ID of the File to query for

200

/bystudio

GET https://api.nexx.cloud/v3.1/allmedia/bystudio/:studioid

only available for Videos, Playlists and Sereis

Path Parameters

Name	Type	Description
studioid	number	the ID of the Studio to query for

200