Rcs-eval/common/v2.1/result-search

Jump to: navigation, search

Result

Contains information about an item returned in a Rovi Search response.

Elements

NameTypeDescription
album album [ ] A Rovi Music Album/Info response, returned only for a request with an entity type of album.
availabilities availability [ ] Information about a result that is also found on an upcoming television service channel lineup, returned when the request specified the available‑clu parameter.
id string Database ID for an item returned in a response.
messages string [ ] Reasons why the item was selected.
movie movie [ ] A Rovi DVDs Movie/Info response, returned only for a request with an entity type of movie or tvseries.
name name [ ] A Name/Info response, returned only for a request with an entity type of artist.
relevance relevance [ ] Rating of the item. Items with a higher relevance appear earlier in the response list.
song song [ ] A Rovi Music Song/Info response, returned only for a request with an entity type of song.
type string Entity type of the item.
video video [ ] A Rovi Video Video/Info response, returned only for requests with a video endpoint.

XML Response Example

<result>
  <type>album</type>
  <relevance>
    <code>Score</code>
    <value>1.4003234</value>
  </relevance>
  <availabilties/>
  <id>MW0000057397</id>
  <messages i:nil="true"/>
  <album>
    <ids>
      <albumId>MW0000057397</albumId>
      <amgClassicalId i:nil="true"/>
      <amgPopId>R 479610</amgPopId>
    </ids>
    <title>Love</title>
    <primaryArtists>
      <AlbumArtist>
        <id>MN0000816890</id>
        <name>Johnny Cash</name>
      </AlbumArtist>
    </primaryArtists>
    <guestArtists i:nil="true"/>
    <flags>
      <a:string>Compilation</a:string>
    </flags>
    <duration>2382</duration>
    <originalReleaseDate>2000-05-23</originalReleaseDate>
    <rating>8</rating>
    <isPick>false</isPick>
    <genres>
      <Genre>
        <id>MA0000002532</id>
        <name>Country</name>
        <weight>10</weight>
      </Genre>
      <Genre>
        <id>MA0000002613</id>
        <name>Pop/Rock</name>
        <weight>5</weight>
      </Genre>
    </genres>
    <headlineReview i:nil="true"/>
    <classicalReview i:nil="true"/>
    <classicalReviewUri i:nil="true"/>
    <credits i:nil="true"/>
    <creditsUri>http://api.rovicorp.com/v1/album/credits?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</creditsUri>
    <images i:nil="true"/>
    <imagesUri>http://api.rovicorp.com/v1/album/images?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</imagesUri>
    <moods i:nil="true"/>
    <moodsUri>http://api.rovicorp.com/v1/album/moods?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</moodsUri>
    <primaryReview i:nil="true"/>
    <primaryReviewUri>http://api.rovicorp.com/v1/album/primaryReview?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</primaryReviewUri>
    <releases i:nil="true"/>
    <releasesUri>http://api.rovicorp.com/v1/album/releases?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</releasesUri>
    <similar i:nil="true"/>
    <similarUri>http://api.rovicorp.com/v1/album/similar?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</similarUri>
    <styles i:nil="true"/>
    <stylesUri>http://api.rovicorp.com/v1/album/styles?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</stylesUri>
    <themes i:nil="true"/>
    <themesUri i:nil="true"/>
    <tracks i:nil="true"/>
    <tracksUri>http://api.rovicorp.com/v1/album/tracks?format=xml&amp;apikey=4p1k3y&amp;albumid=MW0000057397</tracksUri>
  </album>
</result>

JSON Response Example

{
   "type":"tvseries",
   "relevance":[
      {
         "code":"Score",
         "value":2.2900937
      }
   ],
   "availabilities":[
      {
         "format":"unknown",
         "cosmosource":2534,
         "source":"CLU_63612",
         "available_as":{
            "id":7181730,
            "type":"CosmoIdProgram"
         },
         "start":"20120409050000+0000",
         "end":"20120409060000+0000"
      },
      {
         "format":"unknown",
         "cosmosource":2534,
         "source":"CLU_63612",
         "available_as":{
            "id":6619006,
            "type":"CosmoIdProgram"
         },
         "start":"20120409040000+0000",
         "end":"20120409050000+0000"
      }
   ],
   "id":3899298,
   "messages":null,
   "video":{
      "ids":{
         "amgMovieId":null,
         "cosmoId":"3899298",
         "iguideId":3899298
      },
      "seriesIds":null,
      "masterTitle":"NCIS",
      "secondaryTitle":"",
      "episodeTitle":null,
      "category":"Other",
      "color":"Color",
      "lastAirDate":null,
      "originalAirDate":"2003-09-23T00:00:00Z",
      "programType":"Series",
      "releaseYear":2003,
      "duration":60,
      "subcategory":"crime drama",
      "syndicated":false,
      "programLanguage":"English",
      "partNumber":null,
      "partTotal":null,
      "parentalRatings":null,
      "parentalRatingsUri":"http://api.rovicorp.com/v1/video/parentalratings?format=json&apikey=4p1k3y&cosmoid=3899298",
      "cast":null,
      "castUri":"http://api.rovicorp.com/v1/video/cast?format=json&apikey=4p1k3y&cosmoid=3899298",
      "crew":null,
      "crewUri":"http://api.rovicorp.com/v1/video/crew?format=json&apikey=4p1k3y&cosmoid=3899298",
      "awards":null,
      "awardsUri":"http://api.rovicorp.com/v1/video/awards?format=json&apikey=4p1k3y&cosmoid=3899298",
      "images":null,
      "imagesUri":"http://api.rovicorp.com/v1/video/images?format=json&apikey=4p1k3y&cosmoid=3899298",
      "clip":null,
      "clipUri":"http://api.rovicorp.com/v1/video/clip?format=json&apikey=4p1k3y&cosmoid=3899298",
      "seasons":null,
      "seasonsUri":"http://api.rovicorp.com/v1/video/seasons?format=json&apikey=4p1k3y&cosmoid=3899298",
      "schedule":"",
      "scheduleUri":null,
      "event":null,
      "eventUri":null,
      "keywords":null,
      "keywordsUri":null,
      "moods":null,
      "moodsUri":null,
      "related":null,
      "relatedUri":"http://stg-api.rovicorp.com/v1/video/related?format=json&apikey=4p1k3y&cosmoid=3899298",
      "review":null,
      "reviewUri":null,
      "synopsis":null,
      "synopsisUri":"http://stg-api.rovicorp.com/v1/video/synopsis?format=json&apikey=4p1k3y&cosmoid=3899298",
      "themes":null,
      "themesUri":null,
      "tones":null,
      "tonesUri":"http://stg-api.rovicorp.com/v1/video/tones?format=json&apikey=4p1k3y&cosmoid=3899298"
   }
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/Rcs-eval/common/v2.1/result-search"
Personal tools