POST api/ListDoseForms

Returns a list of all dose forms used in the Gold Standard Drug Database (GSDD), along with their internal identifiers. Results can be filtered to a Dose Form Name, by setting the NameFilter parameter. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.

The Gold Standard Dosage Form is a proprietary concept developed by the Gold Standard Drug Database team to more accurately represent the dosage form of drug items. Gold Standard dosage forms are unique to the drug item and do not combine multiple dosage forms or non-drug items into the dosage form record (e.g., vaginal cream with applicator). Every drug item has one Gold Standard dosage form.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

ListDoseFormsRequest

Name	Description	Type	Additional information
NameFilter	Optional name filter. Only those records with names matching the filter are returned if set. Accepts full or partial (with a wildcard ‘%’) values as filters.	string	None.
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:

{
  "NameFilter": "%name%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListDoseFormsResponse

Name	Description	Type	Additional information
DoseForms	Returns the output parameters for the Gold Standard dosage form.	Collection of IdentifierName	None.

Response Formats

application/json, text/json

Sample:

{
  "DoseForms": [
    {
      "Id": 1,
      "Name": "Sample Name text."
    },
    {
      "Id": 2,
      "Name": "Sample Name text."
    }
  ]
}