OnAIRTools.Api

<back to all web services

GetPlaylistView

The following routes are available for this service:
GET/station/{StationId}/playlistview/{PlaylistId}
GetPlaylistView Parameters:
NameParameterData TypeRequiredDescription
StationIdpathint?No
PlaylistIdpathint?No
FromDatequeryDateTime?No
LimitqueryintNo
GetPlaylistViewResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NameformstringNo
ResultformList<PlaylistEntryView>No
PlaylistEntryView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TrackIdformint?No
TrackformTrackNo
PlayedformDateTime?No
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 .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}/playlistview/{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
		}
	},
	Name: String,
	Result: 
	[
		{
			Id: 0,
			TrackId: 0,
			Track: 
			{
				Id: 0,
				Image: String,
				Title: String,
				Artist: String,
				Album: String,
				StationId: 0,
				Likes: 0,
				Dislikes: 0
			},
			Played: 0001-01-01
		}
	]
}