GET api/delegategroups/{delegateGroupId}/clients?includeExpired={includeExpired}&offset={offset}&count={count}&searchTerm={searchTerm}&searchColumns[0]={searchColumns[0]}&searchColumns[1]={searchColumns[1]}&userDefinedFields[0]={userDefinedFields[0]}&userDefinedFields[1]={userDefinedFields[1]}

Gets the clients that are associated with a delegate group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
delegateGroupId

The delegate group to get clients for.

integer

Required

includeExpired

When set to true, clients with an expiry date in the past will be included as well.

boolean

Default value is False

offset

The offset to the first result to return

integer

Default value is 0

count

The maximum number of results to return

integer

Default value is 25

searchTerm

A string to use to filter the results (searches first/last name, client id, client code)

string

Default value is

searchColumns

List of columns to be search for provided criteria

Collection of string

None.

userDefinedFields

List of user defind fields to fetch for client info data

Collection of string

None.

Body Parameters

None.

Response Information

Resource Description

Returns basic information about the clients in the group.

Collection of DelegateClientInfo
NameDescriptionTypeAdditional information
ClientId

The ID of the client (matches Pass/Novus client id)

integer

None.

ClientCode

The client's code

string

None.

FirstName

The client's first name

string

None.

LastName

The client's last name

string

None.

BirthDate

The client's birth date (if known)

date

None.

StartDate

The date that the client began as a member of the delegate group Delegates will not be able to see the client's history before this time

date

None.

ExpiryDate

The date that the client is no longer valid in the group

date

None.

DynamicallyAdded

Gets whether this client was associated with its delegate group using a dynamic rule rather than being added individually.

boolean

None.

PhoneNumber

Gets or sets clients phone number

string

None.

UserDefinedFields

Gets user defined fields for this client

Dictionary of string [key] and Object [value]

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "clientId": 1,
    "clientCode": "sample string 2",
    "firstName": "sample string 3",
    "lastName": "sample string 4",
    "birthDate": "2021-06-24",
    "startDate": "2021-06-24T03:38:23.5836668-06:00",
    "expiryDate": "2021-06-24T03:38:23.5836668-06: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": "2021-06-24",
    "startDate": "2021-06-24T03:38:23.5836668-06:00",
    "expiryDate": "2021-06-24T03:38:23.5836668-06:00",
    "dynamicallyAdded": true,
    "phoneNumber": "sample string 6",
    "userDefinedFields": {
      "sample string 1": {},
      "sample string 3": {}
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfDelegateClientInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <DelegateClientInfo>
    <BirthDate>2021-06-24T03:38:23.5836668-06:00</BirthDate>
    <ClientCode>sample string 2</ClientCode>
    <ClientId>1</ClientId>
    <DynamicallyAdded>true</DynamicallyAdded>
    <ExpiryDate>2021-06-24T03:38:23.5836668-06:00</ExpiryDate>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <PhoneNumber>sample string 6</PhoneNumber>
    <StartDate>2021-06-24T03:38:23.5836668-06:00</StartDate>
    <UserDefinedFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </UserDefinedFields>
  </DelegateClientInfo>
  <DelegateClientInfo>
    <BirthDate>2021-06-24T03:38:23.5836668-06:00</BirthDate>
    <ClientCode>sample string 2</ClientCode>
    <ClientId>1</ClientId>
    <DynamicallyAdded>true</DynamicallyAdded>
    <ExpiryDate>2021-06-24T03:38:23.5836668-06:00</ExpiryDate>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <PhoneNumber>sample string 6</PhoneNumber>
    <StartDate>2021-06-24T03:38:23.5836668-06:00</StartDate>
    <UserDefinedFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </UserDefinedFields>
  </DelegateClientInfo>
</ArrayOfDelegateClientInfo>