POST api/ListProductNames

A scaled-down version of the ListProducts method. Only returns the Product Name, Product Identifier, and the name of the product’s Marketer. Is designed for those GSDD customers who only require minimal product information to show in a pick list. Additionally, it returns the ProductId to use as input to the DetailProduct method for more detailed information. Results can be filtered by setting the NameFilter parameter. 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

ListProductNamesRequest

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

ListProductNamesResponse

Name	Description	Type	Additional information
Products	Returns the output parameters for the product and product marketer.	Collection of ProductIdNameMarketerInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Products": [
    {
      "ProductId": {
        "IdType": "NDC9",
        "Id": "12345-0001"
      },
      "Name": "Sample Name text.",
      "Marketer": "Sample Marketer text."
    },
    {
      "ProductId": {
        "IdType": "NDC9",
        "Id": "12345-0002"
      },
      "Name": "Sample Name text.",
      "Marketer": "Sample Marketer text."
    }
  ]
}