GET api/Group?groupName={groupName}&type={type}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupName

string

Required

type

integer

Required

Body Parameters

None.

Response Information

Resource Description

GroupDTO
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

Required

Matching regular expression pattern: ([a-zA-Z]).{3,50}$|[\u0621-\u064A].{3,50}$

String length: inclusive between 2 and 50

NameOther

string

Required

Matching regular expression pattern: ([a-zA-Z]).{3,50}$|[\u0621-\u064A].{3,50}$

String length: inclusive between 2 and 50

Description

string

String length: inclusive between 0 and 225

DescriptionOther

string

String length: inclusive between 0 and 225

IsActive

boolean

Required

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "NameOther": "sample string 3",
  "Description": "sample string 4",
  "DescriptionOther": "sample string 5",
  "IsActive": true
}

application/xml, text/xml

Sample:
<GroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Components.UserManagement.DTO">
  <Description>sample string 4</Description>
  <DescriptionOther>sample string 5</DescriptionOther>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <Name>sample string 2</Name>
  <NameOther>sample string 3</NameOther>
</GroupDTO>