GET api/Guideline/GetPublishedByRegion/{accessKey}/{regions}
Retrieves a list of published guidelines by publication Region(s)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accessKey | string |
Required |
|
regions | string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of published guidelines in json or xml depending on your accept header
GuidelinesResponseName | Description | Type | Additional information |
---|---|---|---|
Login | Login |
None. |
|
Guidelines | Collection of GuidelineViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Login": { "IsValid": true, "Message": "sample string 2" }, "Guidelines": [ { "GuidelineId": 1, "ExternalDiseaseId": "d529fd1f-4089-40a5-b74c-298fb98d336a", "Title": "sample string 1", "ShortName": "sample string 2", "Type": "sample string 3", "SubTypes": [ { "DiseaseId": 1, "DiseaseName": "sample string 2", "Id": "606c0b18-eff8-431c-8eed-ba798900a07c" }, { "DiseaseId": 1, "DiseaseName": "sample string 2", "Id": "606c0b18-eff8-431c-8eed-ba798900a07c" } ], "Reference": "sample string 4", "Version": "sample string 5", "LastPublishedDate": "2024-11-23T17:30:44.2797737-05:00", "Language": "sample string 6", "PublishedForRegion": "sample string 7", "GuidelinePanelId": 1 }, { "GuidelineId": 1, "ExternalDiseaseId": "d529fd1f-4089-40a5-b74c-298fb98d336a", "Title": "sample string 1", "ShortName": "sample string 2", "Type": "sample string 3", "SubTypes": [ { "DiseaseId": 1, "DiseaseName": "sample string 2", "Id": "606c0b18-eff8-431c-8eed-ba798900a07c" }, { "DiseaseId": 1, "DiseaseName": "sample string 2", "Id": "606c0b18-eff8-431c-8eed-ba798900a07c" } ], "Reference": "sample string 4", "Version": "sample string 5", "LastPublishedDate": "2024-11-23T17:30:44.2797737-05:00", "Language": "sample string 6", "PublishedForRegion": "sample string 7", "GuidelinePanelId": 1 } ] }
application/xml, text/xml
Sample:
<GuidelinesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCCN.Webservice.Compendia.Models"> <Guidelines xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCCN.Webservice.Compendia.ViewModel"> <d2p1:GuidelineViewModel> <d2p1:ExternalDiseaseId>d529fd1f-4089-40a5-b74c-298fb98d336a</d2p1:ExternalDiseaseId> <d2p1:GuidelineId>1</d2p1:GuidelineId> <d2p1:GuidelinePanelId>1</d2p1:GuidelinePanelId> <d2p1:Language>sample string 6</d2p1:Language> <d2p1:LastPublishedDate>2024-11-23T17:30:44.2797737-05:00</d2p1:LastPublishedDate> <d2p1:PublishedForRegion>sample string 7</d2p1:PublishedForRegion> <d2p1:Reference>sample string 4</d2p1:Reference> <d2p1:ShortName>sample string 2</d2p1:ShortName> <d2p1:SubTypes> <Disease> <DiseaseId>1</DiseaseId> <DiseaseName>sample string 2</DiseaseName> <Id>606c0b18-eff8-431c-8eed-ba798900a07c</Id> </Disease> <Disease> <DiseaseId>1</DiseaseId> <DiseaseName>sample string 2</DiseaseName> <Id>606c0b18-eff8-431c-8eed-ba798900a07c</Id> </Disease> </d2p1:SubTypes> <d2p1:Title>sample string 1</d2p1:Title> <d2p1:Type>sample string 3</d2p1:Type> <d2p1:Version>sample string 5</d2p1:Version> </d2p1:GuidelineViewModel> <d2p1:GuidelineViewModel> <d2p1:ExternalDiseaseId>d529fd1f-4089-40a5-b74c-298fb98d336a</d2p1:ExternalDiseaseId> <d2p1:GuidelineId>1</d2p1:GuidelineId> <d2p1:GuidelinePanelId>1</d2p1:GuidelinePanelId> <d2p1:Language>sample string 6</d2p1:Language> <d2p1:LastPublishedDate>2024-11-23T17:30:44.2797737-05:00</d2p1:LastPublishedDate> <d2p1:PublishedForRegion>sample string 7</d2p1:PublishedForRegion> <d2p1:Reference>sample string 4</d2p1:Reference> <d2p1:ShortName>sample string 2</d2p1:ShortName> <d2p1:SubTypes> <Disease> <DiseaseId>1</DiseaseId> <DiseaseName>sample string 2</DiseaseName> <Id>606c0b18-eff8-431c-8eed-ba798900a07c</Id> </Disease> <Disease> <DiseaseId>1</DiseaseId> <DiseaseName>sample string 2</DiseaseName> <Id>606c0b18-eff8-431c-8eed-ba798900a07c</Id> </Disease> </d2p1:SubTypes> <d2p1:Title>sample string 1</d2p1:Title> <d2p1:Type>sample string 3</d2p1:Type> <d2p1:Version>sample string 5</d2p1:Version> </d2p1:GuidelineViewModel> </Guidelines> <Login> <IsValid>true</IsValid> <Message>sample string 2</Message> </Login> </GuidelinesResponse>