mirror/Lidarr
1
0
Fork 0
mirror of https://github.com/lidarr/Lidarr synced 2024-12-23 00:03:05 +00:00
Code Issues Releases Wiki Activity

Initial

Qstick 2017-07-09 21:49:53 -04:00
parent 200a286b6a
commit ffc0740f1e
1 changed files with 84 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
Calendar.md Normal file

@ -0,0 +1,84 @@
**Endpoint: "/calendar"**
## GET ##
##### Summary #####
Gets upcoming albums, if start/end are not supplied albums released today and tomorrow will be returned
##### Parameters ######
Required:
*None*
Optional:
`start (date)`
`end (date)`
##### Example #####
To get a list of all items appearing on the Lidarr calendar between July 26, 2017 and July 27, 2017, you could call:
http://lidarr.ip:port/api/calendar?apikey=YourApiKey&start=2017-07-26&end=2017-07-27
Note that you need to replace 'lidarr.ip' and 'port' with the IP address of the machine running Lidarr and the port it's listening on, in addition to 'YourApiKey' being replaced with the API key of your Lidarr installation.
##### Returns JsonArray ######
````JSON
[
{
title: "truANT",
artistId: 2,
monitored: true,
path: "C:\Test\Alien Ant Farm\truANT (2003)",
profileId: 2,
releaseDate: "2017-08-19T00:00:00Z",
artist: {
name: "Alien Ant Farm",
foreignArtistId: "aaaaa_aaaaa_aaaa",
tadbId: 0,
discogsId: 0,
overview: "Alien Ant Farm is an American rock band that formed in Riverside, California, United States, in 1996. Their name comes from an idea original guitarist Terry Corso had about aliens and the Earth: "it was just my daydream about our planet being seeded by entities from other dimensions."[1] They have released five studio albums, and have sold over 5 million units worldwide. The band is best known for their Michael Jackson cover "Smooth Criminal."",
images: [ ],
members: [ ],
path: "C:\Test\Alien Ant Farm",
profileId: 2,
albumFolder: true,
monitored: true,
genres: [
"alternative metal",
"alternative rock",
"funk metal",
"industrial metal",
"nu metal",
"pop punk",
"pop rock",
"post-grunge",
"rap metal",
"rap rock",
"rock"
],
cleanName: "alienantfarm",
tags: [ ],
added: "2017-07-08T05:27:16.5290674Z",
addOptions: {
searchForMissingTracks: false,
ignoreTracksWithFiles: true,
ignoreTracksWithoutFiles: false,
monitored: false
},
nameSlug: "alienantfarm",
id: 2
},
images: [ ],
statistics: {
trackFileCount: 0,
trackCount: 12,
totalTrackCount: 0,
sizeOnDisk: 0,
percentOfTracks: 0
},
id: 4
}
]
````