The Contact Person Find Similar call uses the Contact Person Matching Algorithm to identify potential duplicate records.
Required values to identify match:
-
Name
-
Phone number
The GetSimilarContactOrgID must be bound to the match code for Organization IDs to be compared.
Request
REST
Copy
{
"entity": {
"dataContainers": {
"PhoneDataContainer": {
"dataContainers": [
{
"values": {
"PhoneNumber": {
"value": {
"value": "5323010724"
}
},
"PhoneType": {
"value": {
"value": "Work"
}
}
}
}
]
},
"MainAddressDataContainer": {
"dataContainer":
{
"values": {
"InputStreet": {
"value": {
"value": "525 STATE"
}
},
"InputCity": {
"value": {
"value": "York"
}
},
"InputState": {
"value": {
"value": "PA"
}
},
"InputCountry": {
"value": {
"value": "US"
}
},
"InputZip": {
"value": {
"value": "17403"
}
}
}
}
}
},
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"FirstName": {
"value": {
"value": "Sergio"
}
},
"LastName": {
"value": {
"value": "Bennett"
}
}
},
"references": {
"ContactPersonOrganization": {
"reference": {
"target": "130790",
"targetType": "entity"
}
}
}
}
}SOAP
Copy
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://stibo.com/step/ws/step/1.0" xmlns:ns1="http://stibo.com/step/ws/types/1.0" xmlns:out="http://www.stibosystems.com/step/outputtemplate">
<soapenv:Header/>
<soapenv:Body>
<ns:getSimilarObjectsRequest>
<ns:accessContext>
<ns1:userName>stepsys</ns1:userName>
<ns1:password>stepsys</ns1:password>
<ns1:contextUrl>step://context?id=Context1</ns1:contextUrl>
<ns1:workspaceUrl>step://workspace?id=Main</ns1:workspaceUrl>
</ns:accessContext>
<ns:values>
<ns1:propertyURL>step://attribute?id=FirstName</ns1:propertyURL>
<ns1:value>Sergio</ns1:value>
</ns:values>
<ns:values>
<ns1:propertyURL>step://attribute?id=LastName</ns1:propertyURL>
<ns1:value>Bennett</ns1:value>
</ns:values>
<ns:values>
<ns1:propertyURL>step://attribute?id=PhoneNumber</ns1:propertyURL>
<ns1:value>5323010724</ns1:value>
</ns:values>
<ns:objectTypeURL>step://objecttype?id=ContactPerson</ns:objectTypeURL>
<ns:matchingAlgorithmURL>step://matchingalgorithm?id=ContactFindSimilar</ns:matchingAlgorithmURL>
<ns:searchThreshold>1</ns:searchThreshold>
<ns:maxCount>10</ns:maxCount>
<ns:exportConfigurationXML>
<ns1:Entity>
<out:Entity/>
<out:Name/>
<out:Values/>
<out:DataContainers/>
<out:EntityCrossReferences/>
<out:Entity/>
</ns1:Entity>
</ns:exportConfigurationXML>
</ns:getSimilarObjectsRequest>
</soapenv:Body>
</soapenv:Envelope>Response
REST
Copy
{
"findSimilarExecutionReport": {
"httpStatus": 200,
"message": "Found similar records",
"rejectedByBusinessRuleID": null,
"businessRuleRejections": [],
"httpReason": "OK"
},
"findSimilarResponses": [
{
"rank": 100,
"entity": {
"id": "843067",
"name": null,
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"FirstName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Sergio",
"valueId": null,
"unit": null
}
},
"LastName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Bennett",
"valueId": null,
"unit": null
}
}
},
"references": {
"ContactPersonOrganization": {
"reference": {
"contextLocal": true,
"target": "130790",
"targetType": "entity",
"values": {},
"inherited": null,
"entity": {
"id": "130790",
"name": null,
"objectType": "OrganizationCustomer",
"parent": "111301",
"values": {
"LegalName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Food Supply, Inc.",
"valueId": null,
"unit": null
}
}
},
"references": {
"CustomerSourceSystem": {
"references": [
{
"contextLocal": true,
"target": "SystemX",
"targetType": "entity",
"values": {
"SourceRecordID": {
"contextLocal": true,
"inherited": null,
"values": [
{
"value": "59463-6773",
"valueId": null,
"unit": null
}
]
}
},
"inherited": null,
"entity": null
}
]
}
},
"dataContainers": {}
}
}
},
"CustomerSourceSystem": {
"references": [
{
"contextLocal": true,
"target": "SystemY",
"targetType": "entity",
"values": {
"SourceRecordID": {
"contextLocal": true,
"inherited": null,
"values": [
{
"value": "23-1142",
"valueId": null,
"unit": null
}
]
}
},
"inherited": null,
"entity": null
}
]
}
},
"dataContainers": {
"EmailDataContainer": {
"dataContainers": [
{
"values": {
"EmailType": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Work",
"valueId": "Work",
"unit": null
}
},
"EmailField": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "campbell@outlook.com",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
],
"inherited": null
},
"MainAddressDataContainer": {
"dataContainer": {
"values": {
"InputState": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "PA",
"valueId": null,
"unit": null
}
},
"InputCity": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "York",
"valueId": null,
"unit": null
}
},
"InputCountry": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "US",
"valueId": null,
"unit": null
}
},
"InputZip": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "17403-1029",
"valueId": null,
"unit": null
}
},
"InputStreet": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "525 STATE",
"valueId": null,
"unit": null
}
},
"CalcFormattedAddress": {
"calculated": true,
"contextLocal": true,
"inherited": null,
"value": {
"value": "525 STATE\nYork, PA, 17403-1029\nUS",
"valueId": null,
"unit": null
}
}
},
"references": {}
},
"inherited": null
},
"PhoneDataContainer": {
"dataContainers": [
{
"values": {
"PhoneNumber": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "5323010724",
"valueId": null,
"unit": null
}
},
"PhoneType": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Work",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
],
"inherited": null
}
}
}
}
]
}SOAP
Copy
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns4:getSimilarObjectsResponse xmlns="http://www.stibosystems.com/step/outputtemplate" xmlns:ns2="http://stibo.com/step/ws/types/1.0" xmlns:ns3="http://www.stibosystems.com/step" xmlns:ns4="http://stibo.com/step/ws/step/1.0">
<ns4:similarObjects>
<ns2:id>382464</ns2:id>
<ns2:url>step://entity?id=382464</ns2:url>
<ns2:title>Sergio</ns2:title>
<ns2:type>entity</ns2:type>
<ns2:objectType>step://objecttype?id=ContactPerson</ns2:objectType>
<ns2:rank>100.0</ns2:rank>
<ns2:entity UserTypeID="ContactPerson" ID="382464" ParentID="111660">
<ns3:Name>Sergio</ns3:Name>
<ns3:Values>
<ns3:Value AttributeID="FirstName">Sergio</ns3:Value>
<ns3:Value AttributeID="LastName">Bennett</ns3:Value>
<ns3:Value Derived="true" AttributeID="CalcName">Sergio Bennett</ns3:Value>
<ns3:Value Derived="true" AttributeID="CalcNameCollection">Sergio Bennett</ns3:Value>
</ns3:Values>
<ns3:DataContainers>
<ns3:MultiDataContainer Type="PhoneDataContainer">
<ns3:DataContainer ID="382465">
<ns3:Values>
<ns3:Value AttributeID="PhoneNumber">5323010724</ns3:Value>
</ns3:Values>
</ns3:DataContainer>
</ns3:MultiDataContainer>
</ns3:DataContainers>
</ns2:entity>
</ns4:similarObjects>
</ns4:getSimilarObjectsResponse>
</S:Body>
</S:Envelope>