GET api/navigationlinks/{navigationLinkId}/canNavigate
Verifies if navigation link is active and return the permissions for it based on userid and navigationLinkId
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| navigationLinkId |
|
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
NavigationLinkWithPermissionsViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PageControls |
|
Collection of PageControlUserPageViewModel |
None. |
| NavigationLinkUrl |
|
string |
None. |
| Id |
Id |
integer |
None. |
| Name |
Name of the page |
string |
None. |
| CategoryId |
Parent category |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"pageControls": [
{
"hasAccess": true,
"name": "sample string 2",
"description": "sample string 3"
},
{
"hasAccess": true,
"name": "sample string 2",
"description": "sample string 3"
}
],
"navigationLinkUrl": "sample string 1",
"id": 2,
"name": "sample string 3",
"categoryId": 4
}
application/xml, text/xml
Sample:
<NavigationLinkWithPermissionsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
<CategoryId>4</CategoryId>
<Id>2</Id>
<Name>sample string 3</Name>
<NavigationLinkUrl>sample string 1</NavigationLinkUrl>
<PageControls>
<PageControlUserPageViewModel>
<Description>sample string 3</Description>
<HasAccess>true</HasAccess>
<Name>sample string 2</Name>
</PageControlUserPageViewModel>
<PageControlUserPageViewModel>
<Description>sample string 3</Description>
<HasAccess>true</HasAccess>
<Name>sample string 2</Name>
</PageControlUserPageViewModel>
</PageControls>
</NavigationLinkWithPermissionsViewModel>