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 .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}/playlist/{PlaylistId} 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,
		Name: String,
		Items: 
		[
			{
				Id: 0,
				PlaylistId: 0,
				TrackId: 0,
				Played: 0001-01-01
			}
		]
	}
}