Skip to content

Instantly share code, notes, and snippets.

@vreality64
Last active December 28, 2015 01:08
Show Gist options
  • Save vreality64/7417877 to your computer and use it in GitHub Desktop.
Save vreality64/7417877 to your computer and use it in GitHub Desktop.
SoundPancake Front-end Query API and Example (Request and Expected Response)
1. Editor
- request
{
midiObject: {
title: string,
description: string,
artist: string,
playtime: integer,
owner: string,
albumArtName: string,
albumArt: (binary data),
MidiFile: midiData
}
}
- response
- Only HTTP Status Codr. (200, 4xx)
2. Music List
- request
{
userid: string,
name: string,
like: boolean,
page: number
}
- response
{
list: [
MidiObject: {
id: string,
title: string,
description: string,
artist: string,
playtime: integer,
owner: string,
albumArtName: string,
albumArt: (binary data),
MidiFileId: midiData
}
]
}
3. Play List
- request
{
userid: string,
name: string,
mood: [
name: string
],
action: [
social-action-name: string
],
like: boolean,
comment: boolean, // not yet implemented, so doesn't needed so far
page: number
}
-response
{
list: [
PlayList: {
id: string,
name: string,
description,
publisher: string,
publisherImage: (binary data),
like: number,
comment: number,
share: string (link),
musicList: [
MidiObject: ... (cited above)
]
}
]
}
4. DashBoard
- request
{
userid: string,
action: [
social-action-name: string
],
page: number
}
- response
{
list: (there are two type of lists, refer each response object)
- Music List
- Play List
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment