Proposed Decapod Dewarp Server Architecture

GET

Redirects to the start page for the Decapod Dewarp user interface.

Success: 301

DELETE, POST, PUT

N/A

Error: 405

GET

Returns the status of the uploaded zip file that contains the images for being dewarped
At success:

{
    numOfCaptures: #
}

At Error:

{
    error_code: "BAD_ZIP"
    msg: "A bad uploaded zip file"
}

Success: 200, Error: 500 or 404 if the unpacked captures dir does not exist

PUT

Upload the zip file of captures to be dewarped. Returns the same output as GET request

Success: 200, Error: 500

DELETE

Removes all of the capture files

Success: 204, Error: 500 or 409 if a dewarping is in progress

POST

N/A

Error: 405

GET

Returns the status of the upload zip file that contains the calibration data
At Error:

{
    error_code: "BAD_ZIP"
    msg: "A bad uploaded zip file"
}

Success: 200, Error: 500 or 404 if the unpacked calibration dir does not exist

PUT

Upload the zip file of the calibration data. Returns the same output as GET request

Success: 200, Error: 500

DELETE

Removes all of the calibration data

Success: 204, Error: 500

POST

N/A

Error: 405

PUT

Launch the color picker window

Success: 200, Error: 500

GET, POST, DELETE

N/A

Error: 405

GET

Returns the status of the dewarping.
If the dewarping is in progress,

{
    status: "in progress",
    currentCapture: #,
    numOfCaptures: #
}

If the dewarping completes,

{
    status: "complete",
    url: "http://localhost:8082/data/dewarped.zip"
}

At error,

{
    status: "error"
}

Success: 200, Error: 500

PUT

Trigger the dewarp action

Success: 202, Error: 409

DELETE

Removes all dewarp data

Success: 204, Error: 409

POST

N/A

Error: 405