Overview
This document is a listing of the GlyTouCan API and any technical details behind it. It will be updated as the API changes.
Background
Long background of this explained in a post.
TLDR: The API is a contract-first development method using the SOAP protocol, which is why this document should be updated first to clearly recognize functionality and how it will be transcribed into a definition file.
Functionality
The below is a listing of the functionality provided by the api. Words in Bold are “Complex”, meaning they are a combination of literals. Italics is for static data. Multiple indicates a Set or Array of the contents directly below it.
- Searching structures (exact)
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- GlycoSequence
- output
- GlycoSequence
- sequence string
- sequence format (optional) 6. ResponseMessage
- GlycoSequence
- input
- Searching structures (substructure)
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- GlycoSequence
- output
- Multiple results based upon the current substructure search method
- GlycoSequence
- sequence string
- sequence format (optional)
- ResponseMessage
- GlycoSequence
- Multiple results based upon the current substructure search method
- input
- Registering GlycoSequences
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- GlycoSequence
- output
- GlycoSequence
- sequence string
- sequence format (optional)
- accession number string
- ResponseMessage
- GlycoSequence
- input
- Special functionality for Partners - all partner functionality determines the partner id based upon the API authentication.
- Partner GlycoSequence ID linking
- Registering/Updating with GlycoSequence
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- partner glycosequence ID string
- GlycoSequence
- output
- GlycoSequence
- sequence string
- sequence format (detected)
- accession number string
- partner glycosequence id string
- ResponseMessage
- GlycoSequence
- input
- Registering/Updating with Accession Number
- input
- accession number string
- partner glycosequence ID string
- output
- accession number string
- partner glycosequence id string
- ResponseMessage
- input
- Deleting with GlycoSequence
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- partner glycosequence ID string
- GlycoSequence
- output
- GlycoSequence
- sequence string
- sequence format (detected)
- accession number string
- partner glycosequence id string
- ResponseMessage
- GlycoSequence
- input
- Deleting with Accession Number
- input
- accession number string
- partner glycosequence ID string
- output
- accession number string
- partner glycosequence id string
- ResponseMessage
- input
- Registering/Updating with GlycoSequence
- Partner Alias management
- Registering/Updating
- input
- Alias
- alias string
- notation schema (optional: default is common_name)
- accession number string
- Alias
- output
- Alias
- alias string
- notation schema
- accession number string
- ResponseMessage
- Alias
- input
- Deleting
- input
- Alias
- alias string (optional)
- notation schema
- accession number string
- Alias
- output
- Alias
- alias string (optional)
- notation schema
- accession number string
- ResponseMessage
- Alias
- input
- Registering/Updating
- Partner Motif Management
- Registering/Updating with GlycoSequence
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- Alias
- alias string
- notation schema (ignored if entered, default is motif_name)
- GlycoSequence
- output
- GlycoSequence
- sequence string
- sequence format (detected)
- Alias
- alias string
- notation schema (motif_name)
- ResponseMessage
- GlycoSequence
- input
- Registering/Updating with Accession Number
- input
- accession number string
- Alias
- alias string
- notation schema (ignored if entered, default is motif_name)
- output
- accession number string
- Alias
- alias string
- notation schema (motif_name)
- ResponseMessage
- input
- Deleting with GlycoSequence
- input
- GlycoSequence
- sequence string
- sequence format (optional)
- GlycoSequence
- output
- GlycoSequence
- sequence string
- sequence format (detected)
- accession number string
- Alias
- alias string
- notation schema (motif_name)
- ResponseMessage
- GlycoSequence
- input
- Deleting with Accession Number
- input
- accession number string
- Alias
- alias string
- notation schema (ignored if entered, default is motif_name)
- output
- accession number string
- Alias
- alias string
- notation schema (motif_name)
- ResponseMessage
- input
- Registering bibo
Written with StackEdit.
- Registering/Updating with GlycoSequence
- Partner GlycoSequence ID linking