Endpoint - Methods

Compounds - API endpoints

This section provides a comprehensive list of all endpoints related to passive interaction methods.

How to read an endpoint definition?

Method	Describes which HTTP method must be used while calling the given endpoint.
Pattern	Specifies the suffix of the URL determining API endpoint. A final URL is created by combining the server address prefix https://molmedb.upol.cz/api with the corresponding pattern. For example, endpoint with a pattern /compounds/detail/<id><?get_parameters> is called at address https://molmedb.upol.cz/api/compounds/detail/<id><?get_parameters>.
Parameters	Describes possible parameters which can be used for query specification. All parameters can be inserted as GET_parameters, but some may be inserted as part of the URL (e.g. parameter id in the previous example). For both options, see the example in Compounds - detail endpoint definition below.
Output formats	Describes possible output formats of the data returned from the server.

Tip!

To see the human-readable structure of methods categories with a detailed description, please visit https://molmedb.upol.cz/browse/methods.

List of all methods

This endpoint returns a list of all available methods used for measurement of a drug-membrane interactions. The description of each method is limited due to the extensiveness of the data. Please see the endpoint Methods - detail for a detailed description.

Method	GET
Pattern	/methods/all<?categorized>
Parameters	categorized [true/false] - Adds assigned categories for each record.
Output formats	JSON (default)

Category structure

This endpoint provides access to the category-subcategory structure tree used to organise saved methods.

Method	GET
Pattern	/methods/categories
Parameters	-
Output formats	JSON (default)

Method detail

This endpoint returns detailed method record.

Method	GET
Pattern	/methods/detail/<?identifier><?category>
Parameter	identifier [int,string] - Membrane unique ID or name. Both can be obtained from the List of all membranes endpoint. category [string] - Category label. Can be obtained from the Category structure endpoint.
Output formats	JSON