POST api/ListAllergySubstanceClasses

Returns a list of all allergy substance classes used in the Gold Standard Drug Database, along with their internal identifiers. Results can be filtered by setting the NameFilter for the desired allergy substance class name. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.


Request Information

URI Parameters

None.

Body Parameters

ListAllergySubstanceClassesRequest
NameDescriptionTypeAdditional information
NameFilter Optional name filter. Only those records with names matching the filter are returned if set. Accepts full or partial (with a wildcard ‘%’) values as filters. 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: 
{
  "NameFilter": "%name%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListAllergySubstanceClassesResponse
NameDescriptionTypeAdditional information
AllergySubstanceClasses Returns the output parameters for the allergy substance classes used in the Gold Standard Drug Database, along with their internal identifiers. Collection of IdentifierName

None.

Response Formats

application/json, text/json

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