diff --git a/README.md b/README.md index 49dd977..3aca2b4 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,10 @@ # **Endpoints** # -> ##1. Entities -> -> ###GET/entities +> ##1. Entities## +> >Chemical compounds are represented by the Entity model, through which one can access the compound's structure-based classification. + +> >###GET /entities### > >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. > > > @@ -34,6 +35,14 @@ > > >curl -H "Accept: application/xml" -H "Content-Type: application/xml" -X GET http://classyfire.wishartlab.com/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.xml +> ##1. Queries## +> >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. + +> >###POST /Queries### +> > +> > + + # **Directory Structure** # * lib