GET api/accessrights?groupID={groupID}

Get the list of access rights for the authenticated user.

Request Information

URI Parameters

Name	Description	Type	Additional information
groupID	Access right group ID. Supply this if you want to retrieve access rights for a particular group.	integer	None.

Body Parameters

None.

Response Information

Resource Description

AccessRights

Collection of AccessRight

Name	Description	Type	Additional information
AccessRightID	The ID of the access right in database	integer	None.
AccessRightType	The corresponding enum id for the access right	enAccessRightType	None.
Description	The description of the access right type	string	None.
SecondObjectID	The object ID this access right has permission on	integer	None.
SecondObjectType	The object type this access right has permission on	enObjectType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AccessRightID": 1,
    "AccessRightType": 10000,
    "Description": "Access to Search functionality",
    "SecondObjectID": 2,
    "SecondObjectType": 3
  },
  {
    "AccessRightID": 2,
    "AccessRightType": 10001,
    "Description": "Can view a clients portfolio",
    "SecondObjectID": 2,
    "SecondObjectType": 3
  }
]

application/xml, text/xml

Sample:

<ArrayOfAccessRight xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.AccessRights">
  <AccessRight>
    <AccessRightID>1</AccessRightID>
    <AccessRightType>Search</AccessRightType>
    <Description>Access to Search functionality</Description>
    <SecondObjectID>2</SecondObjectID>
    <SecondObjectType>Licensee</SecondObjectType>
  </AccessRight>
  <AccessRight>
    <AccessRightID>2</AccessRightID>
    <AccessRightType>ClientPortfolioView</AccessRightType>
    <Description>Can view a clients portfolio</Description>
    <SecondObjectID>2</SecondObjectID>
    <SecondObjectType>Licensee</SecondObjectType>
  </AccessRight>
</ArrayOfAccessRight>

Error Response Information

Resource Description

AccessRights

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>