GET api/{enterpriseId}/Households/{id}

Returns a specific Household identified by id, Usage: api/{enterprisecode}/household/id Example: api/testdev/household/1

Request Information

URI Parameters

Name	Description	Type	Additional information
enterpriseId	Enterprise Code - identifies enterprise within AdvisorView	string	Required
id	AdvisorView Id of the household	integer	Required

Body Parameters

None.

Response Information

Resource Description

HouseholdModel

Name	Description	Type	Additional information
OrgId	OrganizationId - If CRM is Salesforce, this is required field.	string	None.
HouseholdId	Id to identify household within AdvisorView system	integer	None.
HouseholdCrmId	Id to identify household within CRM system	string	None.
HouseholdName	Name of the household	string	None.
Street	Address of the household, this field is mutually exclusive with Address1..Address6 fields	string	None.
Address1	Address1	string	None.
Address2	Address2	string	None.
Address3	Address3	string	None.
Address4	Address4	string	None.
Address5	Address5	string	None.
Address6	Address6	string	None.
City	City	string	None.
State	State	string	None.
PrimaryStateResidence	State of primary residence	string	None.
ZipCode	ZipCode	string	None.
UpdatedByTamaracIntegration		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "OrgId": "sample string 1",
  "HouseholdId": 2,
  "HouseholdCrmId": "sample string 3",
  "HouseholdName": "sample string 4",
  "Street": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "Address3": "sample string 8",
  "Address4": "sample string 9",
  "Address5": "sample string 10",
  "Address6": "sample string 11",
  "City": "sample string 12",
  "State": "sample string 13",
  "PrimaryStateResidence": "sample string 14",
  "ZipCode": "sample string 15",
  "UpdatedByTamaracIntegration": true
}

application/xml, text/xml

Sample:

<HouseholdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <Address3>sample string 8</Address3>
  <Address4>sample string 9</Address4>
  <Address5>sample string 10</Address5>
  <Address6>sample string 11</Address6>
  <City>sample string 12</City>
  <HouseholdCrmId>sample string 3</HouseholdCrmId>
  <HouseholdId>2</HouseholdId>
  <HouseholdName>sample string 4</HouseholdName>
  <OrgId>sample string 1</OrgId>
  <PrimaryStateResidence>sample string 14</PrimaryStateResidence>
  <State>sample string 13</State>
  <Street>sample string 5</Street>
  <UpdatedByTamaracIntegration>true</UpdatedByTamaracIntegration>
  <ZipCode>sample string 15</ZipCode>
</HouseholdModel>