POST api/v{version}/delegates/{delegateId}/clientsgroup
Gets the delegate client group information
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| delegateId |
The delegate making the request |
integer |
Required |
| version |
The requested API version |
string |
Required Default value is 2.0 |
Body Parameters
The request containing the search parameters
SearchDelegateGroupClientRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DelegateGroupIds |
The IDs of the delegate groups to search within. |
Collection of integer |
None. |
| IncludeExpired |
When set to true, clients with an expiry date in the past will be included as well. |
boolean |
None. |
| Offset |
The offset to the first result to return when using pagination. |
integer |
None. |
| Count |
The maximum number of results to return. |
integer |
None. |
| SearchTerm |
A string to use to filter the results (searches first/last name, client id, client code). |
string |
None. |
| SearchColumns |
List of columns to be search for provided criteria. |
Collection of string |
None. |
| UserDefinedFields |
List of user defined fields to fetch for client info data. |
Collection of string |
None. |
Request Formats
application/json, text/json, application/problem+json
Sample:
{
"delegateGroupIds": [
1,
2
],
"includeExpired": true,
"offset": 2,
"count": 3,
"searchTerm": "sample string 4",
"searchColumns": [
"sample string 1",
"sample string 2"
],
"userDefinedFields": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<SearchDelegateGroupClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
<Count>3</Count>
<DelegateGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</DelegateGroupIds>
<IncludeExpired>true</IncludeExpired>
<Offset>2</Offset>
<SearchColumns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</SearchColumns>
<SearchTerm>sample string 4</SearchTerm>
<UserDefinedFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</UserDefinedFields>
</SearchDelegateGroupClientRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of DelegateClientGroupInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientCount |
Gets or sets the total client count in delegate group |
integer |
None. |
| FilteredResultCount |
Gets or sets the no. of client count when filtered |
integer |
None. |
| Clients |
Gets or sets the client list received as a part of group info. |
Collection of DelegateClientInfo |
None. |
| DelegateGroupId |
The Delegate Group ID this info is for |
integer |
None. |
Response Formats
application/json, text/json, application/problem+json
Sample:
[
{
"clientCount": 1,
"filteredResultCount": 2,
"clients": [
{
"clientId": 1,
"clientCode": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"birthDate": "2026-07-17",
"startDate": "2026-07-17T14:16:27.0734733-04:00",
"expiryDate": "2026-07-17T14:16:27.0734733-04:00",
"dynamicallyAdded": true,
"phoneNumber": "sample string 6",
"userDefinedFields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"clientId": 1,
"clientCode": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"birthDate": "2026-07-17",
"startDate": "2026-07-17T14:16:27.0734733-04:00",
"expiryDate": "2026-07-17T14:16:27.0734733-04:00",
"dynamicallyAdded": true,
"phoneNumber": "sample string 6",
"userDefinedFields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"delegateGroupId": 1
},
{
"clientCount": 1,
"filteredResultCount": 2,
"clients": [
{
"clientId": 1,
"clientCode": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"birthDate": "2026-07-17",
"startDate": "2026-07-17T14:16:27.0734733-04:00",
"expiryDate": "2026-07-17T14:16:27.0734733-04:00",
"dynamicallyAdded": true,
"phoneNumber": "sample string 6",
"userDefinedFields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"clientId": 1,
"clientCode": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"birthDate": "2026-07-17",
"startDate": "2026-07-17T14:16:27.0734733-04:00",
"expiryDate": "2026-07-17T14:16:27.0734733-04:00",
"dynamicallyAdded": true,
"phoneNumber": "sample string 6",
"userDefinedFields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"delegateGroupId": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfDelegateClientGroupInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
<DelegateClientGroupInfo>
<ClientCount>1</ClientCount>
<Clients xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
<d3p1:DelegateClientInfo>
<d3p1:BirthDate>2026-07-17T14:16:27.0734733-04:00</d3p1:BirthDate>
<d3p1:ClientCode>sample string 2</d3p1:ClientCode>
<d3p1:ClientId>1</d3p1:ClientId>
<d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
<d3p1:ExpiryDate>2026-07-17T14:16:27.0734733-04:00</d3p1:ExpiryDate>
<d3p1:FirstName>sample string 3</d3p1:FirstName>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
<d3p1:StartDate>2026-07-17T14:16:27.0734733-04:00</d3p1:StartDate>
<d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 3</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
</d3p1:UserDefinedFields>
</d3p1:DelegateClientInfo>
<d3p1:DelegateClientInfo>
<d3p1:BirthDate>2026-07-17T14:16:27.0734733-04:00</d3p1:BirthDate>
<d3p1:ClientCode>sample string 2</d3p1:ClientCode>
<d3p1:ClientId>1</d3p1:ClientId>
<d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
<d3p1:ExpiryDate>2026-07-17T14:16:27.0734733-04:00</d3p1:ExpiryDate>
<d3p1:FirstName>sample string 3</d3p1:FirstName>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
<d3p1:StartDate>2026-07-17T14:16:27.0734733-04:00</d3p1:StartDate>
<d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 3</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
</d3p1:UserDefinedFields>
</d3p1:DelegateClientInfo>
</Clients>
<DelegateGroupId>1</DelegateGroupId>
<FilteredResultCount>2</FilteredResultCount>
</DelegateClientGroupInfo>
<DelegateClientGroupInfo>
<ClientCount>1</ClientCount>
<Clients xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
<d3p1:DelegateClientInfo>
<d3p1:BirthDate>2026-07-17T14:16:27.0734733-04:00</d3p1:BirthDate>
<d3p1:ClientCode>sample string 2</d3p1:ClientCode>
<d3p1:ClientId>1</d3p1:ClientId>
<d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
<d3p1:ExpiryDate>2026-07-17T14:16:27.0734733-04:00</d3p1:ExpiryDate>
<d3p1:FirstName>sample string 3</d3p1:FirstName>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
<d3p1:StartDate>2026-07-17T14:16:27.0734733-04:00</d3p1:StartDate>
<d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 3</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
</d3p1:UserDefinedFields>
</d3p1:DelegateClientInfo>
<d3p1:DelegateClientInfo>
<d3p1:BirthDate>2026-07-17T14:16:27.0734733-04:00</d3p1:BirthDate>
<d3p1:ClientCode>sample string 2</d3p1:ClientCode>
<d3p1:ClientId>1</d3p1:ClientId>
<d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
<d3p1:ExpiryDate>2026-07-17T14:16:27.0734733-04:00</d3p1:ExpiryDate>
<d3p1:FirstName>sample string 3</d3p1:FirstName>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
<d3p1:StartDate>2026-07-17T14:16:27.0734733-04:00</d3p1:StartDate>
<d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
<d5p1:KeyValueOfstringanyType>
<d5p1:Key>sample string 3</d5p1:Key>
<d5p1:Value />
</d5p1:KeyValueOfstringanyType>
</d3p1:UserDefinedFields>
</d3p1:DelegateClientInfo>
</Clients>
<DelegateGroupId>1</DelegateGroupId>
<FilteredResultCount>2</FilteredResultCount>
</DelegateClientGroupInfo>
</ArrayOfDelegateClientGroupInfo>