POST api/delegategroups/{delegateGroupId}/clients

Adds a client to a delegate group, or updates an existing association with a new expiry date.

Request Information

URI Parameters

Name	Description	Type	Additional information
delegateGroupId	The delegate group to add the client to.	integer	Required

Body Parameters

The information about the delegate-client association to make.

DelegateGroupClient

Name	Description	Type	Additional information
ClientId	The ID of the client (matches Pass/Novus client id)	integer	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 association is no longer valid	date	None.

Request Formats

application/json, text/json

Sample:

{
  "clientId": 1,
  "startDate": "2024-12-23T12:16:59.1468079-07:00",
  "expiryDate": "2024-12-23T12:16:59.1468079-07:00"
}

application/xml, text/xml

Sample:

<DelegateGroupClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <ClientId>1</ClientId>
  <ExpiryDate>2024-12-23T12:16:59.1468079-07:00</ExpiryDate>
  <StartDate>2024-12-23T12:16:59.1468079-07:00</StartDate>
</DelegateGroupClient>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the delegate group-client association (with a bit of extra information).

DelegateClientInfo

Name	Description	Type	Additional 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": "2024-12-23",
  "startDate": "2024-12-23T12:16:59.1498103-07:00",
  "expiryDate": "2024-12-23T12:16:59.1498103-07:00",
  "dynamicallyAdded": true,
  "phoneNumber": "sample string 6",
  "userDefinedFields": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample:

<DelegateClientInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <BirthDate>2024-12-23T12:16:59.1498103-07:00</BirthDate>
  <ClientCode>sample string 2</ClientCode>
  <ClientId>1</ClientId>
  <DynamicallyAdded>true</DynamicallyAdded>
  <ExpiryDate>2024-12-23T12:16:59.1498103-07:00</ExpiryDate>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <PhoneNumber>sample string 6</PhoneNumber>
  <StartDate>2024-12-23T12:16:59.1498103-07:00</StartDate>
  <UserDefinedFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </UserDefinedFields>
</DelegateClientInfo>