GET Roles?moduleKey={moduleKey}

Gets all roles for an System Entity module.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
moduleKey

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of RoleModel
NameDescriptionTypeAdditional information
Name

string

Required

String length: inclusive between 2 and 255

Description

string

String length: inclusive between 4 and 255

PermissionList

Collection of PermissionModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "PermissionList": [
      {
        "IsCustom": true,
        "Name": "sample string 2",
        "Description": "sample string 3",
        "DisplayName": "sample string 4",
        "AllowIdentification": true
      },
      {
        "IsCustom": true,
        "Name": "sample string 2",
        "Description": "sample string 3",
        "DisplayName": "sample string 4",
        "AllowIdentification": true
      }
    ]
  },
  {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "PermissionList": [
      {
        "IsCustom": true,
        "Name": "sample string 2",
        "Description": "sample string 3",
        "DisplayName": "sample string 4",
        "AllowIdentification": true
      },
      {
        "IsCustom": true,
        "Name": "sample string 2",
        "Description": "sample string 3",
        "DisplayName": "sample string 4",
        "AllowIdentification": true
      }
    ]
  }
]

text/html

Sample:
[{"Name":"sample string 1","Description":"sample string 2","PermissionList":[{"IsCustom":true,"Name":"sample string 2","Description":"sample string 3","DisplayName":"sample string 4","AllowIdentification":true},{"IsCustom":true,"Name":"sample string 2","Description":"sample string 3","DisplayName":"sample string 4","AllowIdentification":true}]},{"Name":"sample string 1","Description":"sample string 2","PermissionList":[{"IsCustom":true,"Name":"sample string 2","Description":"sample string 3","DisplayName":"sample string 4","AllowIdentification":true},{"IsCustom":true,"Name":"sample string 2","Description":"sample string 3","DisplayName":"sample string 4","AllowIdentification":true}]}]

application/xml, text/xml

Sample:
<ArrayOfRoleModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.TEF.Common.ViewModels.Membership">
  <RoleModel>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <PermissionList>
      <PermissionModel>
        <AllowIdentification>true</AllowIdentification>
        <Description>sample string 3</Description>
        <DisplayName>sample string 4</DisplayName>
        <Name>sample string 2</Name>
        <IsCustom>true</IsCustom>
      </PermissionModel>
      <PermissionModel>
        <AllowIdentification>true</AllowIdentification>
        <Description>sample string 3</Description>
        <DisplayName>sample string 4</DisplayName>
        <Name>sample string 2</Name>
        <IsCustom>true</IsCustom>
      </PermissionModel>
    </PermissionList>
  </RoleModel>
  <RoleModel>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <PermissionList>
      <PermissionModel>
        <AllowIdentification>true</AllowIdentification>
        <Description>sample string 3</Description>
        <DisplayName>sample string 4</DisplayName>
        <Name>sample string 2</Name>
        <IsCustom>true</IsCustom>
      </PermissionModel>
      <PermissionModel>
        <AllowIdentification>true</AllowIdentification>
        <Description>sample string 3</Description>
        <DisplayName>sample string 4</DisplayName>
        <Name>sample string 2</Name>
        <IsCustom>true</IsCustom>
      </PermissionModel>
    </PermissionList>
  </RoleModel>
</ArrayOfRoleModel>

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.