GET api/users/{userId}/navigationlinks/{linkId}/pagecontrols/access

This method allows to retrieve the user access to the page controls of a link

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

integer

Required

linkId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PageControlAccessViewModel
NameDescriptionTypeAdditional information
HasAccess

Access of the user to the control

boolean

None.

Id

Id

integer

None.

Name

Control Name, also used to represent the id of the UI element

string

None.

Description

Description of the control/action

string

None.

NavigationLinkId

Page or link where the control/action resides

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "hasAccess": true,
    "id": 2,
    "name": "sample string 3",
    "description": "sample string 4",
    "navigationLinkId": 1
  },
  {
    "hasAccess": true,
    "id": 2,
    "name": "sample string 3",
    "description": "sample string 4",
    "navigationLinkId": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfPageControlAccessViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <PageControlAccessViewModel>
    <Description>sample string 4</Description>
    <Id>2</Id>
    <Name>sample string 3</Name>
    <NavigationLinkId>1</NavigationLinkId>
    <HasAccess>true</HasAccess>
  </PageControlAccessViewModel>
  <PageControlAccessViewModel>
    <Description>sample string 4</Description>
    <Id>2</Id>
    <Name>sample string 3</Name>
    <NavigationLinkId>1</NavigationLinkId>
    <HasAccess>true</HasAccess>
  </PageControlAccessViewModel>
</ArrayOfPageControlAccessViewModel>