POST api/ListProductNameTypes

Returns all of Gold Standard’s product name types, along with their internal identifiers. Includes a ‘MaxResults’ option that allows you to limit the number of results returned. Product name types describe the type of name that appears in the ProductLongName field of the drug product data and are returned in the following API methods: DetailProduct, ListPharmEquivalentProducts, ListProducts, ListProductsByCompany, ListProductsByTherapeuticConceptTree, ListSubCandidateProducts


Request Information

URI Parameters

None.

Body Parameters

ListProductNameTypesRequest
NameDescriptionTypeAdditional information
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:
{
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListProductNameTypesResponse
NameDescriptionTypeAdditional information
ProductNameTypes Returns the output parameters for the Gold Standard product name types. Collection of IdentifierName

None.

Response Formats

application/json, text/json

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