GET api/admin/v1/roles/search?q={q}&page={page}&pageSize={pageSize}&sortField={sortField}&sortAscending={sortAscending}
Search roles by code or description
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| q |
Text to search (code, description) |
string |
Required |
| page |
Current page |
integer |
Default value is 1 |
| pageSize |
Page size |
integer |
Default value is 50 |
| sortField |
Name of the field to use for sorting |
string |
Default value is |
| sortAscending |
True for ascending sorting, false otherwise |
boolean |
Default value is True |
Body Parameters
None
Response Information
Resource Description
List of found roles
Collection of RoleDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Weight |
Weight of the role |
integer |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Permissions |
Permissions |
PermissionDto |
None |
| CreationDate |
Creation |
date |
None |
| CreatedBy |
The user who has made the insert |
UserMinDto |
None |
| LastUpdateDate |
Date of the last update |
date |
None |
| LastUpdatedBy |
The user who has made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
[
{
"Weight": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-21T10:39:59.0285417+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-21T10:39:59.0285417+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 5
},
{
"Weight": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-21T10:39:59.0285417+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-21T10:39:59.0285417+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 5
}
]
application/xml, text/xml
Sample:
<ArrayOfRoleDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<RoleDto>
<Id>5</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-21T10:39:59.0285417+01:00</CreationDate>
<LastUpdateDate>2024-11-21T10:39:59.0285417+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 2</Code>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Weight>1</Weight>
</RoleDto>
<RoleDto>
<Id>5</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-21T10:39:59.0285417+01:00</CreationDate>
<LastUpdateDate>2024-11-21T10:39:59.0285417+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 2</Code>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Weight>1</Weight>
</RoleDto>
</ArrayOfRoleDto>