HitKeeper

Service version1.0

Contributor URLhttp://myhits.isb-sib.ch/

WSDL URLhttp://myhits.isb-sib.ch/hk/soapserv.wsdl PASSED

REST collection URLhttp://myhits.isb-sib.ch/hk/resthelp.html

HitKeeper allows for fully automatic handling of multiple databases on a large scale, calculation of 'hits', and querying. It is the database engine behind the MyHits Web site.

A description of the WSDL service:

soapserv

Namespace: http://myhits.isb-sib.ch/HitKeeperWebService

Port: soapserv
Location: http://myhits.isb-sib.ch/cgi-bin/hk/soapserv
Protocol: http://schemas.xmlsoap.org/soap/http
Default Style: document

Operations

connect

Return the session_id string to be used in other methods. Do not set username and password to login anonymously.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#connect
Input Message: connectRequestMessage
- parameters
  - connect type
    - username type string
    - password type string
Output Message: connectResponseMessage
- parameters
  - connectResponse type
    - session_id type string
    - warning type warningArray
      - item type string

disconnect

Terminate the current session.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#disconnect
Input Message: disconnectRequestMessage
- parameters
  - disconnect type
    - session_id type string
Output Message: disconnectResponseMessage
- parameters
  - disconnectResponse type
    - warning type warningArray
      - item type string

seq_list

Summary information about all sequence databases.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#seq_list
Input Message: seq_listRequestMessage
- parameters
  - seq_list type
    - session_id type string
    - seq_type type seq_typeList
      - item type string
Output Message: seq_listResponseMessage
- parameters
  - seq_listResponse type
    - result type seqSummaryArray
      - seqSummaryRecord type seqSummaryRecord
        seq_source type string
        seq_type type string
        pipeline type string
        seq_version type int
        description type string
    - warning type warningArray
      - item type string

mot_list

Summary information about all motif databases.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#mot_list
Input Message: mot_listRequestMessage
- parameters
  - mot_list type
    - session_id type string
    - mot_type type mot_typeList
      - item type string
Output Message: mot_listResponseMessage
- parameters
  - mot_listResponse type
    - result type motSummaryArray
      - motSummaryRecord type motSummaryRecord
        mot_source type string
        mot_type type string
        pipeline type string
        mot_version type int
        description type string
    - warning type warningArray
      - item type string

cla_list

Summary information about all classification databases.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#cla_list
Input Message: cla_listRequestMessage
- parameters
  - cla_list type
    - session_id type string
    - cla_type type cla_typeList
      - item type string
Output Message: cla_listResponseMessage
- parameters
  - cla_listResponse type
    - result type claSummaryArray
      - claSummaryRecord type claSummaryRecord
        cla_source type string
        cla_type type string
        pipeline type string
        cla_version type int
        description type string
    - warning type warningArray
      - item type string

hit_list

Summary information about all computed hit lists (sequence vs motif)

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hit_list
Input Message: hit_listRequestMessage
- parameters
  - hit_list type
    - session_id type string
Output Message: hit_listResponseMessage
- parameters
  - hit_listResponse type
    - result type hitSummaryArray
      - hitSummaryRecord type hitSummaryRecord
        seq_source type string
        seq_type type string
        seq_version type int
        mot_source type string
        mot_type type string
        mot_version type int
        status type string
    - warning type warningArray
      - item type string

hat_list

Summary information about all 'hat' lists (sequence vs classification)

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hat_list
Input Message: hat_listRequestMessage
- parameters
  - hat_list type
    - session_id type string
Output Message: hat_listResponseMessage
- parameters
  - hat_listResponse type
    - result type hatSummaryArray
      - hatSummaryRecord type hatSummaryRecord
        seq_source type string
        seq_type type string
        seq_version type int
        cla_source type string
        cla_type type string
        cla_version type int
        status type string
    - warning type warningArray
      - item type string

hot_list

Summary information about all 'hot' lists (motif vs classification)

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hot_list
Input Message: hot_listRequestMessage
- parameters
  - hot_list type
    - session_id type string
Output Message: hot_listResponseMessage
- parameters
  - hot_listResponse type
    - result type hotSummaryArray
      - hotSummaryRecord type hotSummaryRecord
        mot_source type string
        mot_type type string
        mot_version type int
        cla_source type string
        cla_type type string
        cla_version type int
        status type string
    - warning type warningArray
      - item type string

seq_info

Miscellaneous information about sequence databases.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#seq_info
Input Message: seq_infoRequestMessage
- parameters
  - seq_info type
    - session_id type string
    - seq_source type seq_sourceList
      - item type string
Output Message: seq_infoResponseMessage
- parameters
  - seq_infoResponse type
    - result type seqInfoArray
      - seqInfoRecord type seqInfoRecord
        seq_source type string
        seq_type type string
        rank type int
        description type string
        upload type string
        watch type string
        cmd type string
        limit_entries type int
        limit_residues type int
        archive type int
        can_read type stringArray
        item type string
        seq_pipeline_info type pipelineArray
        pipelineRecord type pipelineRecord
        version type int
        status type string
        time_stamp type dateTime
        count type int
        length type int
    - warning type warningArray
      - item type string

mot_info

Miscellaneous information about motif databases.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#mot_info
Input Message: mot_infoRequestMessage
- parameters
  - mot_info type
    - session_id type string
    - mot_source type mot_sourceList
      - item type string
Output Message: mot_infoResponseMessage
- parameters
  - mot_infoResponse type
    - result type motInfoArray
      - motInfoRecord type motInfoRecord
        mot_source type string
        mot_type type string
        rank type int
        description type string
        upload type string
        watch type string
        cmd type string
        limit_entries type int
        limit_residues type int
        archive type int
        can_read type stringArray
        item type string
        mot_pipeline_info type pipelineArray
        pipelineRecord type pipelineRecord
        version type int
        status type string
        time_stamp type dateTime
        count type int
        length type int
    - warning type warningArray
      - item type string

cla_info

Miscellaneous information about classification databases.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#cla_info
Input Message: cla_infoRequestMessage
- parameters
  - cla_info type
    - session_id type string
    - cla_source type cla_sourceList
      - item type string
Output Message: cla_infoResponseMessage
- parameters
  - cla_infoResponse type
    - result type claInfoArray
      - claInfoRecord type claInfoRecord
        cla_source type string
        cla_type type string
        rank type int
        description type string
        upload type string
        watch type string
        cmd type string
        limit_entries type int
        limit_residues type int
        archive type int
        can_read type stringArray
        item type string
        cla_pipeline_info type pipelineArray
        pipelineRecord type pipelineRecord
        version type int
        status type string
        time_stamp type dateTime
        count type int
        length type int
    - warning type warningArray
      - item type string

hit_info

Miscellaneous information about hit lists (sequence vs motif).

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hit_info
Input Message: hit_infoRequestMessage
- parameters
  - hit_info type
    - session_id type string
    - seq_source type seq_sourceList
      - item type string
    - mot_source type mot_sourceList
      - item type string
Output Message: hit_infoResponseMessage
- parameters
  - hit_infoResponse type
    - result type hitInfoArray
      - hitInfoRecord type hitInfoRecord
        seq_source type string
        seq_type type string
        seq_desc type string
        mot_source type string
        mot_type type string
        mot_desc type string
        status type string
        date_time type dateTime
        hit_total type int
        signif_stat type signifStatArray
        signifStatRecord type signifStatRecord
        freq type int
        signif type string
    - warning type warningArray
      - item type string

hat_info

Miscellaneous information about 'hat' lists (sequence vs classification).

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hat_info
Input Message: hat_infoRequestMessage
- parameters
  - hat_info type
    - session_id type string
    - seq_source type seq_sourceList
      - item type string
    - cla_source type cla_sourceList
      - item type string
Output Message: hat_infoResponseMessage
- parameters
  - hat_infoResponse type
    - result type hatInfoArray
      - hatInfoRecord type hatInfoRecord
        seq_source type string
        seq_type type string
        seq_desc type string
        cla_source type string
        cla_type type string
        cla_desc type string
        status type string
        date_time type dateTime
        hat_total type int
    - warning type warningArray
      - item type string

hot_info

Miscellaneous information about 'hat' lists (motif vs classification).

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hot_info
Input Message: hot_infoRequestMessage
- parameters
  - hot_info type
    - session_id type string
    - mot_source type mot_sourceList
      - item type string
    - cla_source type cla_sourceList
      - item type string
Output Message: hot_infoResponseMessage
- parameters
  - hot_infoResponse type
    - result type hotInfoArray
      - hotInfoRecord type hotInfoRecord
        mot_source type string
        mot_type type string
        mot_desc type string
        cla_source type string
        cla_type type string
        cla_desc type string
        status type string
        date_time type dateTime
        hot_total type int
    - warning type warningArray
      - item type string

seq_parse_name

Internal routine not (yet) really useful.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#seq_parse_name
Input Message: seq_parse_nameRequestMessage
- parameters
  - seq_parse_name type
    - session_id type string
    - seq_name type seq_nameList
      - item type string
    - opt_ref type string
Output Message: seq_parse_nameResponseMessage
- parameters
  - seq_parse_nameResponse type
    - result type string
    - warning type warningArray
      - item type string

mot_parse_name

Internal routine no (yet) really useful

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#mot_parse_name
Input Message: mot_parse_nameRequestMessage
- parameters
  - mot_parse_name type
    - session_id type string
    - mot_name type mot_nameList
      - item type string
    - opt_ref type string
Output Message: mot_parse_nameResponseMessage
- parameters
  - mot_parse_nameResponse type
    - result type string
    - warning type warningArray
      - item type string

cla_parse_name

Internal routine not (yet) really useful.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#cla_parse_name
Input Message: cla_parse_nameRequestMessage
- parameters
  - cla_parse_name type
    - session_id type string
    - cla_name type cla_nameList
      - item type string
    - opt_ref type string
Output Message: cla_parse_nameResponseMessage
- parameters
  - cla_parse_nameResponse type
    - result type string
    - warning type warningArray
      - item type string

seq_query

For querying the sequences. Refer to http://http://myhits.isb-sib.ch/hk/seq_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#seq_query
Input Message: seq_queryRequestMessage
- parameters
  - seq_query type
    - session_id type string
    - seq_source type seq_sourceList
      - item type string
    - seq_name type seq_nameList
      - item type string
    - and_seq_name type seq_nameList
      - item type string
    - not_seq_name type seq_nameList
      - item type string
    - desc_text type stringList
      - item type string
    - min_score type float
    - prop_key type stringList
      - item type string
    - prop_value type stringList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: seq_queryResponseMessage
- parameters
  - seq_queryResponse type
    - result type seq_queryArray
      - seq_queryRecord type seq_queryRecord
        seq_name type string
        score type float
        desc type string
    - warning type warningArray
      - item type string

mot_query

For querying the motifs. Refer to http://http://myhits.isb-sib.ch/hk/mom_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#mot_query
Input Message: mot_queryRequestMessage
- parameters
  - mot_query type
    - session_id type string
    - mot_source type mot_sourceList
      - item type string
    - mot_name type mot_nameList
      - item type string
    - and_mot_name type mot_nameList
      - item type string
    - not_mot_name type mot_nameList
      - item type string
    - desc_text type stringList
      - item type string
    - min_score type float
    - prop_key type stringList
      - item type string
    - prop_value type stringList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: mot_queryResponseMessage
- parameters
  - mot_queryResponse type
    - result type mot_queryArray
      - mot_queryRecord type mot_queryRecord
        mot_name type string
        score type float
        desc type string
    - warning type warningArray
      - item type string

cla_query

For querying the classifications. Refer to http://http://myhits.isb-sib.ch/hk/cla_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#cla_query
Input Message: cla_queryRequestMessage
- parameters
  - cla_query type
    - session_id type string
    - cla_source type cla_sourceList
      - item type string
    - cla_name type cla_nameList
      - item type string
    - and_cla_name type cla_nameList
      - item type string
    - not_cla_name type cla_nameList
      - item type string
    - desc_text type stringList
      - item type string
    - min_score type float
    - prop_key type stringList
      - item type string
    - prop_value type stringList
      - item type string
    - ancestor type cla_nameList
      - item type string
    - parent type cla_nameList
      - item type string
    - descendant type cla_nameList
      - item type string
    - child type cla_nameList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: cla_queryResponseMessage
- parameters
  - cla_queryResponse type
    - result type cla_queryArray
      - cla_queryRecord type cla_queryRecord
        cla_name type string
        score type float
        desc type string
    - warning type warningArray
      - item type string

hit_query

For querying the hit lists (sequence vs motif). Refer to http://http://myhits.isb-sib.ch/hk/hit_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hit_query
Input Message: hit_queryRequestMessage
- parameters
  - hit_query type
    - session_id type string
    - seq_source type seq_sourceList
      - item type string
    - seq_name type seq_nameList
      - item type string
    - and_seq_name type seq_nameList
      - item type string
    - not_seq_name type seq_nameList
      - item type string
    - mot_source type mot_sourceList
      - item type string
    - mot_name type mot_nameList
      - item type string
    - and_mot_name type mot_nameList
      - item type string
    - not_mot_name type mot_nameList
      - item type string
    - hit_name type hit_nameList
      - item type string
    - and_hit_name type hit_nameList
      - item type string
    - not_hit_name type hit_nameList
      - item type string
    - signif type signifList
      - item type string
    - not_signif type signifList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: hit_queryResponseMessage
- parameters
  - hit_queryResponse type
    - result type hit_queryArray
      - hit_queryRecord type hit_queryRecord
        seq_name type string
        seqfrom type int
        seqto type int
        signif type string
        mot_name type string
        comment type string
    - warning type warningArray
      - item type string

hat_query

For querying the 'hat' lists (sequence vs classification). Refer to http://http://myhits.isb-sib.ch/hk/hat_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hat_query
Input Message: hat_queryRequestMessage
- parameters
  - hat_query type
    - session_id type string
    - seq_source type seq_sourceList
      - item type string
    - seq_name type seq_nameList
      - item type string
    - and_seq_name type seq_nameList
      - item type string
    - not_seq_name type seq_nameList
      - item type string
    - cla_source type cla_sourceList
      - item type string
    - cla_name type cla_nameList
      - item type string
    - and_cla_name type cla_nameList
      - item type string
    - not_cla_name type cla_nameList
      - item type string
    - hat_name type hit_nameList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: hat_queryResponseMessage
- parameters
  - hat_queryResponse type
    - result type hat_queryArray
      - hat_queryRecord type hat_queryRecord
        seq_name type string
        mot_name type string
    - warning type warningArray
      - item type string

hot_query

For querying the 'hot' lists (motif vs classification). Refer to http://http://myhits.isb-sib.ch/hk/hot_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#hot_query
Input Message: hot_queryRequestMessage
- parameters
  - hot_query type
    - session_id type string
    - mot_source type mot_sourceList
      - item type string
    - mot_name type mot_nameList
      - item type string
    - and_mot_name type mot_nameList
      - item type string
    - not_mot_name type mot_nameList
      - item type string
    - cla_source type cla_sourceList
      - item type string
    - cla_name type cla_nameList
      - item type string
    - and_cla_name type cla_nameList
      - item type string
    - not_cla_name type cla_nameList
      - item type string
    - hot_name type hit_nameList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: hot_queryResponseMessage
- parameters
  - hot_queryResponse type
    - result type hot_queryArray
      - hot_queryRecord type hot_queryRecord
        mot_name type string
        cla_name type string
    - warning type warningArray
      - item type string

mom_query

Advanced query of the list of hits. Refer to http://http://myhits.isb-sib.ch/hk/mom_query.html for details.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#mom_query
Input Message: mom_queryRequestMessage
- parameters
  - mom_query type
    - session_id type string
    - metamotif type string
    - seq_source type seq_sourceList
      - item type string
    - seq_name type seq_nameList
      - item type string
    - not_seq_name type seq_nameList
      - item type string
    - mot_source type mot_sourceList
      - item type string
    - mot_name type mot_nameList
      - item type string
    - not_mot_name type mot_nameList
      - item type string
    - signif type signifList
      - item type string
    - not_signif type signifList
      - item type string
    - opt_lim type int
    - opt_ref type string
Output Message: mom_queryResponseMessage
- parameters
  - mom_queryResponse type
    - result type hit_queryArray
      - hit_queryRecord type hit_queryRecord
        seq_name type string
        seqfrom type int
        seqto type int
        signif type string
        mot_name type string
        comment type string
    - warning type warningArray
      - item type string

seq_fetch_name

Return the non-redundant list of sequence names.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#seq_fetch_name
Input Message: seq_fetch_nameRequestMessage
- parameters
  - seq_fetch_name type
    - session_id type string
    - seq_name type seq_nameList
      - item type string
    - opt_lim type int
Output Message: seq_fetch_nameResponseMessage
- parameters
  - seq_fetch_nameResponse type
    - result type seq_nameArray
      - item type string
    - warning type warningArray
      - item type string

mot_fetch_name

Return the non-redundant list of motif names.

SOAP Action: http://myhits.isb-sib.ch/HitKeeperWebService#mot_fetch_name
Input Message: mot_fetch_nameRequestMessage
- parameters
  - mot_fetch_name type
    - session_id type string
    - mot_name type mot_nameList
      - item type string
    - opt_lim type int
Output Message: mot_fetch_nameResponseMessage
- parameters
  - mot_fetch_nameResponse type
    - result type mot_nameArray
      - item type string
        &l

WSDL Changes

Date	Description of Changes
8th April 2009	First Snapshot

Test #1: HitKeeper Test Client

This test client tests a number of methods of HitKeeper

Submitted by heinz on Wed, 08/27/2008 - 19:51