Streaming Video Search API Integration Guide


With the abundance of electronic resources available today, many schools and public libraries prefer to access their educational assets in one place.  Federated Search Engines and other Discovery Tools allow libraries to do just that - easily browse through multiple content sources in their catalog at the same time.

The Infobase Search API provides a much needed "Communication Bridge" between our content and any Discovery Tool that our mutual customers may be using. quickly indexes search results from our Streaming Video Platform in a universal XML format.  These customizable XML search results can then be parsed with search results from other outside sources by an Infobase Discovery Tool partner.

In this Search API Integration Guide, you will find everything you need to know to get started as an Infobase Discovery Tool partner.

Available Products

The Infobase Streaming Video Search API is currently available for the following online products:

  • Films on Demand
  • Learn360 
  • Classroom Video on Demand 
  • Access Video on Demand

Search Query

In order to utilize the API, there are certain query parameters that must be added to the URL routing:

"msearch" represent media search with differs from our online database API.

Account ID

This is the customer's Infobase Account ID.  If you are using the API to harvest meta-data, there are specific Discovery Tool Partner Account IDs separated by Market/Region that can be provided.

Vendor ID

This is the Discovery Tool Partner ID that will be provided once a connection has been established with Infobase.

Product ID

This is the Product ID for what Infobase products you would like to query.  Here are the currently available product IDs:


Master Academic Collection (Package of the following) - ID 105

FOD: Business & Economics Collection - ID 100

FOD: Health Video Collection - ID 97

FOD: Humanities & Social Sciences Collection - ID 98

FOD: Science & Mathematics Collection - ID 99

Career & Technical Education Collection (Package of the following) - ID 106

FOD: Careers & Job Search Collection - ID 101

FOD: Family & Consumer Sciences Collection - ID 102

FOD: Guidance & Counseling Collection - ID 103

FOD: Technical Education Collection - ID 104

Additonal Collections

FMG Archival Films & Newsreels Collection - ID 125

FMG World Cinema Collection - ID 196

^Canadian versions available.

Other & International

FOD: United Kingdom - ID 183

FOD: Asia - ID 184

FOD: International Markets - ID 185

FOD: Australia - ID 194

Individual Subject Collections (Sold Separately)

FOD: Anthropology - ID 150

FOD: Area Studies - ID 152

FOD: Art & Architecture - ID 153

FOD: Biology - ID 154

FOD: Business & Economics - ID 100

FOD: Careers & Job Search - ID 101

FOD: Communication - ID 157

FOD: Criminal Justice & Law - ID 158

FOD: Earth Science - ID 159

FOD: Education - ID 160

FOD: Engineering - ID 161

FOD: English & Language Arts - ID 162

FOD: Environmental Science - ID 163

FOD: Family & Consumer Sciences - ID 102

FOD: Geography - ID 165

FOD: Guidance & Counseling - ID 103

FOD: Health & Medicine - ID 167

FOD: History - ID 168

FOD: Mathematics - ID 169

FOD: Music & Dance - ID 170

FOD: Philosophy & Religion - ID 171

FOD: Nursing - ID 186

FOD: Physical Science - ID 172

FOD: Political Science - ID 173

FOD: Psychology - ID 174

FOD: Sociology - ID 175

FOD: Technical & Trade Education - ID 176

FOD: Technology & Society - ID 177

FOD: World Languages - ID 178

FOD: Veterinary Science & Technology - ID 214

FOD: Physical Therapy - ID 215


Classroom Video On Demand - ID 121

CVOD: Career & Technical Education Video Collection - ID 124

^Canadian Versions available.

Curriculum Video On Demand: Australia - ID 189

Additional Collections

FMG Archival Films & Newsreels Collection - ID 125

FMG World Cinema Collection - ID 196

Learn360 - ID 136

Learn360 Canada - ID 143

Learn360 International - ID 187

Learn360 Feature Film Collection (Criterion On Demand) - ID 145

Public Library

Access Video On Demand (Package) - ID 107

AVOD: Health & Wellness - ID 108

AVOD: Science, Mathematics & Technology - ID 109

AVOD: Business & Economics - ID 110

AVOD: Arts & Humanities - ID 111

AVOD: Social Sciences - ID 112

AVOD: Careers & Trades - ID 113

AVOD: Home & Family - ID 114

AVOD: Travel & Recreation - ID 115

AVOD: Film & Television - ID 180

^Canadian Versions available. 

AVOD: Australia - ID 193

AVOD: International Markets - ID 195

Additional Collections

FMG Archival Films & Newsreels Collection - ID 125

FMG World Cinema Collection - ID 196


Search Term

This is the key word(s) you are attempting to search by.  In order to get all results, please leave this blank.  It is possible to do multiple word searches as well.

For example, "Dogs+AND+Cats"/"Dogs+OR+Cats"


This is the desired output format you would like the results to be returned in.  The available formats are:

  • XML
  • XML-file (this will return a file stream)
  • XML-zip
  • JSON


There is now a paging mode for the API query engine that should help get around any timeout issues. You have two new parameters added to the tail of the URL, after the format command.

They are the # of Rows to return in the query and what Row to start on.

suffix to add:    0/0 in form of     row/start 

The search below returns 1000 rows starting at the first item and highest weight

Here an example for databases:

For more results you can then change the last suffix to start further out.

Return Grade Level

To enable returning grades in the results, you must add txtmode=true.  For example:

 Search Results

After you have submitted a search query to the API, your results will then be returned with the available meta-data for your requested records.  Here are the currently included meta-data fields for the Infobase API:

Field Name



The Infobase Platform that contains the record


Asset type of the record


The Infobase specific ID for the record


Whether or not the record is a Full Title or Segment Clip


The Segment Sequence number if the record is not a full title


Title name of the record


Full text description of the record


Source of Record

Record URL

Account specific access URL to the record (authentication required)


Length of video record


The Copyright year of the record


The primary language of the video record


Listing of any Infobase Streaming Video Collections this title belongs to


Listing of Subject Areas this record is categorized as



a link to the thumbnail image of the video


Please note: The Account ID in the Record URL with match the Account ID provided in the original Search Query.  Using a customer's correct Account ID is the only way for any authentication settings and usage statistics recording to work properly.

Non-video asset types are now supported as well.  Learn360 queries will include Images, Printables, Articles, Audio, and Interactives.

Sample Search

Here is an example Search Query for the term "frogs":

The Account ID and Vendor ID have been set to 0 for this example.

Once completed, the XML end result would look like this for the first record returned:

<Root xmlns:json="" json:id="1">
<Record json:id="2">
<Database>Classroom Video on Demand,Learn360</Database>
<AssetType>Educational Video</AssetType>
<Producer>Planet Bonehead Studios</Producer>
<Title>A Future For Frogs: Planet Bonehead</Title>
Students learn the importance of frogs and toads to healthy ecosystems and to human health as well. The adaptations of these incredible amphibians to their environment is showcased through brilliant photography and video of endangered frog species.
<collections>CVOD Master, Learn360</collections>
Environmental Problems & Management,Biology,Animal Biology,Environmental Science,Ecosystems,Survey / Basic Concepts,Populations, Communities & Biodiversity,Economics, Conservation, & Public Policy,Survey: Environment,Zoology
Record URL Authentication
It is the Discovery Tools partner responsibility to ensure that the customer's Infobase Account ID is used in the provided Record URLs.  When harvesting for meta-data, the Account ID returned in the results will be for the Discovery Tool Partner's specific account.  Using a customer's correct Account ID is the only way for any authentication settings and usage statistics recording to work properly.  Please replace the Account ID when being displayed for a mutual customer.



Additional Help

You can now set up a POST method to receive data.  This option does not disable the current methods of access and just adds forms as an acceptable data source.  To see more on how to set up the POST method, click here.


0 out of 0 found this helpful