GET api/person/{personID}/clients

Return a list of client accounts for the given person ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
personID	Person identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Client

Name	Description	Type	Additional information
ClientID	The unique identifier of the client	integer	None.
ClientName	The name given to the entity	string	None.
OrderExecutionType	Order execution type	enOrderExecutionType	None.
CashAccountNumber	List of associated cash accounts	Collection of string	None.
ExternalReference	External reference of the client	string	None.
ClientDisplayString	Formatted string suitable for front end display	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1,
    "ClientName": "sample string 2",
    "OrderExecutionType": 0,
    "CashAccountNumber": [
      "sample string 1",
      "sample string 2"
    ],
    "ExternalReference": "sample string 3",
    "ClientDisplayString": "<sample string 3> sample string 2"
  },
  {
    "ClientID": 1,
    "ClientName": "sample string 2",
    "OrderExecutionType": 0,
    "CashAccountNumber": [
      "sample string 1",
      "sample string 2"
    ],
    "ExternalReference": "sample string 3",
    "ClientDisplayString": "<sample string 3> sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.IQ">
  <Client>
    <CashAccountNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CashAccountNumber>
    <ClientID>1</ClientID>
    <ClientName>sample string 2</ClientName>
    <ExternalReference>sample string 3</ExternalReference>
    <OrderExecutionType>Standard</OrderExecutionType>
  </Client>
  <Client>
    <CashAccountNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CashAccountNumber>
    <ClientID>1</ClientID>
    <ClientName>sample string 2</ClientName>
    <ExternalReference>sample string 3</ExternalReference>
    <OrderExecutionType>Standard</OrderExecutionType>
  </Client>
</ArrayOfClient>