Decapod 0.6 Export Server Architecture

Resources

Request Type	Response / Action	Status Code
GET	Redirects to the start page for the Decapod user interface.	Success: 301

The set of all "Books" in Decapod.

Request Type	Response / Action	Status Code
DELETE, GET, POST, PUT	N/A	Error: 405

The information about a specific "Book".

Request Type	Response / Action	Status Code
DELETE	Removes a book and all its attached pages	Success: 204
GET, POST, PUT	N/A	Error: 405

The set of "pages" contained within a "book".

Request Type	Response / Action	Status Code
POST	Creates a new page and returns the URL	Success: 201
DELETE, GET, PUT	N/A	Error: 405

This will be a base url that has the parameters for the type of export appended as segments afterwards.

e.g.

Query Parameters	Description
w, width	float [0.1 - 30] cm
h, height	float [0.1 - 30] cm
dpi	integer [1 - 600]
c, color, colour	string [color, colour, grey, gray]
bit	integer [24, 16, 8, 1]

Query parameters are optional and follow the genpdf spec.

Request Type	Response / Action	Status Code
GET	Returns the status of the export and a link to the artifact if complete, in JSON format. { status: "complete", url: "http://localhost:8080/library/'bookName'/export/pdf/'bookName'.pdf" }	Success: 200
PUT	Trigger the creation of the export artifact.	Success: 202
DELETE	Removes the export artifact	Success: 204
POST	N/A	Error: 405

e.g.

possible formats include tiff, jpeg, png

Request Type	Response / Action	Status Code
GET	Returns the status of the export and a link to the artifact if complete, in JSON format. { status: "complete", url: "http://localhost:8080/library/'bookName'/export/image/'bookName'.zip" }	Success: 200
PUT	Trigger the creation of the export artifact.	Success: 202
DELETE	Removes the export artifact	Success: 204
POST	N/A	Error: 405