EMBL-EBI Web Services

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== FingerPRINTScan (REST) ======

===== Description =====

FingerPRINTScan((Attwood TK, Croning MD, Flower DR, Lewis AP, Mabey JE, Scordis P, Selley JN, Wright W.(2000)\\
**PRINTS-S: the database formerly known as PRINTS.**\\
Nucleic acids research 28 (1) :225-7\\ 
PubMed: [[http://europepmc.org/abstract/MED/10592232|10592232]]\\ 
DOI: [[http://dx.doi.org/10.1093/nar/28.1.225|10.1093/nar/28.1.225]]\\ 
)) identifies the closest matching PRINTS sequence motif fingerprints in a protein sequence.

For more information see:
  * Web form: [[http://www.ebi.ac.uk/Tools/pfa/fingerprintscan/]]
  * [[.:fingerprintscan_soap|SOAP service]]

===== Important ====

We kindly ask all users of EMBL-EBI Web Services to submit tool jobs in batches of up to 25 at a time and to not submit more until the results and processing has completed for these. This enables users as well as the service maintainers to deal more easily with local and remote network outages as well as scheduled or unscheduled downtime.

Service provision happens on a fair-share basis. Overzealous usage of a particular resource will be dealt with in accordance to the [[http://www.ebi.ac.uk/about/terms-of-use|EMBL-EBI's Terms of Use]].

===== Clients =====

Sample clients are provided for a number of programming languages. For details of how to use these clients, download the client and run the program without any arguments.

^ Language ^ Download ^ Requirements ^
^ Perl | ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/perl/lwp/fingerprintscan_lwp.pl|fingerprintscan_lwp.pl]]'' | [[http://search.cpan.org/perldoc?LWP|LWP]] and [[http://search.cpan.org/perldoc?XML::Simple|XML::Simple]] |

For further details of these tool-kits and workflow platforms see our [[:tutorials:00_Contents|Guide to Web Services]].

===== Resources =====

==== parameters ====

List parameter names.

**Request**

^ URL         | http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameters/ |
^ Parameters  | //none// |

**Response**

An XML document containing a list of parameter names.

For example: http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameters/

==== parameterdetails ====

Get detailed information about a parameter.

**Request**

^ URL         | http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/$parameterId |
^ Parameters  | ''$parameterId'': the name of the parameter |

**Response**

An XML document providing details about the parameter.

For example: http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/matrix.

==== run ====

Submit a job with the specified parameters.

**Request**

^ URL         | http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/run/ ||
^ POST        | ''email''        | User e-mail address. See [[help:faq#why_do_you_need_my_e-mail_address|Why do you need my e-mail address?]] |
^             | ''title''        | An optional title for the job. |
^             | ''[[http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/matrix|matrix]]''         | The data matrix to search |
^             | ''[[http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/evalue|evalue]]''      | The Expectation value cut-off for hits during the scan |
^             | ''[[http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/distdev|distdev]]''        | Percentage distance deviation allowed between motifs |
^             | ''[[http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/resultviews|resultviews]]''        | Output result views |
^             | ''[[http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/parameterdetails/sequence|sequence]]''     | Protein sequence to analyse. The use of fasta formatted sequence is recommended. |

More detailed information about each parameter, including valid values can be obtained using the [[#parameterdetails]] resource.

**Response**

A plain text document containing the job identifier.

==== status ====

Get the status of a submitted job.

**Request**

^ URL         | http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/status/$jobId |
^ Parameters  | ''$jobId'': job identifier |

**Response**

A plain text document containing the job status.

The values for the status are:
  * ''RUNNING'': the job is currently being processed.
  * ''FINISHED'': job has finished, and the results can then be retrieved.
  * ''ERROR'': an error occurred attempting to get the job status.
  * ''FAILURE'': the job failed.
  * ''NOT_FOUND'': the job cannot be found.
Further details can be found in [[:tutorials:01_intro#jdispatcher|Synchronous and Asynchronous Access: JDispatcher]].

==== resulttypes ====

Get available result types for a finished job.

**Request**

^ URL         | http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/resulttypes/$jobId |
^ Parameters  | ''$jobId'': job identifier |

**Response**

An XML document detailing the available result types.

==== result ====

Get the job result of the specified type.

**Request**

^ URL         | http://www.ebi.ac.uk/Tools/services/rest/fingerprintscan/result/$jobId/$resultType |
^ Parameters  | ''$jobId'': job identifier |
^             | ''$resultType'': type of result to retrieve. See [[#resulttypes]]. |

**Response**

A document containing the result in the requested format. The MIME type of the returned document is set according to the format.
EMBL-EBI Web Services

EMBL-EBI

Services

Research

Training

Industry

About us
