Proposed Decapod Camera Control Server Architecture

Proposed Decapod Camera Control Server Architecture

Resources

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

GET

Redirects to the start page for the Decapod user interface.

Success: 301

DELETE, POST, PUT

N/A

Error: 405

The set of all cameras connected to the server.

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

GET

Returns info about all connected cameras, in JSON format.

{ cameras: [ { model: "Model Name", port: "connection port", resolution: 14.6, captureFormats: "formats" capabilities: "camera capabilities" } ] }

Success: 200

DELETE, POST, PUT

N/A

Error: 405

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

GET

Information about number of captures in JSON format

{ index: #, // unique index for captures firstCaptureIndex: #, // index of first existing capture lastCaptureIndex: #, // index of last existing capture totalCaptures: # // total number of existing captures }

Success: 200

DELETE, POST, PUT

N/A

Error: 405

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

GET

The conventional capture page.

Success: 200

DELETE, POST, PUT

N/A

Error: 405

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

GET

Information about whether the cameras meet all criteria for captures

{ "statusCode": "", "message": "" }

Success: 200

DELETE, POST, PUT

N/A

Error: 405

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

GET

URLS to the zip in JSON format

{ url: "http://localhost:8081/data/conventional/export/capture.zip" }

success: 200

POST

trigger a capture

{ index: #, totalCaptures: #, captures: [url, url] }

success: 202

DELETE

remove all capture data

success: 204

PUT

N/A

Error: 405

Request Type

Response / Action

Status Code

Request Type

Response / Action

Status Code

DELETE

remove all captured images

success: 204

GET, POST, PUT

N/A

Error: 405