POST api/ListPackagesByCompany

Returns general information about packages to the end user, based on a marketing firm’s company identifier or labeler code. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.


Request Information

URI Parameters

None.

Body Parameters

ListPackagesByCompanyRequest
NameDescriptionTypeAdditional information
CompanyId Either the Gold Standard internally assigned numeric identifier for the Company, or the FDA-assigned five-digit Labeler Code. Enter the exact CompanyId or LabelerCode of the marketing firm whose packages you wish to return, exactly as it resides in the GSDD Company table. Does not accept partial (wildcard ‘%’) values. string

Required
CompanyIdType The Company Identifier Type you are passing in. Enter one of the valid enumeration values to narrow search results. (NOTE: Values are case-sensitive.) Valid Values: ‘CompanyId’, ‘LabelerCode’ CompanyIdentifierEnum

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: 
{
  "CompanyId": "1",
  "CompanyIdType": "LabelerCode",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListPackagesByCompanyResponse
NameDescriptionTypeAdditional information
Packages Returns the details for packages associated to the company filter. Collection of PackageDetailMarketer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Packages": [
    {
      "Marketer": "Sample Marketer text.",
      "PackageSize": 1.234,
      "PackageId": 1,
      "ProductId": 2,
      "MarketStatus": "OffMarket",
      "ProductNameLong": "Sample ProductNameLong text.",
      "PackageDescription": "Sample PackageDescription text.",
      "NCPDPBillingUnit": "Sample NCPDPBillingUnit text.",
      "NCPDPExceptionalCount": 1.234,
      "NCPDPScriptForm": "Sample NCPDPScriptForm text.",
      "InnerPackageQuantity": 3,
      "InnerPackageUnit": "Sample InnerPackageUnit text.",
      "ReplacedByPackageId": 3,
      "OuterPackageUnit": "Sample OuterPackageUnit text."
    },
    {
      "Marketer": "Sample Marketer text.",
      "PackageSize": 1.234,
      "PackageId": 4,
      "ProductId": 5,
      "MarketStatus": "OffMarket",
      "ProductNameLong": "Sample ProductNameLong text.",
      "PackageDescription": "Sample PackageDescription text.",
      "NCPDPBillingUnit": "Sample NCPDPBillingUnit text.",
      "NCPDPExceptionalCount": 1.234,
      "NCPDPScriptForm": "Sample NCPDPScriptForm text.",
      "InnerPackageQuantity": 4,
      "InnerPackageUnit": "Sample InnerPackageUnit text.",
      "ReplacedByPackageId": 6,
      "OuterPackageUnit": "Sample OuterPackageUnit text."
    }
  ]
}