OnAIRTools.Api

<back to all web services

GetPlaylist

The following routes are available for this service:
GET/station/{StationId}/playlist/{PlaylistId}
GetPlaylist Parameters:
NameParameterData TypeRequiredDescription
StationIdpathintNo
PlaylistIdpathintNo
GetPlaylistResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformPlaylistNo
Playlist Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StationIdformintNo
NameformstringNo
ItemsformList<PlaylistEntry>No
PlaylistEntry Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PlaylistIdformintNo
TrackIdformint?No
PlayedformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /station/{StationId}/playlist/{PlaylistId} HTTP/1.1 
Host: onairtools.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPlaylistResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnAIRTools.Api.Dto">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <Id>0</Id>
    <Items>
      <PlaylistEntry>
        <Id>0</Id>
        <Played>0001-01-01T00:00:00</Played>
        <PlaylistId>0</PlaylistId>
        <TrackId>0</TrackId>
      </PlaylistEntry>
    </Items>
    <Name>String</Name>
    <StationId>0</StationId>
  </Result>
</GetPlaylistResponse>