User:Ncarthy: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (syntaxhighlighter fix after upgrade) |
||
(6 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
Retrieve | Retrieve all songs from specified album, artist or genre<br /> | ||
'''Permissions:''' | '''Permissions:''' | ||
* ReadData | * 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"> | ||
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ] | # [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ] | ||
# [ ''[[#List.Limits|List.Limits]]'' limits ] | # [ ''[[#List.Limits|List.Limits]]'' limits ] | ||
# [ ''[[#List.Sort|List.Sort]]'' sort ] | # [ ''[[#List.Sort|List.Sort]]'' sort ] | ||
# [ ''mixed'' filter ] | |||
# [ ''boolean'' includesingles = true ] | |||
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.'' | |||
</div> | </div> | ||
'''Returns:''' | '''Returns:''' | ||
Line 13: | Line 15: | ||
'''Type:''' ''object''<br /> | '''Type:''' ''object''<br /> | ||
'''Properties:''' | '''Properties:''' | ||
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' | * ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits | ||
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] | * [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ] | ||
</div> | </div> | ||
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang= | {{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=json enclose="div">{ | ||
"description": "Retrieve | "description": "Retrieve all songs from specified album, artist or genre", | ||
"permission": "ReadData", | "permission": "ReadData", | ||
"type": "method", | "type": "method", | ||
"params": [ | "params": [ | ||
{ | { | ||
" | "$ref": "Audio.Fields.Song", | ||
"name": " | "name": "properties" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Limits", | ||
" | "name": "limits" | ||
}, | }, | ||
{ | { | ||
" | "$ref": "List.Sort", | ||
" | "name": "sort" | ||
}, | }, | ||
{ | { | ||
" | "type": [ | ||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"genreid": { | |||
"$ref": "Library.Id", | |||
"description": "Song genre. Filter for existance of songs with this genre", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"genre": { | |||
"description": "Song genre. Filter for existance of songs with this genre", | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"artistid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"artistid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
}, | |||
"roleid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"artistid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
}, | |||
"role": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"artist": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"artist": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"roleid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"artist": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
}, | |||
"role": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"albumid": { | |||
"$ref": "Library.Id", | |||
"required": true | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"additionalProperties": false, | |||
"properties": { | |||
"album": { | |||
"minLength": 1, | |||
"required": true, | |||
"type": "string" | |||
} | |||
}, | |||
"type": "object" | |||
}, | |||
{ | |||
"$ref": "List.Filter.Songs" | |||
} | |||
], | |||
"name": "filter" | |||
}, | |||
{ | |||
"default": "true", | |||
"type": "boolean", | |||
"name": "includesingles" | |||
}, | |||
{ | |||
"default": "false", | |||
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.", | |||
"type": "boolean", | |||
"name": "allroles" | |||
} | } | ||
], | ], | ||
Line 47: | Line 184: | ||
"properties": { | "properties": { | ||
"limits": { | "limits": { | ||
"$ref": "List.LimitsReturned", | |||
"$ref": "List.LimitsReturned" | "required": true | ||
}, | }, | ||
"songs": { | "songs": { | ||
Line 54: | Line 191: | ||
"$ref": "Audio.Details.Song" | "$ref": "Audio.Details.Song" | ||
}, | }, | ||
"type": "array" | "type": "array" | ||
} | } | ||
} | } | ||
} | } | ||
}</syntaxhighlight>}} | }</syntaxhighlight>}} |
Latest revision as of 12:17, 10 July 2018
Retrieve all songs from specified album, artist or genre
Permissions:
- ReadData
Parameters:
- [ Audio.Fields.Song properties ]
- [ List.Limits limits ]
- [ List.Sort sort ]
- [ mixed filter ]
- [ boolean includesingles = true ]
- [ boolean allroles = false ] Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.
Returns:
Type: object
Properties:
- List.LimitsReturned limits
- [ Audio.Details.Song[] songs ]
JSON Schema Description |
---|
{ "description": "Retrieve all songs from specified album, artist or genre", "permission": "ReadData", "type": "method", "params": [ { "$ref": "Audio.Fields.Song", "name": "properties" }, { "$ref": "List.Limits", "name": "limits" }, { "$ref": "List.Sort", "name": "sort" }, { "type": [ { "additionalProperties": false, "properties": { "genreid": { "$ref": "Library.Id", "description": "Song genre. Filter for existance of songs with this genre", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "genre": { "description": "Song genre. Filter for existance of songs with this genre", "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artistid": { "$ref": "Library.Id", "required": true }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "roleid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "artist": { "minLength": 1, "required": true, "type": "string" }, "role": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "albumid": { "$ref": "Library.Id", "required": true } }, "type": "object" }, { "additionalProperties": false, "properties": { "album": { "minLength": 1, "required": true, "type": "string" } }, "type": "object" }, { "$ref": "List.Filter.Songs" } ], "name": "filter" }, { "default": "true", "type": "boolean", "name": "includesingles" }, { "default": "false", "description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.", "type": "boolean", "name": "allroles" } ], "returns": { "type": "object", "properties": { "limits": { "$ref": "List.LimitsReturned", "required": true }, "songs": { "items": { "$ref": "Audio.Details.Song" }, "type": "array" } } } } |