GetHouseholdMember Method

Using a contact ID, you can retreive a list of all members of the contact's household. If the household or contact does not exist, this method simply returns a status of OK.

The GetHouseholdMember method is invoked as part of the MethodOperation.

Parameters

Name Type
ContactID String

Examples

Request XML
<request version='1.0'>
  <header>
    <office>myoffice</office>
    <user>jdoe</user>
    <password>password</password>
  </header>
  <method>
    <GetHouseholdMember>
      <ContactID>Contact.70746.14580</ContactID>
    </GetHouseholdMember>
  </method>
</request>

Response XML
<response version="1.0">
  <header>
    <sessionClosed/>
  </header>
  <method>
    <GetHouseholdMember>
      <HouseHold id="HouseHold.70746.292" _type="obj">
        <Name>Chen Family</Name>
          <HouseHoldMembers _type="objs">
            <HouseHoldMember id="HouseHoldMember.70746.687" _type="obj">
         <Member>Head</Member>
                <Contact id="Contact.70746.14561" _type="obj">
                  <FirstName>Andrew</FirstName>
                  <LastName>Chen</LastName>
                </Contact>
            </HouseHoldMember>
            <HouseHoldMember id="HouseHoldMember.70746.688" _type="obj">
              <Member>Spouse</Member>
                <Contact id="Contact.70746.14580" _type="obj">
                  <FirstName>MJ</FirstName>
                  <LastName>Chen</LastName>
                </Contact>
              </HouseHoldMember>
            </HouseHoldMembers>
      </HouseHold>
    </GetHouseholdMember>
  </method>
  <_status>OK</_status>
  <!--Cost 21 mill seconds.-->
</response>


-- DustinFox - 29 Nov 2012
Topic revision: 09 Jun 2015, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback