ZBH - Center for Bioinformatics

 Create EDIA Job

  Creates a new EDIA job passing json data in body and returns json data about the location of the results.

• URL

  https://proteins.plus/api/edia_rest

• Method:

  POST

• URL Params

  None

• Data Params

  Required:
  

  
  edia=[hash] - Contains the following parameters:
  
  pdbCode=[string] - Select a structure form the Protein Data Bank (PDB) via its PDB code.
        

• Success Response:

  • Code: 200
    Content: { status_code: 200, location: "", message: "Job already exists" }

  OR

  • Code: 202
    Content: { status_code: 202, message: "The job will be created in the specified location", location: "" }

  OR

  • Code: 202
    Content: { status_code: 202, message: "Job exists and is still in 'processing' state", location: "" }



• Error Response:

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Parameter values must be strings" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Invalid number of parameters or incorrect parameter name" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Invalid pdbCode" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "No electron density file available." }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Error in EDIA calculation. Please try again later." }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Job saving error" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Job loading error" }

  OR

  • Code: 429 TOO MANY REQUESTS
    Content: { status_code: 429, error: "Too Many Requests", message: "Throttle limit reached. Retry later." }



• Sample Data:

  
              {"edia": {
              "pdbCode":"1kzk"}}
          

  Sample Call (curl):

  
  curl -d '{"edia":{ "pdbCode":"1kzk"}}' -H "Accept: application/json" -H "Content-Type: application/json" -X POST https://proteins.plus/api/edia_rest
        

 Show EDIA Job

  Returns json data about a single EDIA job.

• URL

  https://proteins.plus/api/edia_rest/:id

• Method:

  GET

• URL Params

  Required:

  id=[string]

• Data Params

  None

• Success Response:

  • Code: 200
    Content: { status_code: 200, annotated_pdb: "", structure_scores: "", atom_scores: "" }

  OR

  • Code: 202
    Content: { status_code: 202, message: "Job exists and is still in 'processing' state", location: "" }



• Error Response:

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Job loading error" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "No electron density file available." }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Error in EDIA calculation. Please try again later." }

  OR

  • Code: 404 NOT FOUND
    Content: { status_code: 404, error: "Not Found", message: "Invalid ID" }

  OR

  • Code: 429 TOO MANY REQUESTS
    Content: { status_code: 429, error: "Too Many Requests", message: "Throttle limit reached. Retry later." }
  
  

• Sample Call (curl):

  
  curl https://proteins.plus/api/edia_rest/ixenp5kLNHohrRbj56fbt4dd
          

• Output:

  
  annotated_pdb - PDB-file with annotated EDIA-score (electron density fit) per atom
  
  structure_scores - electron density scores for residues and molecules (CSV-table, residues are rows with "Structure specifier" = "r", molecules are rows with "Structure specifier" = "m")
  
  atom_scores - electron density scores for individual atoms (CSV-table, atoms belonging to residues are rows with "Structure specifier" = "r", to molecules are rows with "Structure specifier" = "m", to water are rows with "Structure specifier" = "w")