OnAIRTools.Api

<back to all web services

UpdateNowPlaying

Requires Authentication
The following routes are available for this service:
POST/nowplaying
UpdateNowPlaying Parameters:
NameParameterData TypeRequiredDescription
CurrentArtistbodystringNo
CurrentTitlebodystringNo
CurrentAlbumbodystringNo
CurrentImagebodystringNo
NextArtistbodystringNo
NextTitlebodystringNo
NextAlbumbodystringNo
NextImagebodystringNo
GetNowPlayingResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformNowPlayingNo
NowPlaying Parameters:
NameParameterData TypeRequiredDescription
PreviousformTrackNo
CurrentformTrackNo
NextformTrackNo
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.

POST /nowplaying HTTP/1.1 
Host: onairtools.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CurrentArtist: String,
	CurrentTitle: String,
	CurrentAlbum: String,
	CurrentImage: String,
	NextArtist: String,
	NextTitle: String,
	NextAlbum: String,
	NextImage: String
}
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: 
	{
		Previous: 
		{
			Id: 0,
			Image: String,
			Title: String,
			Artist: String,
			Album: String,
			StationId: 0,
			Likes: 0,
			Dislikes: 0
		},
		Current: 
		{
			Id: 0,
			Image: String,
			Title: String,
			Artist: String,
			Album: String,
			StationId: 0,
			Likes: 0,
			Dislikes: 0
		},
		Next: 
		{
			Id: 0,
			Image: String,
			Title: String,
			Artist: String,
			Album: String,
			StationId: 0,
			Likes: 0,
			Dislikes: 0
		}
	}
}