GET api/userRolesForOwnerType?ownerType={ownerType}

Returns user roles in specific account context for provided owner type

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ownerType

OwnerType

Required

Body Parameters

None.

Response Information

Resource Description

ApiCollectionResponseOfGetUserRoleResponse
NameDescriptionTypeAdditional information
PageSize

integer

None.

PageIndex

integer

None.

Total

integer

None.

SearchBy

Collection of Filter

None.

SortBy

Collection of Sort

None.

Data

Collection of GetUserRoleResponse

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "PageSize": 1,
  "PageIndex": 2,
  "Total": 3,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ],
  "Data": [
    {
      "Id": "504c8acd-c3ba-4080-922d-c5b6d15f533a",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "UserRoleType": 4,
      "DisplayName": "sample string 5"
    },
    {
      "Id": "504c8acd-c3ba-4080-922d-c5b6d15f533a",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "UserRoleType": 4,
      "DisplayName": "sample string 5"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ApiCollectionResponseOfGetUserRoleResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
    <d2p1:GetUserRoleResponse>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:Id>504c8acd-c3ba-4080-922d-c5b6d15f533a</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:UserRoleType>4</d2p1:UserRoleType>
    </d2p1:GetUserRoleResponse>
    <d2p1:GetUserRoleResponse>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:Id>504c8acd-c3ba-4080-922d-c5b6d15f533a</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:UserRoleType>4</d2p1:UserRoleType>
    </d2p1:GetUserRoleResponse>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <PageIndex>2</PageIndex>
  <PageSize>1</PageSize>
  <SearchBy>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
  <Total>3</Total>
</ApiCollectionResponseOfGetUserRoleResponseLgVmlFmJ>