GET api/admin/v1/groups/search?q={q}&page={page}&pageSize={pageSize}

Search Group by Code or Description

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Body Parameters

None

Response Information

Resource Description

List of found Groups

Collection of GroupDto
NameDescriptionTypeAdditional information
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
Id

Unique ID

 integer

None

Response Formats

application/json, text/json

Sample: 
[
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "IsActive": true,
    "Id": 4
  },
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "IsActive": true,
    "Id": 4
  }
]

application/xml, text/xml

Sample: 
<ArrayOfGroupDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <GroupDto>
    <Id>4</Id>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <IsActive>true</IsActive>
  </GroupDto>
  <GroupDto>
    <Id>4</Id>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <IsActive>true</IsActive>
  </GroupDto>
</ArrayOfGroupDto>