How to - include an iHOP summary for each gene/protein in your web site

Calls to the URLs below will retrieve XML wrapped HTML-fragments containing the 3 most informative sentences for the query gene. Although these documents are complete and valid HTML document, it is recommended to parse the XML and to integrate selected HTML fragments into your web pages.

Query url:
http:///UniPub/iHOP/ws/top/in?dbrefs=&focus=

Parameters:
1) dbrefs = String|String,String|String,...
DB-ID/value pairs, e.g. NCBI_GENE__ID|12345 or NCBI_GENE__ID|852088,UNIPROT__AC|P06782

Click here for a list of all accepted accession numbers. (Please that only NCBI_GENE__ID will be recognized for all genes. The next best accession number type is UNIPROT__AC. If you do not dispose over these accession numbers you can use a combination of different keys to retrieve a reasonable recall.)

2) focus = IHOP,GISMO
Defines the type of information to be retrieved. Choose 'IHOP' sentences of interactions of a gene and 'GISMO' for sentence definitions of a gene.

Example:
http:///UniPub/iHOP/ws/top/in?dbrefs=NCBI_GENE__ID|852088&focus=GISMO

Result:

a) If the requested gene could be identified correctly and information is available in iHOP:
<iHOP>
  <iHOP_SCRIPT>Default implementation of the ihop(url) function.</iHOP_SCRIPT>
  ...
  <TOP>
  ...
   <iHOP_STYLE>iHOP CSS style guidelines (optional)</iHOP_STYLE>
   ...
   <iHOP_SCRIPT>iHOP default JavaScript for the functionality of the links in the abstract.</iHOP_SCRIPT>
   ...
   <LOGO>HTML code to include the iHOP logo. Please give credit to the iHOP project.</LOGO>
   ...
   <CONTENT>The three most informative sentences (autonomous HTML fragment)</CONTENT>
   ...
  </TOP>
</iHOP>

HTML fragments wrapped in <LOGO> and <CONTENT> are autonomous, thus they do not depend on external CSS-styles or JavaScript functions.
However, to provide you control over the way links to iHOP work (e.g. popup windows, etc), a function "ihop(url)" is called upon user clicks on highlighted items (e.g. genes or proteins), if such a function is defined. The only parameter for the function is the URL pointing to a specific iHOP resource. The minimal implementation of this function is: "function ihop(url) { location.href=url; return false; } "
A default implementation comes with the result and is wrapped in the <iHOP_SCRIPT> tag.

Click here for a sample.

b) If the requested gene could not be identified or if no information is available:
<iHOP>
  <STATUS>
   <CODE>204</CODE> <REASONING>No content</REASONING>
  </STATUS>
</iHOP>

Click here for a sample.

c) If the query is ambigous and corresponds to more than one gene:
<iHOP>
  <STATUS>
   <CODE>409</CODE> <REASONING>Conflict</REASONING>
  </STATUS>
</iHOP>

Click here for a sample.

d) If an error occurred:
<iHOP>
  <STATUS>
   <CODE>500</CODE> <REASONING>Internal Server Error</REASONING>
  </STATUS>
</iHOP>