GET api/v{version}/delegates/{delegateId}/clients/{clientId}

Gets a list of statuses for a client in the delegate groups that intersect with the delegate. Includes the date ranges the client is available for, as well as any additional information such as the funding source that was used to associate the client with the group, if applicable

Request Information

URI Parameters

NameDescriptionTypeAdditional information
delegateId

The delegate to check

 integer

Required
clientId

The client to check

 integer

Required
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

The statuses where the client is part of the group, or an empty list if the client isn't in any

Collection of DelegateClientStatus
NameDescriptionTypeAdditional information
ClientId

Gets or sets the ID of the client that this status is for

 integer

None.
DelegateGroupId

Gets or sets the delegate group that this status is for

 integer

None.
ValidDates

Gets or sets the dates that the client is valid in it's group

 Collection of DateRange

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "clientId": 1,
    "delegateGroupId": 2,
    "validDates": null
  },
  {
    "clientId": 1,
    "delegateGroupId": 2,
    "validDates": null
  }
]

application/xml, text/xml

Sample: 
<ArrayOfDelegateClientStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <DelegateClientStatus>
    <ClientId>1</ClientId>
    <DelegateGroupId>2</DelegateGroupId>
    <ValidDates xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources" i:nil="true" />
  </DelegateClientStatus>
  <DelegateClientStatus>
    <ClientId>1</ClientId>
    <DelegateGroupId>2</DelegateGroupId>
    <ValidDates xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources" i:nil="true" />
  </DelegateClientStatus>
</ArrayOfDelegateClientStatus>