Aquaria feature API

This API allows you to add features to Aquaria and control how they appear; it is still being developed, so contact us in case of problems.

Usage: http://aquaria.ws/P04637?features=http://your-server.org/P04637.json or [1]http://aquaria.ws/P04637?features=http://your-server.org/json/

{

     "Sequence variation (natural variant site)": {"Source": "Your server", "URL": "http://your-server.org", "Features": [

         {"Name": "G > C", "Residue": 245},

         {"Name": "RP > SA", "Residues": [249, 250], "Color": "#FF0000", "Description": "<a href=\"http://pubmed.org/1394745\">Somatic mutation</a>."}

     ]},

     "Mutational Sensitivity": {"Source": "Your server 2", "URL": "http://your-server2.org", "Color": "#FF0000", "Features": [

         {"Name": "Highly sensitive", "Residue": 245, "Description": "12/20 amino acid substitutions disrupt function."}

     ]}

}

CAVE: In case your URL contains control characters (e.g. because you generate it on the fly via post), you have to URLencode your URL, e.g. http://aquaria.ws/P04637?features=https%3A%2F%2Fyour-server.org%2Fservices%2Faquaria%2Ffeatures4aquaria%2Fjson.php%3FuniprotAcc%3DP04637

Feature set properties

Key: Each feature set begins with a unique key (e.g., "Mutational Sensitivity") specifying the name to be displayed for that set of features.

Source (optional): Name of service or resource that delivers the feature set.

Color (optional): Used as default for features in this set. If not defined, Aquaria chooses colors automatically.

Description (optional): Describes the service or resource that delivers the feature set (displayed on mouse-hover).

URL (optional): URL of service or resource that delivers the features.

Feature properties

Name: A short title for the feature; the same name can be used for multiple features in a feature set.

Residue(s): A residue number; or a range of start and end residues; or a set of multiple residues and ranges defining a complex feature (e.g., a binding site)[2].

Color (optional): If not defined, Aquaria will choose feature colors automatically.

Connected (optional): Set to false for disulphide bonds or binding sites; the connections between residues are then drawn only upon mouse-hover.[3]

Description (optional): Describes the feature; allows formatting via a subset of HTML tags (excludes tags such as <script>).

Web Server settings

Your JSON server must allow requests from aquaria.ws; to do this in Apache, enable the http response header ‘Access-Control-Allow-Origin’ as follows:

Software feature request (s)


[1] In this case, since no .json file is specified, Aquaria automatically appends ‘P04637.json‘ to the URL.

[2] For complex sets of residues and ranges (e.g., "[175, [180, 182], [189, 205], 249]") the "Connected" display option is then automatically set to false.

[3] For complex residue sets (see above), residue ranges are always drawn connected; however, connections between them are only shown upon mouse-hover.