User:Ncarthy: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
Retrieve recently added songs<br /> | |||
'''Permissions:''' | '''Permissions:''' | ||
* | * ReadData | ||
'''Parameters:''' | '''Parameters:''' | ||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | ||
[ | # [ ''[[#List.Amount|List.Amount]]'' albumlimit = -1 ] | ||
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ] | |||
# [ ''[[#List.Limits|List.Limits]]'' limits ] | |||
# [ ''[[#List.Sort|List.Sort]]'' sort ] | |||
" | </div> | ||
'''Returns:''' | |||
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA"> | |||
{ | |||
"properties": { | |||
" | "limits": { | ||
"$ref": "List.LimitsReturned", | |||
"required": true | |||
}, | |||
"songs": { | |||
"items": { | |||
" | "$ref": "Audio.Details.Song" | ||
}, | }, | ||
"type": "array" | |||
} | |||
}, | }, | ||
"type": "object" | |||
} | |||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{ | |||
"description": "Retrieve recently added songs", | |||
"permission": "ReadData", | |||
"type": "method", | |||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{ | |||
"params": [ | "params": [ | ||
{ | { | ||
"name": " | "default": "-1", | ||
"required": | "name": "albumlimit", | ||
" | "required": false, | ||
"$ref": "List.Amount" | |||
}, | |||
{ | |||
"name": "properties", | |||
"required": false, | |||
"$ref": "Audio.Fields.Song" | |||
}, | }, | ||
{ | { | ||
" | "name": "limits", | ||
" | "required": false, | ||
" | "$ref": "List.Limits" | ||
}, | }, | ||
{ | { | ||
" | "name": "sort", | ||
" | "required": false, | ||
" | "$ref": "List.Sort" | ||
} | } | ||
] | ], | ||
}}</syntaxhighlight>}} | "returns": { | ||
"properties": { | |||
"limits": { | |||
"$ref": "List.LimitsReturned", | |||
"required": true | |||
}, | |||
"songs": { | |||
"items": { | |||
"$ref": "Audio.Details.Song" | |||
}, | |||
"type": "array" | |||
} | |||
}, | |||
"type": "object" | |||
} | |||
}</syntaxhighlight>}} |
Revision as of 00:39, 19 February 2017
Retrieve recently added songs
Permissions:
- ReadData
Parameters:
- [ List.Amount albumlimit = -1 ]
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
Returns:
{
"properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object"
}
JSON Schema Description |
---|
{ "description": "Retrieve recently added songs", "permission": "ReadData", "type": "method", "params": [ { "default": "-1", "name": "albumlimit", "required": false, "$ref": "List.Amount" }, { "name": "properties", "required": false, "$ref": "Audio.Fields.Song" }, { "name": "limits", "required": false, "$ref": "List.Limits" }, { "name": "sort", "required": false, "$ref": "List.Sort" } ], "returns": { "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } }, "type": "object" } } |