POST api/userrolemapconfig/get

Returns all User Role Mappings in specific Account context and provided Source Type

Request Information

URI Parameters

None.

Body Parameters

GetUserRoleMapConfigsRequest
NameDescriptionTypeAdditional information
ImportSourceType

integer

None.

Filters

Dictionary of string [key] and FilterValue [value]

None.

SortFields

Dictionary of string [key] and OrderType [value]

None.

AvailablePageSizes

Collection of integer

None.

PageSize

integer

None.

PageIndex

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ImportSourceType": 1,
  "Filters": {},
  "SortFields": {},
  "AvailablePageSizes": [
    10,
    50,
    100
  ],
  "PageSize": 2,
  "PageIndex": 3
}

application/xml, text/xml

Sample:
<GetUserRoleMapConfigsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.GetRequests">
  <AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
    <d2p1:int>10</d2p1:int>
    <d2p1:int>50</d2p1:int>
    <d2p1:int>100</d2p1:int>
  </AvailablePageSizes>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request" />
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">2</PageSize>
  <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request" />
  <ImportSourceType>1</ImportSourceType>
</GetUserRoleMapConfigsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiCollectionResponseOfIEnumerableOfGetUserRoleMapConfigResponse
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Errors

Collection of string

None.

Data

Collection of GetUserRoleMapConfigResponse

None.

Filters

Dictionary of string [key] and FilterValue [value]

None.

SortFields

Dictionary of string [key] and OrderType [value]

None.

AvailablePageSizes

Collection of integer

None.

PageSize

integer

None.

PageIndex

integer

None.

Total

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "Id": "c80cb9d8-178f-4324-bad5-0c7a7dc3215a",
      "UserRoleId": "deb22ab7-6abd-4ee4-a78f-fef65b5c0fd1",
      "UserRole": {
        "Id": "a4958b9a-4316-4edd-abb5-cc0fd5f33613",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "UserRoleType": 4,
        "DisplayName": "sample string 5"
      },
      "ImportSourceType": 3,
      "SourceUserRoleId": 4,
      "SourceUserRoleName": "sample string 5"
    },
    {
      "Id": "c80cb9d8-178f-4324-bad5-0c7a7dc3215a",
      "UserRoleId": "deb22ab7-6abd-4ee4-a78f-fef65b5c0fd1",
      "UserRole": {
        "Id": "a4958b9a-4316-4edd-abb5-cc0fd5f33613",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "UserRoleType": 4,
        "DisplayName": "sample string 5"
      },
      "ImportSourceType": 3,
      "SourceUserRoleId": 4,
      "SourceUserRoleName": "sample string 5"
    }
  ],
  "Filters": {
    "sample string 1": {
      "Value": "sample string 1",
      "FilterType": 0
    },
    "sample string 2": {
      "Value": "sample string 1",
      "FilterType": 0
    }
  },
  "SortFields": {
    "sample string 1": 0,
    "sample string 2": 0
  },
  "AvailablePageSizes": [
    10,
    50,
    100
  ],
  "PageSize": 2,
  "PageIndex": 3,
  "Total": 4
}

application/xml, text/xml

Sample:
<ApiCollectionResponseOfArrayOfGetUserRoleMapConfigResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Response">
  <AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>10</d2p1:int>
    <d2p1:int>50</d2p1:int>
    <d2p1:int>100</d2p1:int>
  </AvailablePageSizes>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
    <d2p1:GetUserRoleMapConfigResponse>
      <d2p1:Id>c80cb9d8-178f-4324-bad5-0c7a7dc3215a</d2p1:Id>
      <d2p1:ImportSourceType>3</d2p1:ImportSourceType>
      <d2p1:SourceUserRoleId>4</d2p1:SourceUserRoleId>
      <d2p1:SourceUserRoleName>sample string 5</d2p1:SourceUserRoleName>
      <d2p1:UserRole>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
        <d2p1:Id>a4958b9a-4316-4edd-abb5-cc0fd5f33613</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:UserRoleType>4</d2p1:UserRoleType>
      </d2p1:UserRole>
      <d2p1:UserRoleId>deb22ab7-6abd-4ee4-a78f-fef65b5c0fd1</d2p1:UserRoleId>
    </d2p1:GetUserRoleMapConfigResponse>
    <d2p1:GetUserRoleMapConfigResponse>
      <d2p1:Id>c80cb9d8-178f-4324-bad5-0c7a7dc3215a</d2p1:Id>
      <d2p1:ImportSourceType>3</d2p1:ImportSourceType>
      <d2p1:SourceUserRoleId>4</d2p1:SourceUserRoleId>
      <d2p1:SourceUserRoleName>sample string 5</d2p1:SourceUserRoleName>
      <d2p1:UserRole>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
        <d2p1:Id>a4958b9a-4316-4edd-abb5-cc0fd5f33613</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:UserRoleType>4</d2p1:UserRoleType>
      </d2p1:UserRole>
      <d2p1:UserRoleId>deb22ab7-6abd-4ee4-a78f-fef65b5c0fd1</d2p1:UserRoleId>
    </d2p1:GetUserRoleMapConfigResponse>
  </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>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
        <d4p1:FilterType>None</d4p1:FilterType>
        <d4p1:Value>sample string 1</d4p1:Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
    <d2p1:KeyValueOfstringFilterValueN3g1kdQt>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
        <d4p1:FilterType>None</d4p1:FilterType>
        <d4p1:Value>sample string 1</d4p1:Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringFilterValueN3g1kdQt>
  </Filters>
  <IsSuccess>true</IsSuccess>
  <PageIndex>3</PageIndex>
  <PageSize>2</PageSize>
  <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringOrderTypevpR9PHaG>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfstringOrderTypevpR9PHaG>
    <d2p1:KeyValueOfstringOrderTypevpR9PHaG>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfstringOrderTypevpR9PHaG>
  </SortFields>
  <Total>4</Total>
</ApiCollectionResponseOfArrayOfGetUserRoleMapConfigResponseLgVmlFmJ>