/api/create/<input_type>/<output_type>/ (POST)

Create HSSP or DSSP data. Adds a job to a queue to produce the data in the given output_type format from the data passed. The pdb_id and sequence must be set in a form parameter called 'data'

Parameters:

input_type

Either 'pdb_id', 'pdb_redo_id', 'pdb_file' or 'sequence'.

output_type

Either 'hssp_hssp', 'hssp_stockholm', 'hg_hssp', or 'dssp'.

Returns:

The id of the job.

---

/api/result/<input_type>/<output_type>/<id>/ (GET)

Get the result of a previous job submission.

Parameters:

input_type

Either 'pdb_id', 'pdb_redo_id', 'pdb_file' or 'sequence'.

output_type

Either 'hssp_hssp', 'hssp_stockholm', or 'dssp'.

id

The id returned by a call to the create method.

Returns:

The output of the job. If the job status is not SUCCESS, this method returns an error.

---

/api/status/<input_type>/<output_type>/<id>/ (GET)

Get the status of a previous job submission.

Parameters:

input_type

Either 'pdb_id', 'pdb_redo_id', 'pdb_file' or 'sequence'.

output_type

Either 'hssp_hssp', 'hssp_stockholm', or 'dssp'.

id

The id returned by a call to the create method.

Returns:

Either PENDING, STARTED, SUCCESS, FAILURE, RETRY, or REVOKED.

---