GET api/v2/advisor/mgpinvestoraccess?householdId={householdId}

Returns a list of eligible members who have access to the household

Request Information

URI Parameters

NameDescriptionTypeAdditional information
householdId

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of accounts models

MGPHHInvestorsResponse
NameDescriptionTypeAdditional information
Records

Collection of MGPHHInvestors

None.
TotalLength

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Records": [
    {
      "FirstName": "sample string 1",
      "Email": "sample string 2",
      "UniqueClientKey": "sample string 3"
    },
    {
      "FirstName": "sample string 1",
      "Email": "sample string 2",
      "UniqueClientKey": "sample string 3"
    }
  ],
  "TotalLength": 1
}

application/xml, text/xml

Sample: 
<MGPHHInvestorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.MGP">
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.MGP.SqlResults">
    <d2p1:MGPHHInvestors>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:UniqueClientKey>sample string 3</d2p1:UniqueClientKey>
    </d2p1:MGPHHInvestors>
    <d2p1:MGPHHInvestors>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:UniqueClientKey>sample string 3</d2p1:UniqueClientKey>
    </d2p1:MGPHHInvestors>
  </Records>
  <TotalLength>1</TotalLength>
</MGPHHInvestorsResponse>