POST api/ListPackages

Returns general information about packages to the end user. Includes a ‘MaxResults’ option that allows you to limit the number of results returned. The request can be performed using several different kinds of filters. Based on the filter used, the method returns slightly different identifier data. You can also optionally filter your results to specifically return packages that meet AGS BEERs Criteria as potentially inappropriate medications (PIMs) for older adults.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

ListPackagesRequest

Name	Description	Type	Additional information
FilterType	The type of identifier or name to filter for.	PackageFilterEnum	Required
Filter	The identifier or name to filter or search for.	string	Required
BeersFilter	Input parameters to return packages containing drugs identified per AGS BEERs Criteria for a specific quality of evidence and/or strength of recommendation rating as potentially inappropriate medications (PIMs) for older adults.	AGSBeersFilter	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:

{
  "FilterType": "PackageId",
  "Filter": "%name%",
  "BeersFilter": {
    "AGSBeersStrengthOfRecommendation": "Item2",
    "AGSBeersQualityOfEvidence": "Item2"
  },
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListPackagesResponse

Name	Description	Type	Additional information
Packages	A collection of package details matching the request.	Collection of PackageDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "Packages": [
    {
      "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": 2,
      "InnerPackageUnit": "Sample InnerPackageUnit text.",
      "ReplacedByPackageId": 3,
      "OuterPackageUnit": "Sample OuterPackageUnit text."
    },
    {
      "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": 3,
      "InnerPackageUnit": "Sample InnerPackageUnit text.",
      "ReplacedByPackageId": 6,
      "OuterPackageUnit": "Sample OuterPackageUnit text."
    }
  ]
}