User:Ncarthy

Retrieve all songs from specified album, artist or genre
Permissions:

• ReadData

Parameters:

1. [ Audio.Fields.Song properties ]
2. [ List.Limits limits ]
3. [ List.Sort sort ]
4. [ mixed filter ]
5. [ boolean includesingles = true ]
6. [ 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" } } } }