Streaming Video Search API Integration Guide

Follow

With the abundance of electronic resources available today, many schools 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. Api.infobase.com 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.

 

Search Query

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

 

Api.infobase.com/msearch/accountID/vendorID/productID/searchterm/format

 

"msearch" represents media search which 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:

 

 

 

 

  • Classroom Video On Demand - ID 121
  • CVOD: Career & Technical Education Video Collection - ID 124
  • ^Canadian Versions available.
  • Curriculum Video On Demand: Australia - ID 189
  • Learn360 - ID 136
  • Learn360 Canada - ID 143
  • Learn360 International - ID 187
  • Learn360 Feature Film Collection (Criterion On Demand) - ID 145

  

 

 

 

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".

 

Format

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)
  •    Json

 

Search Results

After you have submitted a search query to the API, you 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

Description

Database

The Infobase Platform that contains the record

AssetType

Asset type of the record

TitleID

The Infobase specific ID for the record

IsSegment

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

SegmentNumber 

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

Title

Title name of the record

Description

Full text description of the record

Source

Source of Record

Record URL

Account specific access URL to the record (authentication required)

runTime

Length of video record

copyrightYear

The Copyright year of the record

language

The primary language of the video record

collections

Listing of any Infobase Streaming Video Collections this title belongs to

subjects

Listing of Subject Areas this record is categorized as

imageURL

a link to the thumbnail image of the video

 

Please note: The Account ID in the Record URL will 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 of a Search Query for the term “frogs”:

 

http://api.infobase.com/msearch/0/0/0/frogs/xml

 

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="http://james.newtonking.com/projects/json" json:id="1">

 

<Record json:id="2">

 

<Database>Classroom Video on Demand,Learn360</Database>

<AssetType>Educational Video</AssetType>

<TitleID>80418</TitleID>

<isSegment>false</isSegment>

<Producer>Planet Bonehead Studios</Producer>

<SegmentNumber>0</SegmentNumber>

<Title>A Future For Frogs: Planet Bonehead</Title>

 

 

<Description>

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.

</Description>

<Source>Infobase</Source>

 

 

<RecordURL>

http://cvod.infobase.com/PortalPlaylists.aspx?wID=0&xtid=80418

</RecordURL>

<runTime>26:24</runTime>

<copyrightYear>2010</copyrightYear>

<language>English</language>

<collections>CVOD Master, Learn360</collections>

 

 

<subjects>

Environmental Problems & Management,Biology,Animal Biology,Environmental Science,Ecosystems,Survey / Basic Concepts,Populations, Communities & Biodiversity,Economics, Conservation, & Public Policy,Survey: Environment,Zoology

</subjects>

</Record>

 

 

Record URL Authentication

It is 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 retuned in the results will be for the Discovery Tool Partners 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.

 

<RecordURL>

http://cvod.infobase.com/PortalPlaylists.aspx?wID=0&xtid=80418

</RecordURL>

 

 

 

Additional Help

If you have any questions / concerns, or are looking to establish a Discovery Tools partnership with Infobase, please contact our API Support Staff at support@infobaselearning.com.

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.