GET api/Song?searchTerm={searchTerm}&page={page}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
searchTerm

string

Required

page

integer

Required

Body Parameters

None.

Response Information

Resource Description

SongListReponseModel
NameDescriptionTypeAdditional information
TotalSongCount

Total amount of songs in the database

integer

None.

PageSize

Page size which is defined on the side of the server

integer

None.

Songs

List of songs

Collection of SongModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalSongCount": 1,
  "PageSize": 2,
  "Songs": [
    {
      "Id": "c6798ad6-71f2-4287-b124-2b020612e0dc",
      "ArtistName": "sample string 2",
      "AlbumName": "sample string 3",
      "Title": "sample string 4",
      "Duration": 5,
      "PreviewAvailable": true,
      "Extension": "sample string 7"
    },
    {
      "Id": "c6798ad6-71f2-4287-b124-2b020612e0dc",
      "ArtistName": "sample string 2",
      "AlbumName": "sample string 3",
      "Title": "sample string 4",
      "Duration": 5,
      "PreviewAvailable": true,
      "Extension": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<SongListReponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mk2.AkoestIq.Web.Services.Song.Models">
  <PageSize>2</PageSize>
  <Songs>
    <SongModel>
      <AlbumName>sample string 3</AlbumName>
      <ArtistName>sample string 2</ArtistName>
      <Duration>5</Duration>
      <Extension>sample string 7</Extension>
      <Id>c6798ad6-71f2-4287-b124-2b020612e0dc</Id>
      <PreviewAvailable>true</PreviewAvailable>
      <Title>sample string 4</Title>
    </SongModel>
    <SongModel>
      <AlbumName>sample string 3</AlbumName>
      <ArtistName>sample string 2</ArtistName>
      <Duration>5</Duration>
      <Extension>sample string 7</Extension>
      <Id>c6798ad6-71f2-4287-b124-2b020612e0dc</Id>
      <PreviewAvailable>true</PreviewAvailable>
      <Title>sample string 4</Title>
    </SongModel>
  </Songs>
  <TotalSongCount>1</TotalSongCount>
</SongListReponseModel>