POST api/ListSigUnits

Returns SIG codes and text for SIG units of measure, along with associated SNOMED codes, based on supplied input filters. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.


Request Information

URI Parameters

None.

Body Parameters

ListSigUnitsRequest
NameDescriptionTypeAdditional information
FilterType The type of filter to search. This is ignored if the Filter is not set. SigUnitFilterEnum

None.
Filter The identifier or concept name to search. This is ignored if the FilterType is not set. 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": "SigUnitText",
  "Filter": "%name%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListSigUnitsResponse
NameDescriptionTypeAdditional information
SigUnits Returns the output parameters for the SIG unit type details, based on supplied filters. Collection of SigUnit

None.

Response Formats

application/json, text/json

Sample: 
{
  "SigUnits": [
    {
      "SigUnitId": 1,
      "SNOMEDCT": "Sample SNOMEDCT text.",
      "UnitName": "Sample UnitName text.",
      "UnitNamePlural": "Sample UnitNamePlural text.",
      "Synonym": "Sample Synonym text.",
      "SynonymPlural": "Sample SynonymPlural text.",
      "TimeUnit": true,
      "SigRouteCategories": [
        {
          "Id": 2,
          "Name": "Sample Name text."
        },
        {
          "Id": 3,
          "Name": "Sample Name text."
        }
      ]
    },
    {
      "SigUnitId": 4,
      "SNOMEDCT": "Sample SNOMEDCT text.",
      "UnitName": "Sample UnitName text.",
      "UnitNamePlural": "Sample UnitNamePlural text.",
      "Synonym": "Sample Synonym text.",
      "SynonymPlural": "Sample SynonymPlural text.",
      "TimeUnit": true,
      "SigRouteCategories": [
        {
          "Id": 5,
          "Name": "Sample Name text."
        },
        {
          "Id": 6,
          "Name": "Sample Name text."
        }
      ]
    }
  ]
}