pub struct GetSongsQuery {
pub song_category_ids: Option<Vec<i64>>,
pub ids: Option<Vec<i64>>,
pub practice: Option<bool>,
pub key_of_arrangement: Option<String>,
pub name: Option<String>,
pub query: Option<String>,
pub include: Option<Vec<String>>,
pub limit: Option<i64>,
}Expand description
Query parameters for GET /songs.
Fields§
§song_category_ids: Option<Vec<i64>>Restrict to these song category IDs, intersected with permitted categories.
ids: Option<Vec<i64>>Restrict to these song IDs. An empty array matches no songs.
practice: Option<bool>Filter the rehearsal flag: true selects songs marked for practice, false selects those not marked.
key_of_arrangement: Option<String>Filter by arrangement key. Song plus all its arrangements are returned if one arrangement meets the filter criterion.
Allowed values: A, A#, A#m, Ab, Abm, Am, B, B#, B#m, Bb, Bbm, Bm, C, C#, C#m, Cb, Cbm, Cm, D, D#, D#m, Db, Dbm, Dm, E, E#, E#m, Eb, Ebm, Em, ….
name: Option<String>Substring filter on the song title, combined with query and the other filters.
query: Option<String>Substring search in either title or author, combined with name and the other filters.
include: Option<Vec<String>>Optional enrichments. Use include=tags for tags, or include[]=tags&include[]=arrangements for multiple values. Comma-separated values are not supported. Arrangements are already returned without this option by the current API, but this will change in a future release. Omitted requests no enrichment.
Allowed values: arrangements, tags.
limit: Option<i64>Number of songs per page, from 1 to 200.