How to access Contact object via XML worksheet

Last updated
Save as PDF

This article provides the information about how to access the Contact object via XML worksheet.

For Contacts, you can use XML request for the following:

Inserting Contacts
Updating Contacts
Deleting Contacts
Deleting Contact Relations
Assigning a Contact Group to a Contact

Contact

Inserting Contacts

Here is an example XML request to add new contact in TeamConnect via XML worksheet:

Note: If the TeamConnect administrator has activated a Duplicate Contact Record Manager filter, you may not be able to create contacts with certain duplicate field values. Please contact your TeamConnect administrator for questions.

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Contact op="insert" OverrideDuplicateCheck="true">
    <Type>P</Type>
    <Prefix>Mrs.</Prefix>
    <FirstName>Helen</FirstName>
    <MiddleName>Karen</MiddleName>
    <Name>Carter</Name>
    <Suffix></Suffix>
    <Alias>Karen</Alias>
    <Company>127</Company>
    <Title>Supervisor</Title>
    <NumberString>Emp035295</NumberString>
    <Salutation>Dear Mrs. Carter</Salutation>
    <DriverLicense>C326952</DriverLicense>
    <SsOrTaxNumberString>623-52-8541</SsOrTaxNumberString>
    <BirthDate>1975-05-21</BirthDate>
    <Address key="ADDR_HOME">
        <Street>26532 Ventura Boulevard Apt. 25</Street>
        <City>Sherman Oaks</City>
        <State>CA</State>
        <PostalCode>93201</PostalCode>
        <County>Los Angeles</County>
        <Country>COUN_0002</Country>
        <CurrentOn>2004-12-08</CurrentOn>
        <ReferenceNumberString>B52-051</ReferenceNumberString>
    </Address>
    <Address key="ADDR_BUS1" action="default">
        <Street>3539 Motor Avenue</Street>
        <City>Los Angeles</City>
        <State>CA</State>
        <PostalCode>90034</PostalCode>
        <County>Los Angeles</County>
        <Country>United States</Country>
        <CurrentOn>2004-12-08</CurrentOn>
        <ReferenceNumberString>A35-201</ReferenceNumberString>
    </Address>
    <Phone key="PHON_HOME">(818) 572-0315</Phone>
    <Phone key="PHON_BUS1" action="default">(310) 280-0660 ext.840</Phone>
    <Phone key="PHON_MOBI">(818) 269-8021</Phone>
    <Fax key="FAXX_PER1">(818) 572-0314</Fax>
    <Fax key="FAXX_BUS1" action="default">(818) 572-1234</Fax>
    <Email key="MAIL_PER1">andrea@cmu.com</Email>
    <Email key="MAIL_BUS1">andrea@mitratech.com</Email>
    <InetAddress key="INET_BWEB">www.cmu.com</InetAddress>
    <InetAddress key ="INET_FTPS">www.creativemindsunlimited.com</InetAddress>
    <InetAddress key="INET_PWEB">www.mitratech.com</InetAddress>
    <Detail key="CONT_EMPL">
        <AnnualSalary>75,000</AnnualSalary>
        <Beneficiary>Jim Smith</Beneficiary>
        <Comments>Helen is an exceptional employee and is a great asset to our company.</Comments>
        <DateOfHire>1996-04-01</DateOfHire>
        <TerminationDate></TerminationDate>
        <Gender>GEND_ROOT_FEME</Gender>
        <Married>1</Married>
    </Detail>
    <Skill>
        <Type>SKIL_LITI</Type>
        <SkillLevel>3</SkillLevel> 
    </Skill>
    <Distribution Name="Supervisors"/>
    <DefaultRateValue>100.00</DefaultRateValue>
    <Currency>GBP</Currency>
    <Rate>
        <TaskCategory>TASK_LOEV</TaskCategory>
        <RateAmount>75</RateAmount>
        <EffectiveFrom>2005-01-01</EffectiveFrom>
        <EffectiveTo>2005-06-30</EffectiveTo>
    </Rate>
    <Relation>
        <Contact keymap="Name">Bear Insurance</Contact>
        <Type>CONR_CONS</Type>
        <LeftRightIID>Left</LeftRightIID>
    </Relation>
    <Territory>
        <Type>TERR_NORT</Type>
        </Territory>
    <SecurityTypeIID>2</SecurityTypeIID>
</Contact>
</TeamConnectRequest>

Note: The example above will override a duplicate contact check setting and save the contact if duplicate contact checking is enabled and a setting to allow users to override duplicate contact checking has been enabled. For more information, see (optional) OverrideDuplicateCheck in this guide.

Updating Contacts

Here is an example XML request to update an contact in TeamConnect via XML worksheet:

Note: If the TeamConnect administrator has activated a Duplicate Contact Record Manager filter, you may not be able to update contacts with certain duplicate field values. For more information, see (optional) OverrideDuplicateCheck and the System Administration chapter of the Administration Guide.

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Contact op="update" Name="Chen" NumberString="Emp85217" OverrideDuplicateCheck="true">
    <Prefix>Mrs.</Prefix>
    <Name>Chen-Cradler</Name>
    <Address key="ADDR_HOME">
    <Street>18210 Balboa</Street>
        <City>Van Nuys</City>
        <State>CA</State>
        <PostalCode>92145</PostalCode>
        <County>Los Angeles</County>
        <Country>United States</Country>
    </Address>
    <Address key="ADDR_BUS1" action="default">
        <Street>3539 Motor Avenue</Street>
        <City>Los Angeles</City>
        <State>CA</State>
        <PostalCode>91325</PostalCode>
        <County>Los Angeles</County>
        <Country>United States</Country>
    </Address>
    <Phone op="update" Type="PHON_BUS1">
        <PhoneString>323.555.5555</PhoneString>
    </Phone>
    <DefaultRateValue>75.00</DefaultRateValue>
</Contact>
</TeamConnectRequest>

Note: The example above will override a duplicate contact check setting and update the contact if duplicate contact checking is enabled and a setting to allow users to override duplicate contact checking has been enabled. For more information, see (optional) OverrideDuplicateCheck in this guide.

Deleting Contacts

Here is an example XML request to delete an contact in TeamConnect via XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Contact op="delete" Name="Carter" NumberString="Emp035295" />
</TeamConnectRequest>

Deleting contact relations

Here is an example XML request to delete contact relations in TeamConnect via XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
    <Contact op="update" NumberString="tom123">
        <LeftRelation LeftContact.NumberString="sam123" Type.TreePosition="CONR_DEFA" op="delete" />
    </Contact>
</TeamConnectRequest>

Assigning a contact group to a contact

This example presumes that you have already set up a Contact Group named "Test" from the TeamConnect user interface (not the XML Layer) prior to running this request.

To do the assignment on an insert of a new contact

<TeamConnectRequest>
<Authentication>
<Username>lalith</Username>
<Password>lalith</Password>
</Authentication>
<Contact opcode="insert" TypeIID="P">
<Name> Testing Contact Group </Name>
<Distribution Name="Test" />
</Contact>
</TeamConnectRequest>

To do the assignment on an update

<TeamConnectRequest>
<Authentication>
<Username>lalith</Username>
<Password>lalith</Password>
</Authentication>
<Contact op="update" Name="Alan" FirstName="Joseph">
<Distribution Name="Test" />
</Contact>
</TeamConnectRequest>