OnAIRTools.Api

<back to all web services

UpdateNowPlaying

Requires Authentication
The following routes are available for this service:
POST/nowplaying
UpdateNowPlaying Parameters:
NameParameterData TypeRequiredDescription
CurrentArtistbodystringNo
CurrentTitlebodystringNo
CurrentAlbumbodystringNo
CurrentImagebodystringNo
NextArtistbodystringNo
NextTitlebodystringNo
NextAlbumbodystringNo
NextImagebodystringNo
GetNowPlayingResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformNowPlayingNo
NowPlaying Parameters:
NameParameterData TypeRequiredDescription
PreviousformTrackNo
CurrentformTrackNo
NextformTrackNo
Track Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ImageformstringNo
TitleformstringNo
ArtistformstringNo
AlbumformstringNo
StationIdformintNo
LikesformintNo
DislikesformintNo

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.

POST /nowplaying HTTP/1.1 
Host: onairtools.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateNowPlaying xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnAIRTools.Api.Dto">
  <CurrentAlbum>String</CurrentAlbum>
  <CurrentArtist>String</CurrentArtist>
  <CurrentImage>String</CurrentImage>
  <CurrentTitle>String</CurrentTitle>
  <NextAlbum>String</NextAlbum>
  <NextArtist>String</NextArtist>
  <NextImage>String</NextImage>
  <NextTitle>String</NextTitle>
</UpdateNowPlaying>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNowPlayingResponse 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>
    <Current>
      <Album>String</Album>
      <Artist>String</Artist>
      <Dislikes>0</Dislikes>
      <Id>0</Id>
      <Image>String</Image>
      <Likes>0</Likes>
      <StationId>0</StationId>
      <Title>String</Title>
    </Current>
    <Next>
      <Album>String</Album>
      <Artist>String</Artist>
      <Dislikes>0</Dislikes>
      <Id>0</Id>
      <Image>String</Image>
      <Likes>0</Likes>
      <StationId>0</StationId>
      <Title>String</Title>
    </Next>
    <Previous>
      <Album>String</Album>
      <Artist>String</Artist>
      <Dislikes>0</Dislikes>
      <Id>0</Id>
      <Image>String</Image>
      <Likes>0</Likes>
      <StationId>0</StationId>
      <Title>String</Title>
    </Previous>
  </Result>
</GetNowPlayingResponse>