POST api/ListSpecificProducts

Accepts specific product name, product identifier, or a package identifier and returns all Gold Standard Specific Products (SPs) matching the name or identifier. Includes a ‘MaxResults’ option that allows you to limit the number of results returned


Request Information

URI Parameters

None.

Body Parameters

ListSpecificProductsRequest
NameDescriptionTypeAdditional information
PackageOrProductFilter The package or product identifier to filter the results by. PackageProductIdentifier

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: 
{
  "PackageOrProductFilter": {
    "IdType": "NDC11",
    "Id": "12345-6789-01"
  },
  "NameFilter": "%filter%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListSpecificProductsResponse
NameDescriptionTypeAdditional information
SpecificProducts Returns the output parameters for each ingredient Collection of IdentifierName

None.

Response Formats

application/json, text/json

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