Contact Person

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
    "maxResults": "5",
        "entity": {
            "objectType": "ContactPerson",
            "parent": "111660",
            "values": {
                "FirstName": {
                    "value": {
                        "value": "Sergio"
                    }
                },
                "LastName": {
                    "value": {
                        "value": "Benet"
                    }
                }
            },
            "dataContainers": {
                "PhoneDataContainer": {
                    "dataContainers": [{
                            "values": {
                                "PhoneNumber": {
                                    "value": {
                                        "value": "5323010724"
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    }

SOAP

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "findSimilarExecutionReport": {
    "httpStatus": 200,
    "message": null,
    "rejectedByBusinessRuleID": null,
    "businessRuleRejections": [],
    "httpReason": "OK"
  },
  "findSimilarResponses": [
    {
      "rank": 87,
      "entity": {
        "id": "382464",
        "name": "Sergio",
        "objectType": "ContactPerson",
        "parent": "111660",
        "values": {},
        "references": {},
        "dataContainers": {
          "PhoneDataContainer": {
            "dataContainers": [
              {
                "values": {
                  "PhoneNumber": {
                    "calculated": false,
                    "contextLocal": true,
                    "value": {
                      "value": "5323010724",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              }
            ]
          }
        }
      }
    }
  ]
}

SOAP

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<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>