This document should outline the details of the dynamic data that the application will consume, the source it will come from, access details and format information, etc.
http://example.com/api/search
Query parameters
| Parameter (default) | Description |
|---|---|
| source (all) | The data source to search against with the give search query. |
| query | The search term |
| page (1) | (optional) The page number to fetch from a paged list of results |
| size (20) | (optional) The size of the page (number of results that will be returned) to fetch from a page list of results |
http://example.com/api/search?source=artists&query=foo&page=1&size=25
[
{
"name": "Foo Fighters",
"albums": [
"Wasting Light",
"Echoes, Silence, Patience & Grace",
"Skin and Bones",
"In Your Honor",
"One by One",
"There is Nothing Left to Lose",
"The Colour and the Shape"
],
"links": [
{
"rel": "details",
"href": "http://example.com/api/artists/100014796/foo-fighters"
}
]
},
{
"name": "Fools Garden",
"albums": [
"Who is Jo King",
"Ready for the Real Life",
"25 miles to kissimmee",
"For Sale",
"Dish of the Day"
],
"links": [
{
"rel": "details",
"href": "http://example.com/api/artists/100027837/fools-garden"
}
]
},
{
"name": "Thousand Foot Krutch",
"albums": [
"Metamorphosiz: The End Remixes, Vol. 2",
"The End is Where We Begin",
"Live at the Masquerade",
"Deja Vu: The TFK Anthology",
"Welcome to the Masquerade",
"The Flame in All of Us",
"The Art of Breaking"
],
"links": [
{
"rel": "details",
"href": "http://example.com/api/artists/100039461/thousand-foot-krutch"
}
]
}
]http://example.com/api/search/sources
[
"all",
"artists",
"albums",
"music"
]http://example.com/api/artists/{id}
URL Tokens
| Token | Description | Data Type |
|---|---|---|
| id | The id of an artist to fetch | number |
http://example.com/api/artists/100014796
{
"id": 100014796,
"name": "Foo Fighters",
"description": "West coast based grunge rock band, founded by Dave Grohl, former drummer of Nirvana",
"albums": [
{
"id": 9004283094,
"name": "Wasting Light",
"url": "http://example.com/artists/100014796/foo-fighters/albums/9004283094/wasting-light"
},
{
"id": 900283940,
"name": "Echoes, Silence, Patience & Grace",
"url": "http://example.com/artists/100014796/foo-fighters/albums/900283940/echoes-silence-patience-grace"
},
{
"id": 900103829,
"name": "Skin and Bones",
"url": "http://example.com/artists/100014796/foo-fighters/albums/900103829/skin-and-bones"
},
{
"id": 900793718,
"name": "In Your Honor",
"url": "http://example.com/artists/100014796/foo-fighters/albums/900793718/in-your-honor"
},
{
"id": 900902849,
"name": "One by One",
"url": "http://example.com/artists/100014796/foo-fighters/albums/900902849/one-by-one"
},
{
"id": 900342956,
"name": "There is Nothing Left to Lose",
"url": "http://example.com/artists/100014796/foo-fighters/albums/900342956/there-is-nothing-left-to-lose"
},
{
"id": 900019297,
"name": "The Colour and the Shape",
"url": "http://example.com/artists/100014796/foo-fighters/albums/900019297/the-colour-and-the-shape"
}
],
"links": [
{
"rel": "details",
"href": "http://example.com/api/artists/100014796/foo-fighters"
},
{
"rel": "albums",
"href": "http://example.com/api/artists/100014796/foo-fighters/albums"
}
]
}http://example.com/api/cart/{userId}
URL Tokens
| Token | Description | Data Type |
|---|---|---|
| userId | The ID of the user the shopping cart belongs to | guid |
http://example.com/api/cart/2e8dae28-1696-4ce4-b225-bd35a8e5ee06
{
}http://example.com/api/cart/2e8dae28-1696-4ce4-b225-bd35a8e5ee06
{
}