RAAS: Informational (Get) Calls

If an active key is not passed, a maximum of 10 units of data will be returned. This allows the API to be evaluated.

Sending Credentials

Postman is a common tool for REST API development. The following illustrates how to send it with postman

Possible Response

Invalid credential are automatically converted to the trial account, so a 200 will be returned but with limited data

If you have a valid account but without funds or after expiration, you will get a 402 response

Modifier Types

List the groupings of microbiome modifiers being used.

  • /api/modifiertypes

Modifiers In A Type

List the modifiers in a particular type. Replace “A” below with appropriate key from above

  • /api/modifiersByType?modifiertype=A

Modifier Citations

List the citations for a specific modifier. Use the id specified above. Only Direct (C) citations are listed.

Medical Conditions

/api/conditions

Medical Condition Citations and Taxonomy

/api/conditionCitations?id=17

Bacteria (Taxonomy) Citations

List the citations for a specific bacteria. The NCBI Taxon numbers are used for the ID. Only Direct (C) citations are listed.

One or more Specific Citation

A citation may occur that was NOT there on prior retrievals. Instead of download in bulk, use the following to obtain the delta.

  • /api/citation?id=338
  • /api/citations?id=338,485

One or more Modifier Citation

A modifier may occur that was NOT there on prior retrievals. Instead of download in bulk, use the following to obtain the delta.

  • /api/modifier?id=338
  • /api/modifiers?id=338,564