POST api/ListSigRoutesOfAdministration

Returns SIG Route information, along with SNOMED codes. Maps Gold Standard’s routes of administration and SNOMED codes to SIG high-level route category information, based on supplied filters Includes a ‘MaxResults’ option that allows you to limit the number of results returned.


Request Information

URI Parameters

None.

Body Parameters

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

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

Response Information

Resource Description

ListSigRoutesOfAdministrationResponse
NameDescriptionTypeAdditional information
SigRoutesOfAdministration Returns the output parameters for the SIG routes of administration details, based on supplied filters. Collection of SigRouteOfAdministration

None.

Response Formats

application/json, text/json

Sample: 
{
  "SigRoutesOfAdministration": [
    {
      "RouteId": 1,
      "RouteName": "Sample RouteName text.",
      "RouteDescription": "Sample RouteDescription text.",
      "SNOMEDCT": "Sample SNOMEDCT text.",
      "SigRouteSynonym": "Sample SigRouteSynonym text.",
      "SigAbbreviation": "Sample SigAbbreviation text.",
      "SigRouteCategories": [
        {
          "Id": 2,
          "Name": "Sample Name text."
        },
        {
          "Id": 3,
          "Name": "Sample Name text."
        }
      ]
    },
    {
      "RouteId": 4,
      "RouteName": "Sample RouteName text.",
      "RouteDescription": "Sample RouteDescription text.",
      "SNOMEDCT": "Sample SNOMEDCT text.",
      "SigRouteSynonym": "Sample SigRouteSynonym text.",
      "SigAbbreviation": "Sample SigAbbreviation text.",
      "SigRouteCategories": [
        {
          "Id": 5,
          "Name": "Sample Name text."
        },
        {
          "Id": 6,
          "Name": "Sample Name text."
        }
      ]
    }
  ]
}