listAnnualSeries

[API] listAnnualSeries

action: Returns listing of Annuals present within watchlist (with annual integration)

**Note** will return all annuals attached to a series, whether the files are present or not 
         see optional arguement: show_downloaded for filtering

restrictions:

• argument provided will restrict the data-set.
• annual integration must be enabled for this API call to return results.

argument required (only one may be chosen):

• list_issues --> return annuals listed as individual items

• group_series --> return annuals grouped by (parent) series comicid

further allowed arguments

• show_downloaded --> filter annuals by if they are physically present

response Type: json

example calls (with responses):

http://localhost:8090/api?cmd=listAnnualSeries&list_issues&apikey=<apikey>

 {
  "success": true, 
  "data": [{"series": "Aquaman", "annualname": "Aquaman Annual", "annualcomicid": "106491", "issueid": 643006, "filename": "aquaman annual - crownspire 001 (2018).cbz", "issuenumber": "1", "comicid": 91738}, {"series": "Aquaman", "annualname": "Aquaman Annual", "annualcomicid": "106491", "issueid": 723822, "filename": null, "issuenumber": "2", "comicid": 91738}, {"series": "Grayson", "annualname": "Grayson Annual", "annualcomicid": "78997", "issueid": 474563, "filename": "Grayson Annual 001 (2014).cbz", "issuenumber": "1", "comicid": 75536}]}

http://localhost:8090/api?cmd=regenerateCovers&list_issues&show_downloaded&apikey=<apikey>

{"success": true, 
 "data": [{"series": "Aquaman", "annualname": "Aquaman Annual", "annualcomicid": "106491", "issueid": 643006, "filename": "aquaman annual - crownspire 001 (2018).cbz", "issuenumber": "1", "comicid": 91738}, {"series": "Grayson", "annualname": "Grayson Annual", "annualcomicid": "78997", "issueid": 474563, "filename": "Grayson Annual 001 (2014).cbz", "issuenumber": "1", "comicid": 75536}]

http://localhost:8090/api?cmd=listAnnualSeries&group_series&show_downloaded&apikey=<apikey>

{
{"success": true, 
 "data": {"91738": [{"series": "Aquaman", "annualname": "Aquaman Annual", "annualcomicid": "106491", "issueid": 643006, "filename": "aquaman annual - crownspire 001 (2018).cbz", "issuenumber": "1"}], "75536": [{"series": "Grayson", "annualname": "Grayson Annual", "annualcomicid": "78997", "issueid": 474563, "filename": "Grayson Annual 001 (2014).cbz", "issuenumber": "1"}]}
}

http://localhost:8090/api?cmd=listAnnualSeries&group_series&apikey=<apikey>

{"success": true, 
 "data": {"91738": [{"series": "Aquaman", "annualname": "Aquaman Annual", "annualcomicid": "106491", "issueid": 643006, "filename": "aquaman annual - crownspire 001 (2018).cbz", "issuenumber": "1"}, {"series": "Aquaman", "annualname": "Aquaman Annual", "annualcomicid": "106491", "issueid": 723822, "filename": null, "issuenumber": "2"}], "75536": [{"series": "Grayson", "annualname": "Grayson Annual", "annualcomicid": "78997", "issueid": 474563, "filename": "Grayson Annual 001 (2014).cbz", "issuenumber": "1"}]}