POST api/ListIngredients

Returns ingredients available in the Gold Standard Drug Database, along with RXNorm Ingredient Codes and UNII Ingredient Codes, based on supplied input filters. Results can be filtered to an ingredient name by setting the NameFilter parameter. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.

Ingredients can be used as filter criteria for the ListPackages or ListProducts method, and may also be passed into the DrugToAllergy method as a patient allergen.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

ListIngredientsRequest

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

ListIngredientsResponse

Name	Description	Type	Additional information
Ingredients	Returns the output parameters for each ingredient.	Collection of IngredientInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Ingredients": [
    {
      "IngredientId": 1,
      "IngredientName": "Sample IngredientName text.",
      "NameSourceId": "Sample NameSourceId text.",
      "LanguageCode": "es-ES",
      "PrimaryName": true,
      "TallmanName": "Sample TallmanName text.",
      "RxNormCode": "Sample RxNormCode text.",
      "UniiCode": "Sample UniiCode text.",
      "RXAUI": "Sample RXAUI text.",
      "RXCUI": "Sample RXCUI text."
    },
    {
      "IngredientId": 2,
      "IngredientName": "Sample IngredientName text.",
      "NameSourceId": "Sample NameSourceId text.",
      "LanguageCode": "en-US",
      "PrimaryName": true,
      "TallmanName": "Sample TallmanName text.",
      "RxNormCode": "Sample RxNormCode text.",
      "UniiCode": "Sample UniiCode text.",
      "RXAUI": "Sample RXAUI text.",
      "RXCUI": "Sample RXCUI text."
    }
  ]
}