This is Inside RadioTime, a website that gives Broadcasters, Developers, OEMs and Advertisers looking for the 411 on the RadioTime guide.

getMetadata

Summary

This method is used to browse our radio guide. It produces lists of <mediaMetadata> and <mediaCollection> elements based on the ID requested.

Input

Field Description Values Required
id The metadata identifier to retrieve; these will be globally unique Provided by the service; use “root” for the top-level menu No, defaults to “root”
index The start index for the result set, if client is paging 0-N Yes
count The maximum number of items to return in the response 0-N Yes, but can be set to 0 for default
recursive Provided for a response based on the given ID and its child; however, value not used by the service true/false Yes, but should be set to false 
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <credentials xmlns="http://www.sonos.com/Services/1.1">
      <deviceId>0A:23:32:5B:9E:DC</deviceId>
      <deviceProvider>YourProduct</deviceProvider>
    </credentials>
  </soap:Header>
  <soap:Body>
    <getMetadata xmlns="http://www.sonos.com/Services/1.1">
      <id>root</id>
      <index>0</index>
      <count>100</count>
      <recursive>false</recursive>
    </getMetadata>
  </soap:Body>
</soap:Envelope>

This call accepts a number of “special” IDs to browse different structures of content:

ID Description
local When set to local, the service will do a local radio search based on IP geo-detection
z10001 To search a specific US postal code, use the prefix “z” plus the postal code
popular When set to popular, the service will return a list of popular stations and shows
recent When set to recent, the service will return a list of recently updated stations and shows

Output

Information about the result set plus the result items themselves – zero or more media metadata elements or collections.

Field Description Values
getMetadataResult.index The starting index of the returned results – should match the requested index 0-N
getMetadataResult.count The number of returned results – should match the requested count 0-N
getMetadataResult.total The total number of results available (can be greater than the count) 0-N