OnAIRTools.Api

<back to all web services

GetSongRequests

The following routes are available for this service:
GET/songrequests
GET/station/{StationId}/songrequests
GetSongRequests Parameters:
NameParameterData TypeRequiredDescription
StationIdpathintNo
GetSongRequestsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<SongRequest>No
SongRequest Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StationIdformintNo
FromNameformstringNo
FromNumberformstringNo
SongRequestDateformDateTime?No
CommentformstringNo
TrackIDformintNo
TrackNameformstringNo
ArtistformstringNo
TitleformstringNo

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 /songrequests HTTP/1.1 
Host: onairtools.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSongRequestsResponse 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>
    <SongRequest>
      <Artist>String</Artist>
      <Comment>String</Comment>
      <FromName>String</FromName>
      <FromNumber>String</FromNumber>
      <Id>0</Id>
      <SongRequestDate>0001-01-01T00:00:00</SongRequestDate>
      <StationId>0</StationId>
      <Title>String</Title>
      <TrackID>0</TrackID>
      <TrackName>String</TrackName>
    </SongRequest>
  </Result>
</GetSongRequestsResponse>