v1.2
[Spec: v3.2]

info@bind.ca
 
         
April 24, 2014
API Method List
Methods
  1. isServiceAlive
  2. getSoftwareVersion
  3. getSpecVersion
  4. IdSearch
  5. IdSearchAttachment
  6. textSearch
  7. textSearchAttachment

Types
  1. SearchResultBean

Exceptions
  1. BINDSOAPException

Methods

Method Name:   isServiceAlive Back to API Method List
Description:   Returns a boolean indicating if the BIND SOAP web service is up and running.
Parameters:   None
Returns:  
Type
Description
boolean
Returns true if the web service is running, false if it is not running.

Method Name:   getSoftwareVersion Back to API Method List
Description:   Returns the version number of the BIND SOAP web service.
Parameters:   None
Returns:  
Type
Description
string
The version number of the web service.

Method Name:   getSpecVersion Back to API Method List
Description:   Returns the BIND specification version implemented by the web service.
Parameters:   None
Returns:  
Type
Description
string
The BIND specification version implemented.

Method Name:   IdSearch Back to API Method List
Description:   Given an identifier and the type of idenfier returns all BIND records found, in the format specified. The developer also has the option of restricting the search by BIND record type.
Parameters:  
Name
Type
Description
id
string
Value of query identifier
idType
string
One of the following strings:
  1. 'bindid'
  2. 'gi'
  3. 'entrezgene'
  4. 'pmid'
  5. 'taxid'
  6. 'smallmoleculeid'
  7. 'afcs'
  8. 'beilstein'
  9. 'cas'
  10. 'cdd'
  11. 'cog'
  12. 'colibase'
  13. 'ddbj'
  14. 'dictybase'
  15. 'einecs'
  16. 'embl'
  17. 'emd'
  18. 'ensembl'
  19. 'flybase'
  20. 'genbank'
  21. 'GO'
  22. 'interpro'
  23. 'ipi'
  24. 'klotho'
  25. 'locuslink'
  26. 'mdl'
  27. 'merck'
  28. 'MGI'
  29. 'mmcif'
  30. 'mmdb'
  31. 'omim'
  32. 'pdb'
  33. 'pfam'
  34. 'pir'
  35. 'refseq'
  36. 'rgd'
  37. 'sgd'
  38. 'smart'
  39. 'swissprot'
  40. 'tair'
  41. 'atd'
  42. 'cmr'
  43. 'trembl'
  44. 'unigene'
  45. 'uniprot'
  46. 'wormbase'
  47. 'zfin'
returnType
boolean
One of the following strings:
  1. 'idlist'
  2. 'gipair'
  3. 'go'
  4. 'domain'
  5. 'fasta'
  6. 'cytoscape'
  7. 'xml'
  8. 'submitxml'
  9. 'submitasn'
  10. 'flat'
  11. 'psi'
Returns:  
Type
Description
SearchResultBean
A SearchResultBean containing the all BIND records found, in the format specified.

Method Name:   IdSearchAttachment Back to API Method List
Description:   Given an identifier and the type of idenfier returns all BIND records found, in the format specified. The developer also has the option of restricting the search by BIND record type.
Parameters:  
Name
Type
Description
id
string
Value of query identifier
idType
string
One of the following strings:
  1. 'bindid'
  2. 'gi'
  3. 'entrezgene'
  4. 'pmid'
  5. 'taxid'
  6. 'smallmoleculeid'
  7. 'afcs'
  8. 'beilstein'
  9. 'cas'
  10. 'cdd'
  11. 'cog'
  12. 'colibase'
  13. 'ddbj'
  14. 'dictybase'
  15. 'einecs'
  16. 'embl'
  17. 'emd'
  18. 'ensembl'
  19. 'flybase'
  20. 'genbank'
  21. 'GO'
  22. 'interpro'
  23. 'ipi'
  24. 'klotho'
  25. 'locuslink'
  26. 'mdl'
  27. 'merck'
  28. 'MGI'
  29. 'mmcif'
  30. 'mmdb'
  31. 'omim'
  32. 'pdb'
  33. 'pfam'
  34. 'pir'
  35. 'refseq'
  36. 'rgd'
  37. 'sgd'
  38. 'smart'
  39. 'swissprot'
  40. 'tair'
  41. 'atd'
  42. 'cmr'
  43. 'trembl'
  44. 'unigene'
  45. 'uniprot'
  46. 'wormbase'
  47. 'zfin'
returnType
boolean
One of the following strings:
  1. 'idlist'
  2. 'gipair'
  3. 'go'
  4. 'domain'
  5. 'fasta'
  6. 'cytoscape'
  7. 'xml'
  8. 'submitxml'
  9. 'submitasn'
  10. 'flat'
  11. 'psi'
Returns:  
Type
Description
SearchResultBean
A SearchResultBean containing the all BIND records found, in the format specified.

Method Name:   textSearch Back to API Method List
Description:   Given a Lucene query string, returns all BIND records found, in the format specified.
Parameters:  
Name
Type
Description
query
string
The Lucene query string.
returnType
string
One of the following strings:
  1. 'idlist'
  2. 'gipair'
  3. 'go'
  4. 'domain'
  5. 'fasta'
  6. 'cytoscape'
  7. 'xml'
  8. 'submitxml'
  9. 'submitasn'
  10. 'flat'
  11. 'psi'
Returns:  
Type
Description
SearchResultBean
A SearchResultBean containing the all BIND records found, in the format specified.

Method Name:   textSearchAttachment Back to API Method List
Description:   Given a Lucene query string, returns all BIND records found, in the format specified.
Parameters:  
Name
Type
Description
query
string
The Lucene query string.
returnType
string
One of the following strings:
  1. 'idlist'
  2. 'gipair'
  3. 'go'
  4. 'domain'
  5. 'fasta'
  6. 'cytoscape'
  7. 'xml'
  8. 'submitxml'
  9. 'submitasn'
  10. 'flat'
  11. 'psi'
Returns:  
Type
Description
SearchResultBean
A SearchResultBean containing the all BIND records found, in the format specified.




Types

Type Name:   SearchResultBean Back to API Method List
Description:   An object which contains the results of an export
Field
Description
totalRecordsFound
Number of records returned
records
The export is saved here
query
The query used to produce this bean
returnType
The return type



Exceptions

Type Name:   BINDSOAPException Back to API Method List
Description:   BIND specific exception..returned in a SOAP fault



Download Client Examples
  gSOAP client
  AXIS client
  SOAPLite client
  Python client
  VB.NET client


BIND SOAP Help
  Download Manual
  View API Methods
  Download WSDL File
  View Test Results