webCRM Person XML
A Person belongs to an Organisation in webCRM. You can have as many Person records related to an Organisation as you need.
In the B2B version of webCRM you must have at least an Organisation record – Person records are optional.
If your system is B2C then a Person is the main entity on your records and all other module data links to the Person records in your system.
Tasks
Identifiers
The logic surrounding inserting/updating persons works as follows:
- If an
<Id>1</Id>is provided for the person, the existing person with this id will be updated. - If an
<ExternalId>1</ExternalId>is provided for the person, and a match is found in Zynk's truth table, the existing person will be updated. - If a
LookupField="MemberNumber"is provided Zynk will search for a match based on the data in the XML, and if a match is found the existing person will be updated. - If none of the above conditions are fulfilled a new person will be created.
Fields
@LookupField
Dependant
The field to use when searching webCRM for an existing record. Can optionally be prepended with the table name e.g. PersonMemberNumber or MemberNumber
| Type | Example | XML |
|---|---|---|
| string | MemberNumber | LookupField="MemberNumber" |
@ExactMatch
Dependant
Used with @LookupField, if set to true and more than one result is found when searching for a match the record will be rejected. defaults to true.
| Type | Example | XML |
|---|---|---|
| bool | true | ExactMatch="true" |
Id
Dependant
The webCRM internal database identifier of the record. If specified the record will be updated, otherwise Zynk will attempt to lookup the record or create a new one.
| Type | Example | XML |
|---|---|---|
| int | 1 | <Id>1</Id> |
ExternalId
Dependant
Allows you to specify an external identifier that is used for preventing duplicate records being created. If provided Zynk will store both the Id and ExternalId in the Truth database for future lookups.
| Type | Example | XML |
|---|---|---|
| string | AS001 | <ExternalId>AS001</ExternalId> |
CreatedAt
Read Only
| Type | Example | XML |
|---|---|---|
| datetime | 2018-02-27T14:16:54+00:00 | <CreatedAt>2018-02-27T14:16:54+00:00</CreatedAt> |
UpdatedAt
Read Only
| Type | Example | XML |
|---|---|---|
| datetime | 2018-02-27T14:20:25+00:00 | <UpdatedAt>2018-02-27T14:20:25+00:00</UpdatedAt> |
BlockMassEmail
Optional
| Type | Example | XML |
|---|---|---|
| bool | false | <BlockMassEmail>false</BlockMassEmail> |
CampaignWrongPasswordCount
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <CampaignWrongPasswordCount>0</CampaignWrongPasswordCount> |
CheckMark1 - CheckMark10
Optional
There are up to 10 check mark fields available per person in webCRM. If enabled at the task level, exports will attempt to include the label of the field as setup in the webCRM admin in the Name attribute.
| Type | Example | XML |
|---|---|---|
| string | true | <CheckMark7 Name="Key Accounting System Contact">true</CheckMark7> |
Comment
Optional
| Type | Example | XML |
|---|---|---|
| string | Technical contact | <Comment>Technical contact</Comment> |
CreatedBy
Optional
| Type | Example | XML |
|---|---|---|
| string | James | <CreatedBy>James</CreatedBy> |
DirectPhone
Optional
| Type | Example | XML |
|---|---|---|
| string | 0191 820 1484 | <DirectPhone>0191 820 1484</DirectPhone> |
Optional
| Type | Example | XML |
|---|---|---|
| string | [email protected] | <Email>[email protected]</Email> |
EmailBounces
Optional
| Type | Example | XML |
|---|---|---|
| bool | false | <EmailBounces>false</EmailBounces> |
FirstName
Optional
| Type | Example | XML |
|---|---|---|
| string | Andrew | <FirstName>Andrew</FirstName> |
ImageFileExtension
Optional
| Type | Example | XML |
|---|---|---|
| string | <ImageFileExtension></ImageFileExtension> |
LastLoginDateTime
Read Only
| Type | Example | XML |
|---|---|---|
| datetime | 2018-02-27T14:20:25+00:00 | <LastLoginDateTime>2018-02-27T14:20:25+00:00</LastLoginDateTime> |
LastName
Optional
| Type | Example | XML |
|---|---|---|
| string | Snape | <LastName>Snape</LastName> |
LoginLog
Optional
| Type | Example | XML |
|---|---|---|
| string | <LoginLog /> |
MarketDateId
Optional
| Type | Example | XML |
|---|---|---|
| string | <MarketDateId /> |
MemberGroupId
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <MemberGroupId>0</MemberGroupId> |
MemberLanguageId
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <MemberLanguageId>0</MemberLanguageId> |
MemberNumber
Read Only
| Type | Example | XML |
|---|---|---|
| string | <MemberNumber /> |
MemberStartDate
Read Only
| Type | Example | XML |
|---|---|---|
| datetime | 2018-02-27T14:20:25+00:00 | <MemberStartDate>2018-02-27T14:20:25+00:00</MemberStartDate> |
MemberStatusId
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <MemberStatusId>0</MemberStatusId> |
MemberWrongPasswordCount
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <MemberWrongPasswordCount>0</MemberWrongPasswordCount> |
MiddleName
Read Only
| Type | Example | XML |
|---|---|---|
| string | <MiddleName /> |
MobilePhone
Optional
| Type | Example | XML |
|---|---|---|
| string | <MobilePhone /> |
Name
Read Only
| Type | Example | XML |
|---|---|---|
| string | Andrew Snape | <Name>Andrew Snape</Name> |
History
Read Only
| Type | Example | XML |
|---|---|---|
| string | <History /> |
OrganisationId
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <OrganisationId>0</OrganisationId> |
Salutation
Optional
| Type | Example | XML |
|---|---|---|
| picklist | Mr | <Salutation>Mr</Salutation> |
Values
Available values depend on your webCRM setup.
Skype
Optional
| Type | Example | XML |
|---|---|---|
| string | zynksoftware | <Skype>zynksoftware</Skype> |
SortOrder
Read Only
| Type | Example | XML |
|---|---|---|
| int | 0 | <SortOrder>0</SortOrder> |
Status
Optional
| Type | Example | XML |
|---|---|---|
| picklist | Active | <Status>Active</Status> |
Values
Available values depend on your webCRM setup.
SupportLanguageId
Optional
| Type | Example | XML |
|---|---|---|
| int | 0 | <SupportLanguageId>0</SupportLanguageId> |
TelephoneSearch
Read Only
| Type | Example | XML |
|---|---|---|
| string | -01918201484- | <TelephoneSearch>-01918201484-</TelephoneSearch> |
Title
Optional
| Type | Example | XML |
|---|---|---|
| string | Developer | <Title>Developer</Title> |
UpdatedBy
Read Only
| Type | Example | XML |
|---|---|---|
| string | James Shaw | <UpdatedBy>James Shaw</UpdatedBy> |
Plus1 - Plus20
Optional
There are up to 20 plus custom fields available per person in webCRM. If enabled at the task level, exports will attempt to include the label of the field as setup in the webCRM admin in the Name attribute.
| Type | Example | XML |
|---|---|---|
| string | 20180130 | <Plus1 Name="Start Date">20180130</Plus1> |
CheckMark1 - CheckMark10
Optional
There are up to 15 custom fields available per person in webCRM. If enabled at the task level, exports will attempt to include the label of the field as setup in the webCRM admin in the Name attribute.
| Type | Example | XML |
|---|---|---|
| string | 4 | <Custom1 Name="Role">4</Custom1> |
Example XML
<?xml version="1.0" encoding="utf-8"?>
<Persons
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Person ExactMatch="true">
<Id>4</Id>
<CreatedAt>2018-08-06T17:18:57+01:00</CreatedAt>
<UpdatedAt>2018-08-07T09:33:39+01:00</UpdatedAt>
<BlockMassEmail>true</BlockMassEmail>
<CampaignWrongPasswordCount>0</CampaignWrongPasswordCount>
<CheckMark1>False</CheckMark1>
<CheckMark2>False</CheckMark2>
<CheckMark3>False</CheckMark3>
<CheckMark4>False</CheckMark4>
<CheckMark5>False</CheckMark5>
<CheckMark6>False</CheckMark6>
<CheckMark7 Name="Key Accounting System Contact">True</CheckMark7>
<CheckMark8>False</CheckMark8>
<CheckMark9>False</CheckMark9>
<CheckMark10>False</CheckMark10>
<Comment />
<CreatedBy>James Shaw</CreatedBy>
<DirectPhone>0191 820 1484</DirectPhone>
<Email>[email protected]</Email>
<EmailBounces>false</EmailBounces>
<FirstName>Andrew</FirstName>
<ImageFileExtension />
<LastLoginDateTime>0001-01-01T00:00:00+00:00</LastLoginDateTime>
<LastName>Snape</LastName>
<LoginLog />
<MarketDateId />
<MemberGroupId>0</MemberGroupId>
<MemberLanguageId>0</MemberLanguageId>
<MemberNumber />
<MemberStartDate>0001-01-01T00:00:00+00:00</MemberStartDate>
<MemberStatusId>0</MemberStatusId>
<MemberWrongPasswordCount>0</MemberWrongPasswordCount>
<MiddleName />
<MobilePhone />
<Name>Andrew Snape</Name>
<History />
<OrganisationId>3</OrganisationId>
<Salutation>Mr</Salutation>
<Skype />
<SortOrder>0</SortOrder>
<Status>Active</Status>
<SupportLanguageId>0</SupportLanguageId>
<TelephoneSearch>-01918201484-</TelephoneSearch>
<Title>Developer</Title>
<UpdatedBy>James Shaw</UpdatedBy>
<Plus1 Name="Start Date"></Plus1>
<Custom1 Name="Role">4</Custom1>
<Custom2></Custom2>
<Custom3></Custom3>
<Custom4></Custom4>
<Custom5></Custom5>
<Custom6></Custom6>
<Custom7></Custom7>
<Custom8></Custom8>
<Custom9></Custom9>
<Custom10></Custom10>
<Custom11></Custom11>
<Custom12></Custom12>
<Custom13></Custom13>
<Custom14></Custom14>
<Custom15></Custom15>
<Memo />
</Person>
</Persons>