POST api/ListPharmEquivalentProducts
Returns all products that share the identical drug items and routes of administration as the reference product passed into the request.
Shows all products in the database that are identified as pharmaceutical equivalents to the product passed into the request (the reference product).
Includes a ‘MaxResults’ option that allows you to limit the number of results returned
Request Information
URI Parameters
None.
Body Parameters
ListPharmEquivalentProductsRequestName | Description | Type | Additional information |
---|---|---|---|
ProductId | Input parameters for any product identifiers passed into the request. | ProductIdentifier |
Required |
ReturnProductModifier | Used to indicate that Product Modifier information should be returned as part of the result. | boolean |
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:
{ "ProductId": { "IdType": "NDC9", "Id": "12345-0001" }, "ReturnProductModifier": true, "MaxResults": 10, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ListPharmEquivalentProductsResponseName | Description | Type | Additional information |
---|---|---|---|
Products | Returns the output parameters for the pharmaceutical equivalent products. | Collection of ProductDetailTE |
None. |
Response Formats
application/json, text/json
Sample:
{ "Products": [ { "ProductId": 1, "TherapeuticEquivalences": [ "Sample TherapeuticEquivalences text.", "Sample TherapeuticEquivalences text." ], "DESIStatusId": 2, "DESIStatusText": "Sample DESIStatusText text.", "ProductModifiers": [ { "ProductModifierId": 3, "ProductModiferName": "Sample ProductModiferName text.", "ProductModifierTypeId": 4, "ProductModiferTypeName": "Sample ProductModiferTypeName text." }, { "ProductModifierId": 5, "ProductModiferName": "Sample ProductModiferName text.", "ProductModifierTypeId": 6, "ProductModiferTypeName": "Sample ProductModiferTypeName text." } ], "ProductNameLong": "Sample ProductNameLong text.", "ProductNameType": "Sample ProductNameType text.", "ProductNameShort": "Sample ProductNameShort text.", "Marketer": "Sample Marketer text.", "LegendStatus": "Sample LegendStatus text.", "BrandGenericStatus": "Sample BrandGenericStatus text.", "FederalDEAClass": "Sample FederalDEAClass text.", "ReplacedByProductId": 7, "LicenseType": "Sample LicenseType text.", "MarketStatus": "OffMarket", "IngredientStrengthRouteFormInfo": [ { "Ingredient": { "Id": 8, "Name": "Sample Name text." }, "Strength": 1.234, "StrengthUnitCode": "Sample StrengthUnitCode text.", "PerVolume": 1.234, "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.", "Route": { "Id": 9, "Name": "Sample Name text." }, "FDAForm": { "Id": 10, "Name": "Sample Name text." }, "GSForm": { "Id": 11, "Name": "Sample Name text." } }, { "Ingredient": { "Id": 12, "Name": "Sample Name text." }, "Strength": 1.234, "StrengthUnitCode": "Sample StrengthUnitCode text.", "PerVolume": 1.234, "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.", "Route": { "Id": 13, "Name": "Sample Name text." }, "FDAForm": { "Id": 14, "Name": "Sample Name text." }, "GSForm": { "Id": 15, "Name": "Sample Name text." } } ] }, { "ProductId": 16, "TherapeuticEquivalences": [ "Sample TherapeuticEquivalences text.", "Sample TherapeuticEquivalences text." ], "DESIStatusId": 17, "DESIStatusText": "Sample DESIStatusText text.", "ProductModifiers": [ { "ProductModifierId": 18, "ProductModiferName": "Sample ProductModiferName text.", "ProductModifierTypeId": 19, "ProductModiferTypeName": "Sample ProductModiferTypeName text." }, { "ProductModifierId": 20, "ProductModiferName": "Sample ProductModiferName text.", "ProductModifierTypeId": 21, "ProductModiferTypeName": "Sample ProductModiferTypeName text." } ], "ProductNameLong": "Sample ProductNameLong text.", "ProductNameType": "Sample ProductNameType text.", "ProductNameShort": "Sample ProductNameShort text.", "Marketer": "Sample Marketer text.", "LegendStatus": "Sample LegendStatus text.", "BrandGenericStatus": "Sample BrandGenericStatus text.", "FederalDEAClass": "Sample FederalDEAClass text.", "ReplacedByProductId": 22, "LicenseType": "Sample LicenseType text.", "MarketStatus": "OffMarket", "IngredientStrengthRouteFormInfo": [ { "Ingredient": { "Id": 23, "Name": "Sample Name text." }, "Strength": 1.234, "StrengthUnitCode": "Sample StrengthUnitCode text.", "PerVolume": 1.234, "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.", "Route": { "Id": 24, "Name": "Sample Name text." }, "FDAForm": { "Id": 25, "Name": "Sample Name text." }, "GSForm": { "Id": 26, "Name": "Sample Name text." } }, { "Ingredient": { "Id": 27, "Name": "Sample Name text." }, "Strength": 1.234, "StrengthUnitCode": "Sample StrengthUnitCode text.", "PerVolume": 1.234, "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.", "Route": { "Id": 28, "Name": "Sample Name text." }, "FDAForm": { "Id": 29, "Name": "Sample Name text." }, "GSForm": { "Id": 30, "Name": "Sample Name text." } } ] } ] }