OnAIRTools.Api

<back to all web services

QuerySongRequests

The following routes are available for this service:
All Verbs/songrequests/query
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SongRequest Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StationIdformintNo
FromNameformstringNo
FromNumberformstringNo
SongRequestDateformDateTime?No
CommentformstringNo
TrackIDformintNo
TrackNameformstringNo
ArtistformstringNo
TitleformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /songrequests/query HTTP/1.1 
Host: onairtools.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			StationId: 0,
			FromName: String,
			FromNumber: String,
			SongRequestDate: 0001-01-01,
			Comment: String,
			TrackID: 0,
			TrackName: String,
			Artist: String,
			Title: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}