OnAIRTools.Api

<back to all web services

GetProgram

The following routes are available for this service:
GET/station/{StationId}/Program
GetProgram Parameters:
NameParameterData TypeRequiredDescription
StationIdpathintNo
GetProgramResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformProgramNo
Program Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StationIdformintNo
MondayformList<ProgramEntry>No
TuesdayformList<ProgramEntry>No
WednesdayformList<ProgramEntry>No
ThursdayformList<ProgramEntry>No
FridayformList<ProgramEntry>No
SaturdayformList<ProgramEntry>No
SundayformList<ProgramEntry>No
ProgramEntry Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
StationIdformintNo
ShowIdformintNo
DayformDayOfWeekNo
StartformDateTimeNo
EndformDateTimeNo

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

<GetProgramResponse 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>
    <Friday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Friday>
    <Id>0</Id>
    <Monday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Monday>
    <Saturday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Saturday>
    <StationId>0</StationId>
    <Sunday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Sunday>
    <Thursday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Thursday>
    <Tuesday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Tuesday>
    <Wednesday>
      <ProgramEntry>
        <Day>Sunday</Day>
        <End>0001-01-01T00:00:00</End>
        <ShowId>0</ShowId>
        <Start>0001-01-01T00:00:00</Start>
        <StationId>0</StationId>
      </ProgramEntry>
    </Wednesday>
  </Result>
</GetProgramResponse>