GET OneStop/Groups/{GroupName}?ExactMatch={ExactMatch}

Gets a list of groups with name matching provided name

Request Information

URI Parameters

Name	Description	Type	Additional information
GroupName	Name of groups to search for	string	Required
ExactMatch	If true name has to match exactly. If false group name only needs to contain supplied value	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of GroupSummaryDTO

Name	Description	Type	Additional information
GroupID	Auto generated	integer	Required
GroupName	Name of group	string	Required
GroupPath	Dot seperated path, starting from system group. example 0.5.19	string	Read Only
Description	Description of group	string	None.
ServiceProviderID		integer	None.
FullPath		string	None.
IsSystemGroup		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "GroupID": 1,
    "GroupName": "sample string 2",
    "GroupPath": null,
    "Description": "sample string 3",
    "ServiceProviderID": 4,
    "FullPath": "sample string 5",
    "IsSystemGroup": true
  },
  {
    "GroupID": 1,
    "GroupName": "sample string 2",
    "GroupPath": null,
    "Description": "sample string 3",
    "ServiceProviderID": 4,
    "FullPath": "sample string 5",
    "IsSystemGroup": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroupSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
  <GroupSummaryDTO>
    <Description>sample string 3</Description>
    <FullPath>sample string 5</FullPath>
    <GroupID>1</GroupID>
    <GroupName>sample string 2</GroupName>
    <IsSystemGroup>true</IsSystemGroup>
    <ServiceProviderID>4</ServiceProviderID>
  </GroupSummaryDTO>
  <GroupSummaryDTO>
    <Description>sample string 3</Description>
    <FullPath>sample string 5</FullPath>
    <GroupID>1</GroupID>
    <GroupName>sample string 2</GroupName>
    <IsSystemGroup>true</IsSystemGroup>
    <ServiceProviderID>4</ServiceProviderID>
  </GroupSummaryDTO>
</ArrayOfGroupSummaryDTO>