POST api/ListFederal

Allows the user to submit either a product identifier or a package identifier and returns all available Federal flag information in GSDD for that Product or Package. 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

ListFederalRequest

Name	Description	Type	Additional information
PackageOrProductFilter	The package or product identifier to filter the results by.	PackageProductIdentifier	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"
  },
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListFederalResponse

Name	Description	Type	Additional information
Drugs	A collection of drugs matching the supplied filter and all their Federal flags. If no filter is passed in all drugs are returned.	Collection of FederalDrugInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Drugs": [
    {
      "Product": {
        "Name": "Sample Name text.",
        "IdType": "NDC9",
        "Id": "1"
      },
      "Package": {
        "Name": "Sample Name text.",
        "IdType": "UPCB",
        "Id": "2"
      },
      "DEAClassification": {
        "Id": 3,
        "Name": "Sample Name text."
      },
      "PatientPackageInsert": {
        "Id": 4,
        "Name": "Sample Name text."
      },
      "IVContainerMaterial": {
        "Id": 5,
        "Name": "Sample Name text."
      },
      "LegendStatus": {
        "Id": 6,
        "Name": "Sample Name text."
      },
      "LicenseType": {
        "Id": 7,
        "Name": "Sample Name text."
      },
      "LicenseNumber": 1,
      "MedGuideFlag": true,
      "MedGuideId": 8,
      "DilutionFlag": true,
      "REMS": [
        {
          "Id": 9,
          "Name": "Sample Name text."
        },
        {
          "Id": 10,
          "Name": "Sample Name text."
        }
      ],
      "BoxedWarnings": [
        {
          "Id": 11,
          "Name": "Sample Name text."
        },
        {
          "Id": 12,
          "Name": "Sample Name text."
        }
      ]
    },
    {
      "Product": {
        "Name": "Sample Name text.",
        "IdType": "NDC9",
        "Id": "13"
      },
      "Package": {
        "Name": "Sample Name text.",
        "IdType": "UPCB",
        "Id": "14"
      },
      "DEAClassification": {
        "Id": 15,
        "Name": "Sample Name text."
      },
      "PatientPackageInsert": {
        "Id": 16,
        "Name": "Sample Name text."
      },
      "IVContainerMaterial": {
        "Id": 17,
        "Name": "Sample Name text."
      },
      "LegendStatus": {
        "Id": 18,
        "Name": "Sample Name text."
      },
      "LicenseType": {
        "Id": 19,
        "Name": "Sample Name text."
      },
      "LicenseNumber": 1,
      "MedGuideFlag": true,
      "MedGuideId": 20,
      "DilutionFlag": true,
      "REMS": [
        {
          "Id": 21,
          "Name": "Sample Name text."
        },
        {
          "Id": 22,
          "Name": "Sample Name text."
        }
      ],
      "BoxedWarnings": [
        {
          "Id": 23,
          "Name": "Sample Name text."
        },
        {
          "Id": 24,
          "Name": "Sample Name text."
        }
      ]
    }
  ]
}