POST api/ListMarketedProducts

Returns all branded and generic versions of each Gold Standard Marketed Product (MP) for which there is a match to the specified filter, along with their internal identifiers. Results can be filtered by name by setting the NameFilter option. Accepts either a branded name or a generic name, and returns all marketed products matching the request string, as well as all other marketed products that share the same ingredients, strengths and dose forms.

For example, executing a request for “lisinopr%” returns all Marketed Products for generic lisinopril, branded Zestril, and branded Prinivil. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

ListMarketedProductsRequest

Name	Description	Type	Additional information
IncludeOffMarket	Identifies whether to include Off Market products in the response.	boolean	None.
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:

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

Response Information

Resource Description

ListMarketedProductsResponse

Name	Description	Type	Additional information
MarketedProducts	Returns the output parameters for the Marketed Product name and identifiers.	Collection of IdentifierName	None.

Response Formats

application/json, text/json

Sample:

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