navan
/
classyfire_api
mirror of https://bitbucket.org/wishartlab/classyfire_api
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README.md edited online with Bitbucket

This commit is contained in:
djoumbou 2014-07-10 03:10:33 +00:00
parent ce41e7a45e
commit 47bb44caa5
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -23,24 +23,33 @@
# **Endpoints** # # **Endpoints** #
> ##1. Entities## > ##1. Entity##
> >
> >Chemical compounds are represented by the Entity model, through which one can access the compound's structure-based classification. > >Chemical compounds are represented by the Entity model, through which one can access the compound's structure-based classification.
> >
> >###GET /entities### > >###GET###
> >
> >You can retrieve a chemical compound's classification in the JSON or XML format. The compound's information is accessed via the InChIkey as show in the following examples. In this example, the entity has the InChIKey=LABTWGUMFABVFG-ONEGZZNKSA-N. > >**/entities/{entity_inchikey}**
> >
> >A chemical compound's classification can be retrieved in the JSON or XML format. The compound's information is accessed via the InChIkey as show in the following examples. In this example, the entity has the InChIKey=LABTWGUMFABVFG-ONEGZZNKSA-N.
> > > > > >
> > >curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://classyfire.wishartlab.com/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.json > > >curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://classyfire.wishartlab.com/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.json
> > > > > >
> > >curl -H "Accept: application/xml" -H "Content-Type: application/xml" -X GET http://classyfire.wishartlab.com/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.xml > > >curl -H "Accept: application/xml" -H "Content-Type: application/xml" -X GET http://classyfire.wishartlab.com/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.xml
> ##1. Queries## > ##2. Query##
> >The Query model represents a list of chemical structures to be classified. The query object can be submitted via a POST request. The classification results can be retrieved via a GET request. > >The Query model represents a list of chemical structures to be classified. Its attributes are the query label and the query input.
> >*The query label is an identifier
> >* The query input contains a list of structures represented in the [Daylight SMILES](http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html) or the [InChI](http://www.iupac.org/home/publications/e-resources/inchi.html) format. Each line contains a structure representation preceded by a compound identifier(optionally), if available.
> >###POST /Queries###
> > > >###POST###
> > > >A query can be submitted using the POST method as demonstrated in the following example.
> > >
> >###GET###
> > The classification results can be retrieved via a GET method.
# **Directory Structure** # # **Directory Structure** #