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.

  1. Searching structures (exact)
    1. input
      1. GlycoSequence
        1. sequence string
        2. sequence format (optional)
    2. output
      1. GlycoSequence
        1. sequence string
        2. sequence format (optional) 6. ResponseMessage
  2. Searching structures (substructure)
    1. input
      1. GlycoSequence
        1. sequence string
        2. sequence format (optional)
    2. output
      1. Multiple results based upon the current substructure search method
        1. GlycoSequence
          1. sequence string
          2. sequence format (optional)
        2. ResponseMessage
  3. Registering GlycoSequences
    1. input
      1. GlycoSequence
        1. sequence string
        2. sequence format (optional)
    2. output
      1. GlycoSequence
        1. sequence string
        2. sequence format (optional)
      2. accession number string
      3. ResponseMessage
  4. Special functionality for Partners - all partner functionality determines the partner id based upon the API authentication.
    1. Partner GlycoSequence ID linking
      1. Registering/Updating with GlycoSequence
        1. input
          1. GlycoSequence
            1. sequence string
            2. sequence format (optional)
          2. partner glycosequence ID string
        2. output
          1. GlycoSequence
            1. sequence string
            2. sequence format (detected)
          2. accession number string
          3. partner glycosequence id string
          4. ResponseMessage
      2. Registering/Updating with Accession Number
        1. input
          1. accession number string
          2. partner glycosequence ID string
        2. output
          1. accession number string
          2. partner glycosequence id string
          3. ResponseMessage
      3. Deleting with GlycoSequence
        1. input
          1. GlycoSequence
            1. sequence string
            2. sequence format (optional)
          2. partner glycosequence ID string
        2. output
          1. GlycoSequence
            1. sequence string
            2. sequence format (detected)
          2. accession number string
          3. partner glycosequence id string
          4. ResponseMessage
      4. Deleting with Accession Number
        1. input
          1. accession number string
          2. partner glycosequence ID string
        2. output
          1. accession number string
          2. partner glycosequence id string
          3. ResponseMessage
    2. Partner Alias management
      1. Registering/Updating
        1. input
          1. Alias
            1. alias string
            2. notation schema (optional: default is common_name)
          2. accession number string
        2. output
          1. Alias
            1. alias string
            2. notation schema
          2. accession number string
          3. ResponseMessage
      2. Deleting
        1. input
          1. Alias
            1. alias string (optional)
            2. notation schema
          2. accession number string
        2. output
          1. Alias
            1. alias string (optional)
            2. notation schema
          2. accession number string
          3. ResponseMessage
    3. Partner Motif Management
      1. Registering/Updating with GlycoSequence
        1. input
          1. GlycoSequence
            1. sequence string
            2. sequence format (optional)
          2. Alias
            1. alias string
            2. notation schema (ignored if entered, default is motif_name)
        2. output
          1. GlycoSequence
            1. sequence string
            2. sequence format (detected)
          2. Alias
            1. alias string
            2. notation schema (motif_name)
          3. ResponseMessage
      2. Registering/Updating with Accession Number
        1. input
          1. accession number string
          2. Alias
            1. alias string
            2. notation schema (ignored if entered, default is motif_name)
        2. output
          1. accession number string
          2. Alias
            1. alias string
            2. notation schema (motif_name)
          3. ResponseMessage
      3. Deleting with GlycoSequence
        1. input
          1. GlycoSequence
            1. sequence string
            2. sequence format (optional)
        2. output
          1. GlycoSequence
            1. sequence string
            2. sequence format (detected)
          2. accession number string
          3. Alias
            1. alias string
            2. notation schema (motif_name)
          4. ResponseMessage
      4. Deleting with Accession Number
        1. input
          1. accession number string
          2. Alias
            1. alias string
            2. notation schema (ignored if entered, default is motif_name)
        2. output
          1. accession number string
          2. Alias
            1. alias string
            2. notation schema (motif_name)
          3. ResponseMessage
      5. Registering bibo

        Written with StackEdit.