CATHEDRAL (Draft WSDL)

208

Service version0.1-unreleased

WSDL URLhttp://trunk.cathdb.info/api/wsdl/CATHEDRAL.wsdl PASSED

This service allows the CATH database to be searched by protein structure.

NB This service is not currently active. It is still in development -- check back here for updates. The WSDL posted may change between now and the first release.

A description of the WSDL service:

CathedralScan

Namespace: http://trunk.cathdb.info/api/wsdl

Port: CathedralScanSOAP
Location: http://trunk.cathdb.info/CathedralScan
Protocol: http://schemas.xmlsoap.org/soap/http
Default Style: document

Operations

SubmitQuery

SOAP Action: http://trunk.cathdb.info/CathedralScan/SubmitQuery
Input Message: SubmitQueryRequest
- parameters
  - SubmitQuery type
    - queryStruct type ProteinStruct
      - pdbCode type PdbCode
        restriction type string
      - pdbCoords type string
      - domainID type DomainID
        restriction type string
      - chainID type ChainID
        restriction type string
    - cathedralLibrary type string
    - emailAddress type string
    - enableEmailNotify type boolean
Output Message: SubmitQueryResponse
- parameters
  - SubmitQueryResponse type
    - jobID type string

MonitorJob

SOAP Action: http://trunk.cathdb.info/CathedralScan/MonitorJob
Input Message: MonitorJobRequest
- parameters
  - MonitorJob type
    - jobLocator type JobLocator
      - jobID type string
      - emailAddress type string
Output Message: MonitorJobResponse
- parameters
  - MonitorJobResponse type
    - jobStatus type JobStatus
      - statusCode type string
      - description type string
      - detail type string

RetrieveChainHits

SOAP Action: http://trunk.cathdb.info/CathedralScan/RetrieveChainHits
Input Message: RetrieveChainHitsRequest
- parameters
  - RetrieveChainHits type
    - jobLocator type JobLocator
      - jobID type string
      - emailAddress type string
Output Message: RetrieveChainHitsResponse
- parameters
  - RetrieveChainHitsResponse type
    - chainResult type ChainCathedralResult
      - matchSuperfamily type CathCodeH
        restriction type string
      - grathSvmScore type float
      - grathZscore type float
      - querySegments type QuerySegmentList
        querySegment type QuerySegment
        startPos type SeqPos
        restriction type string
        stopPos type SeqPos
        restriction type string

RetrieveDomainHits

SOAP Action: http://trunk.cathdb.info/CathedralScan/RetrieveDomainHits
Input Message: RetrieveDomainHitsRequest
- parameters
  - RetrieveDomainHits type
    - jobLocator type JobLocator
      - jobID type string
      - emailAddress type string
Output Message: RetrieveDomainHitsResponse
- parameters
  - RetrieveDomainHitsResponse type
    - domainResult type DomainCathedralResult
      - minOverlap type int
      - cliqueSize type int
      - numQuerySecStruct type int
      - numMatchSecStruct type int
      - grathScore type float
      - evalue type float

CancelJob

SOAP Action: http://trunk.cathdb.info/CathedralScan/CancelJob
Input Message: CancelJobRequest
- parameters
  - CancelJob type
    - jobLocator type JobLocator
      - jobID type string
      - emailAddress type string
Output Message: CancelJobResponse
- parameters
  - CancelJobResponse type
    - jobStatus type JobStatus
      - statusCode type string
      - description type string
      - detail type string

WSDL Changes

Date	Description of Changes
8th April 2009	First Snapshot
29th April 2009	Operation named SubmitQuery - Output message part type has changed Operation named MonitorJob - Output message part type has changed Operation named CancelJob - Output message part type has changed

Submitted by andrew.clegg on Thu, 11/20/2008 - 20:45