GET api/navigationlinks?sourceName={sourceName}&categoryName={categoryName}&linkName={linkName}&isEnabled={isEnabled}
Preforms a search by the given paramters returning all matching navigation links
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
sourceName |
|
string |
None. |
categoryName |
|
string |
None. |
linkName |
|
string |
None. |
isEnabled |
|
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of NavigationLinkViewModelName | Description | Type | Additional information |
---|---|---|---|
IsJobStreamEnabled |
|
boolean |
None. |
Link |
|
string |
None. |
IsEnabled |
|
boolean |
None. |
PageControls |
|
Collection of PageControlViewModel |
None. |
Id |
Id |
integer |
None. |
Name |
Name of the page |
string |
None. |
CategoryId |
Parent category |
integer |
None. |
Response Formats
application/json, text/json
[ { "isJobStreamEnabled": true, "link": "sample string 2", "isEnabled": true, "pageControls": [ { "id": 1, "name": "sample string 2", "description": "sample string 3", "navigationLinkId": 1 }, { "id": 1, "name": "sample string 2", "description": "sample string 3", "navigationLinkId": 1 } ], "id": 4, "name": "sample string 5", "categoryId": 6 }, { "isJobStreamEnabled": true, "link": "sample string 2", "isEnabled": true, "pageControls": [ { "id": 1, "name": "sample string 2", "description": "sample string 3", "navigationLinkId": 1 }, { "id": 1, "name": "sample string 2", "description": "sample string 3", "navigationLinkId": 1 } ], "id": 4, "name": "sample string 5", "categoryId": 6 } ]
application/xml, text/xml
<ArrayOfNavigationLinkViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels"> <NavigationLinkViewModel> <CategoryId>6</CategoryId> <Id>4</Id> <Name>sample string 5</Name> <IsEnabled>true</IsEnabled> <IsJobStreamEnabled>true</IsJobStreamEnabled> <Link>sample string 2</Link> <PageControls> <PageControlViewModel> <Description>sample string 3</Description> <Id>1</Id> <Name>sample string 2</Name> <NavigationLinkId>1</NavigationLinkId> </PageControlViewModel> <PageControlViewModel> <Description>sample string 3</Description> <Id>1</Id> <Name>sample string 2</Name> <NavigationLinkId>1</NavigationLinkId> </PageControlViewModel> </PageControls> </NavigationLinkViewModel> <NavigationLinkViewModel> <CategoryId>6</CategoryId> <Id>4</Id> <Name>sample string 5</Name> <IsEnabled>true</IsEnabled> <IsJobStreamEnabled>true</IsJobStreamEnabled> <Link>sample string 2</Link> <PageControls> <PageControlViewModel> <Description>sample string 3</Description> <Id>1</Id> <Name>sample string 2</Name> <NavigationLinkId>1</NavigationLinkId> </PageControlViewModel> <PageControlViewModel> <Description>sample string 3</Description> <Id>1</Id> <Name>sample string 2</Name> <NavigationLinkId>1</NavigationLinkId> </PageControlViewModel> </PageControls> </NavigationLinkViewModel> </ArrayOfNavigationLinkViewModel>