POST api/ListWarningLabels

Returns Drug Auxiliary Warning Labels text and warning label vendor codes, based on the supplied filter criteria. Optionally returns short version warning label text, based on supplied filters. Contains warning label data in multiple languages (English, Spanish, and French). Includes a ‘MaxResults’ option that allows you to limit the number of results returned. Enables access to Auxiliary Warning Labels for extemporaneous compounds that would not otherwise have associated warning labels in the DrugToWarningLable response.


Request Information

URI Parameters

None.

Body Parameters

ListWarningLabelsRequest
NameDescriptionTypeAdditional information
FilterType The type of identifier or name to filter for. WarningLabelFilterEnum

Required
Filter The identifier or name to filter or search for. string

Required
LanguageCode The language code for the warning label. string

Required
VendorId If this is set, only warning label information for the identifier vendor will be returned. integer

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": "WarningLabelText",
  "Filter": "%name%",
  "LanguageCode": "en-US",
  "VendorId": 1,
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListWarningLabelsResponse
NameDescriptionTypeAdditional information
WarningLabels A collection of drug auxiliary warning Labels text and warning label vendor code parameters, based on the supplied filter criteria. Collection of WarningLabelVendorInfo

None.

Response Formats

application/json, text/json

Sample: 
{
  "WarningLabels": [
    {
      "WarningLabelId": 1,
      "WarningLabelText": "Sample WarningLabelText text.",
      "WarningLabelTextShort": "Sample WarningLabelTextShort text.",
      "VendorCode": [
        "Sample VendorCode text.",
        "Sample VendorCode text."
      ]
    },
    {
      "WarningLabelId": 2,
      "WarningLabelText": "Sample WarningLabelText text.",
      "WarningLabelTextShort": "Sample WarningLabelTextShort text.",
      "VendorCode": [
        "Sample VendorCode text.",
        "Sample VendorCode text."
      ]
    }
  ]
}