POST api/ListStateLegendStatus

Returns the State Legend Status prescription (Rx) and over-the-counter (OTC) drug products in the United States, based on supplied product and state filters. Only returns a value when a submitted Gold Standard Product Identifier does have an overriding legend status for the supplied state.


Request Information

URI Parameters

None.

Body Parameters

ListStateLegendStatusRequest
NameDescriptionTypeAdditional information
StateId State (abbreviation) identifier. string

Required

ProductId Input parameters for any product identifiers passed into the request ProductIdentifier

Required

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:
{
  "StateId": "FL",
  "ProductId": {
    "IdType": "NDC9",
    "Id": "12345-0001"
  },
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListStateLegendStatusResponse
NameDescriptionTypeAdditional information
LegendStatuses Returns the output parameters for the State Legend Status. Collection of IdentifierName

None.

Response Formats

application/json, text/json

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