ViRe Playlist Service
The API for the Playlist Service from ViRe WaDe Project
Version: 1.0.0
BasePath:/RDaniel99/ViRe-Playlist-Service/1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
post /playlist/{playlistId}/add/{songId}
(addSongToPlaylist)
Path parameters
songId (required)
Path Parameter —
playlistId (required)
Path Parameter —
Responses
200
successfully added song to playlist
Up
delete /playlist/{playlistId}/remove/{songId}
(removeSongToPlaylist)
Path parameters
songId (required)
Path Parameter —
playlistId (required)
Path Parameter —
Responses
200
successfully removed song to playlist
Up
post /playlist/{playlistId}/share/{userId}
(sharePlaylistToUser)
Path parameters
userId (required)
Path Parameter —
playlistId (required)
Path Parameter —
Responses
200
successfully shared playlist to user
Up
delete /playlist/{playlistId}/remove/{userId}
(unsharePlaylistToUser)
Path parameters
userId (required)
Path Parameter —
playlistId (required)
Path Parameter —
Responses
200
successfully unshared playlist to user
Up
delete /playlist/{playlistId}
(deletePlaylist)
delete playlist with specific id
Path parameters
playlistId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"code" : 0,
"message" : "everything is ok"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Playlist with given id deleted
ApiResponse
Up
get /playlist/{playlistId}
(getPlaylist)
returns playlist with specific id
Path parameters
playlistId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"authorId" : "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Playlist with given id retrieved
Playlist
Up
get /playlist/{playlistId}/songs
(getPlaylistSongs)
returns songs of playlist specific id
Path parameters
playlistId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
[ {
"author" : "author",
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"info" : ""
}, {
"author" : "author",
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"info" : ""
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
returns list of songs for playlist
Up
get /playlist/ofUser/{userId}
(getUserPlaylists)
returns playlists of user with specific id
Path parameters
userId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"authorId" : "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}, {
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"authorId" : "0729a580-2240-11e6-9eb5-0002a5d5c51b"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
returns list of playlists of user
(postPlaylist)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
successfully registered playlist
Up
put /playlist/{playlistId}
(updatePlaylist)
update playlist with specific id
Path parameters
playlistId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"authorId" : "0729a580-2240-11e6-9eb5-0002a5d5c51b"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Playlist with given id updated
Playlist
Up
delete /songs/{songId}
(deleteSong)
delete song with specific id
Path parameters
songId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"code" : 0,
"message" : "everything is ok"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Song with given id deleted
ApiResponse
(getSong)
returns song with specific id
Path parameters
songId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"author" : "author",
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"info" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Song with given id retrieved
Song
(postSong)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
successfully registered song
(updateSong)
update song with specific id
Path parameters
songId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"author" : "author",
"name" : "name",
"id" : "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"info" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Song with given id updated
Song
[ Jump to Methods ]
Table of Contents
AnyValueApiResponsePlaylistSong
code (optional)
message (optional)
example: everything is ok
id (optional)
example: 0729a580-2240-11e6-9eb5-0002a5d5c51b
name (optional)
authorId (optional)
example: 0729a580-2240-11e6-9eb5-0002a5d5c51b
id (optional)
example: 0729a580-2240-11e6-9eb5-0002a5d5c51b
name (optional)
author (optional)
info (optional)