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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	{
		Id: 0,
		StationId: 0,
		Monday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		],
		Tuesday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		],
		Wednesday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		],
		Thursday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		],
		Friday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		],
		Saturday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		],
		Sunday: 
		[
			{
				Id: 0/0,
				StationId: 0,
				ShowId: 0,
				Day: Sunday,
				Start: 0001-01-01,
				End: 0001-01-01
			}
		]
	}
}