POST api/ListDocumentationTypes
Returns the DrugToDrug and DrugToLifestyle interaction documentation values, along with their internal identifiers.
Includes a ‘MaxResults’ option that allows you to limit the number of results returned.
Each drug or lifestyle interaction is assigned both a severity and documentation value in the interaction data.
Documentation refers to the frequency in which an interaction is seen in literature.
Request Information
URI Parameters
None.
Body Parameters
ListDocumentationTypesRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| MaxResults | Limits the number of results returned. A null value means no limit, and everthing will be returned. | integer |
None. |
| AccessToken |
Temporary access token from the GSDD Auth API.
Used to validate your license.
Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{
"MaxResults": 10,
"AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}
Response Information
Resource Description
ListDocumentationTypesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentationTypes | Returns the output parameters for the Drug-to-Drug and Drug-to-Lifestyle interaction documentation values. | Collection of IdentifierName |
None. |
Response Formats
application/json, text/json
Sample:
{
"DocumentationTypes": null
}