Organizational Customer

The Organizational Customer Find Similar call uses the Organization Matching Algorithm to identify potential duplicate Organization Customers.

Required values to identify match:

Name
Address

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
34
35
{
    "maxResults": "5",
        "entity": {
            "objectType": "OrganizationCustomer",
            "parent": "111301",
            "values": {
                "LegalName": {
                    "value": {
                        "value": "Stibo Systems"
                    }
                }
            },
            "dataContainers": {
                "MainAddressDataContainer": {
                    "dataContainer": {
                            "values": {
                                "InputStreet": {
                                    "value": {
                                        "value": "3200 Windy Hill rd"
                                    }
                                },

                                "InputCountry": {
                                    "value": {
                                        "value": "US"
                                   }
                                }
                            }
                        }

                    
                }
            }
        }
    }

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
<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=LegalName</ns1:propertyURL>
        <ns1:value>Stibo Systems</ns1:value>
      </ns:values>
      <ns:values>
        <ns1:propertyURL>step://attribute?id=InputStreet</ns1:propertyURL>
        <ns1:value>3200 Windy Hill rd</ns1:value>
      </ns:values>
      <ns:values>
        <ns1:propertyURL>step://attribute?id=InputCountry</ns1:propertyURL>
        <ns1:value>US</ns1:value>
      </ns:values>
       <ns:objectTypeURL>step://objecttype?id=OrganizationCustomer</ns:objectTypeURL>
       <ns:matchingAlgorithmURL>step://matchingalgorithm?id=OrganizationFindSimilar</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
43
44
45
46
47
48
49
50
{
  "findSimilarExecutionReport": {
    "httpStatus": 200,
    "message": null,
    "rejectedByBusinessRuleID": null,
    "businessRuleRejections": [],
    "httpReason": "OK"
  },
  "findSimilarResponses": [
    {
      "rank": 75,
      "entity": {
        "id": "382457",
        "name": "Stibo",
        "objectType": "OrganizationCustomer",
        "parent": "111301",
        "values": {
          "LegalName": {
            "calculated": false,
            "contextLocal": true,
            "value": {
              "value": "Stibo Systems",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {},
        "dataContainers": {
          "MainAddressDataContainer": {
            "dataContainer": {
              "values": {
                "CalcFormattedAddress": {
                  "calculated": true,
                  "contextLocal": true,
                  "value": {
                    "value": "3200 Windy Hill rd\nUS",
                    "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>382457</ns2:id>
            <ns2:url>step://entity?id=382457</ns2:url>
            <ns2:title>Stibo</ns2:title>
            <ns2:type>entity</ns2:type>
            <ns2:objectType>step://objecttype?id=OrganizationCustomer</ns2:objectType>
            <ns2:rank>75.0</ns2:rank>
            <ns2:entity UserTypeID="OrganizationCustomer" ID="382457" ParentID="111301">
               <ns3:Name>Stibo</ns3:Name>
               <ns3:Values>
                  <ns3:Value AttributeID="LegalName">Stibo Systems</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="DnBMatchAddressLine1">3200 Windy Hill rd</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="CalcNameCollection"></ns3:Value>
               </ns3:Values>
               <ns3:DataContainers>
                  <ns3:DataContainer Type="MainAddressDataContainer" ID="382458">
                     <ns3:Values>
                        <ns3:Value AttributeID="InputStreet">3200 Windy Hill rd</ns3:Value>
                        <ns3:Value AttributeID="InputCountry">US</ns3:Value>
                        <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">3200 Windy Hill rd
US</ns3:Value>
                     </ns3:Values>
                  </ns3:DataContainer>
               </ns3:DataContainers>
            </ns2:entity>
         </ns4:similarObjects>
      </ns4:getSimilarObjectsResponse>
   </S:Body>
</S:Envelope>