GET api/v1/advisor/firm?firm={firm}
Returns a list of all clients under a firm.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
firm |
Guid that uniquely identifies a firm. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of investor models
Collection of FirmIdentifiersName | Description | Type | Additional information |
---|---|---|---|
UniqueId | string |
None. |
|
EmailAddress | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "UniqueId": "sample string 1", "EmailAddress": "sample string 2" }, { "UniqueId": "sample string 1", "EmailAddress": "sample string 2" } ]
application/xml, text/xml
Sample:
<ArrayOfFirmController.FirmIdentifiers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Areas.v1.Controllers"> <FirmController.FirmIdentifiers> <EmailAddress>sample string 2</EmailAddress> <UniqueId>sample string 1</UniqueId> </FirmController.FirmIdentifiers> <FirmController.FirmIdentifiers> <EmailAddress>sample string 2</EmailAddress> <UniqueId>sample string 1</UniqueId> </FirmController.FirmIdentifiers> </ArrayOfFirmController.FirmIdentifiers>