Difference between revisions of "Alternative Content Formats"

From BioDAS
Jump to: navigation, search
m (das-json sources)
Line 13: Line 13:
 
|binary-bigbed||application/octet-stream||features
 
|binary-bigbed||application/octet-stream||features
 
|}
 
|}
 +
 +
==das-xml==
 +
 +
The XML formats described in the [http://www.biodas.org/documents/spec-1.6.html DAS Specification].
  
 
==das-json==
 
==das-json==
  
This format is a native JSON encoding of the DAS data model. The design principle for this format is that the properties accurately match those in the specification, rather than the XML. Thus there are no distinctions made between elements, attributes and text content. Whilst this means that implementing a reciprocal XML-JSON conversion function must be done explicitly for each DAS command, using DAS in Javascript web applications is more natural.
+
This format is a native JSON encoding of the DAS data model. The design principle for this format is that the properties accurately match those in the specification wherever sensible, but are not bound by the restrictions or conventions of XML. Thus there are no distinctions made between elements/attributes/text content, and properties can be of any JSON data type. Whilst this means that implementing a reciprocal XML-JSON conversion function must be done explicitly for each DAS command, using DAS in Javascript web applications is more natural.
 +
 
 +
The properties present in the JSON model for each command mirror those in the [http://www.biodas.org/documents/spec-1.6.html DAS specification], with the same semantics applied to each property (e.g. whether properties are required or optional). Since this is a new format at for the avoidance of confusion, deprecated properties are not included.
  
 
Currently, the ''das-json'' format is defined for the sources, features and types commands.
 
Currently, the ''das-json'' format is defined for the sources, features and types commands.

Revision as of 10:10, 27 March 2012

List of alternative content formats:

Name MIME type Commands
das-xml application/xml all
das-json application/json sources,features,types
binary-bigwig application/octet-stream features
binary-bigbed application/octet-stream features

das-xml

The XML formats described in the DAS Specification.

das-json

This format is a native JSON encoding of the DAS data model. The design principle for this format is that the properties accurately match those in the specification wherever sensible, but are not bound by the restrictions or conventions of XML. Thus there are no distinctions made between elements/attributes/text content, and properties can be of any JSON data type. Whilst this means that implementing a reciprocal XML-JSON conversion function must be done explicitly for each DAS command, using DAS in Javascript web applications is more natural.

The properties present in the JSON model for each command mirror those in the DAS specification, with the same semantics applied to each property (e.g. whether properties are required or optional). Since this is a new format at for the avoidance of confusion, deprecated properties are not included.

Currently, the das-json format is defined for the sources, features and types commands.

das-json sources

{
    "sources" : [
        {
            "uri"         : "mygenes",
            "title"       : "My Genes",
            "description" : "A source that provides gene features",
            "doc_href"    : "http://myplace.com/info/mysource",
            "maintainer"  : {
                "email": "me@myplace.com"
            },
            "versions" : [
                {
                    "uri"          : "mysource",
                    "created"      : "2012-03-27T14:23:44Z",
                    "capabilities" : [
                        {
                           "type"      : "das1:sources",
                           "query_uri" : "http://myplace.com/das/mygenes"
                        },
                        {
                           "type"      : "das1:formats",
                           "query_uri" : "http://myplace.com/das/mygenes/formats"
                        },
                        {
                           "type"      : "das1:features",
                           "query_uri" : "http://myplace.com/das/mygenes/features"
                        }
                    ],
                    "coordinates" : [
                        {
                            "uri"        : "http://www.dasregistry.org/dasregistry/coordsys/CS_DS108",
                            "label"      : "NCBIM_37,Chromosome,Mus musculus",
                            "authority"  : "NCBIM",
                            "version"    : "37",
                            "source"     : "Chromosome",
                            "taxid"      : 10090,
                            "test_range" : "8:1,100"
                        }
                    ],
                    "properties" : [
                        {
                            "name"  : "Some Key",
                            "value" : "Some Value"
                        }
                    ]
                }
            ]
        }
    ]
}