PUT api/{enterpriseId}/Households/batch

To batch update households

Request Information

URI Parameters

Name	Description	Type	Additional information
enterpriseId	Enterprise Code - identifies enterprise within AdvisorView	string	Required

Body Parameters

HouseholdBatchRequest

Name	Description	Type	Additional information
OrgId	OrganizationId - If CRM is Salesforce, this is required field.	string	None.
Records	Collection of Households	Collection of HouseholdModel	None.

Request Formats

application/json, text/json

Sample:

{
  "OrgId": "sample string 1",
  "Records": [
    {
      "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
    },
    {
      "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:

<HouseholdBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models">
  <OrgId>sample string 1</OrgId>
  <Records>
    <HouseholdModel>
      <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>
    <HouseholdModel>
      <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>
  </Records>
</HouseholdBatchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HouseholdResponse

Name	Description	Type	Additional information
StatusCode	Standard Http status codes	HttpStatusCode	None.
StatusMessage	Status message	string	None.
Household	Household Model	HouseholdModel	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusCode": 100,
  "StatusMessage": "sample string 1",
  "Household": {
    "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:

<HouseholdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models">
  <Household>
    <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>
  </Household>
  <StatusCode>Continue</StatusCode>
  <StatusMessage>sample string 1</StatusMessage>
</HouseholdResponse>