POST api/ListProductActiveIngredients

Returns all of the active ingredients in all drug items of a product. 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.


Request Information

URI Parameters

None.

Body Parameters

ListProductActiveIngredientsRequest
NameDescriptionTypeAdditional information
ProductId Input parameters for any product identifiers passed into the request. ProductIdentifier

Required

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:
{
  "ProductId": {
    "IdType": "NDC9",
    "Id": "12345-0001"
  },
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListProductActiveIngredientsResponse
NameDescriptionTypeAdditional information
Ingredients Returns the output parameters for the drug item active ingredients of the supplied product. Collection of IdentifierName

None.

Response Formats

application/json, text/json

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