REST API

ComicStreamer REST API

ComicStreamer is in early alpha stages, API subject to change!

/dbinfo
    - return some values about the database (ID, created date, last modified)

/version
    - app version info

/deleted
    - list of comic IDs that have been removed from the DB
        args:
            since
                - date of the earliest returned value

/comic/{id}
    - info about specific comic

/comic/{id}/page/{pagenum}
    - return specific page image of specific comic
        args:
            max_height
                - will resize image

/comic/{id}/page/{pagenum}/bookmark
    - sets the time of last access and last page read for the comic.
        client would fetch this for each page turn
        if {pagenum} is "clear"  clears bookmark for the given book

/comic/{id}/thumbnail
    - return specific small cover image of specific comic

/comic/{id}/file
    - return entire specific comic file

/comiclist
    - return list of comics info.  with no args, returns entire list
            args:
                series
                    filter by series (wildcard accepted)
                title
                    filter by issue title (wildcard accepted)
                path
                    filter by file path (wildcard accepted)
                character
                    filter by character (wildcard accepted)
                team
                    filter by team (wildcard accepted)
                location
                    filter by location (wildcard accepted)
                storyarc
                    filter by story arc (wildcard accepted)
                genre
                    filter by genre (wildcard accepted)
                tag
                    filter by generic tag (wildcard accepted)
                volume
                    filter by volume (wildcard accepted)
                publisher
                    filter by publisher (wildcard accepted)
                credit
                    filter by creator credit (wildcard accepted)
                    should be a name optionally followed by a ":" and the role. e.g:
                        credit=Brian*Vaughn
                        credit=*Buscema:inker
                start_date
                    the beginning publication date of the resultset
                end_date
                    the end publication date of the resultset
                added_since
                    only comics added the to database since given date
                lastread_since
                    only comics that have been read since given date
					(Set this value to something like "1970" to filter out unread comics)
                per_page
                    max amount of results to be returned
                offset
                    the starting offset of the query resultset
                order
                    order by given key.  if key has "-" prepended, order descending
                    available sort keys:
                        series, title, volume, issue, publisher, path, modified, added, lastread, date

            wildcard character is * (asterisk)

            date format is "YYYY-MM-DD hh:mm:ss", where the right-most (most granular) portions may be omitted

/folders/[path]
	- Return list of folders  with names and access URLS), and list of comics in the specific folder
      Without a path, returns just the top level folders
      
/entities/[{key1}/[{val1}/[{key2}/[{val2}/....{keyN}/[{valN}]]]]]
    TBD