POST api/ListSigAdditionalInstructions

Returns specific SIG details that a prescriber may use to further describe a SIG to improve compliance or enhance safety, based on the supplied filters. If available, returns SIG synonyms, commonly accepted abbreviations, and global (country-specific) terms. Includes a ‘MaxResults’ option that allows you to limit the number of results returned


Request Information

URI Parameters

None.

Body Parameters

ListSigAdditionalInstructionsRequest
NameDescriptionTypeAdditional information
FilterType The type of filter to search. SigAdditionalInstructionFilterEnum

None.
Filter The identifier or concept name to search. string

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": "SigAdditionalInstructionText",
  "Filter": "%name%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListSigAdditionalInstructionsResponse
NameDescriptionTypeAdditional information
SigAdditionalInstructions Returns the SIG additional instruction details, based on supplied filters. Collection of SigAdditionalInstruction

None.

Response Formats

application/json, text/json

Sample: 
{
  "SigAdditionalInstructions": [
    {
      "SigAdditionalInstructionId": 1,
      "AdditionalInstruction": "Sample AdditionalInstruction text.",
      "AdditionalInstructionSynonym": "Sample AdditionalInstructionSynonym text.",
      "CountrySpecificTerms": "Sample CountrySpecificTerms text."
    },
    {
      "SigAdditionalInstructionId": 2,
      "AdditionalInstruction": "Sample AdditionalInstruction text.",
      "AdditionalInstructionSynonym": "Sample AdditionalInstructionSynonym text.",
      "CountrySpecificTerms": "Sample CountrySpecificTerms text."
    }
  ]
}