Update Existing Individual Customer

The following section includes sample REST request call as well as the response.

Required values to identify match:

  • Name
  • Address
  • Email
  • Phone

Update Existing Individual Customer Web Service Request

REST

Copy
[
    {
        "correlationID": "1",
        "entity": {
            "references": {
                "CustomerSourceSystem": {
                    "references": [
                        {
                            "target": "SystemY",
                            "targetType": "entity",
                            "values": {
                                "SourceRecordID": {
                                    "values": [
                                        {
                                            "value": "78945-44623"
                                        }
                                    ]
                                }
                            }
                        }
                    ]
                }
            },            
         "dataContainers": {
                "EmailDataContainer": {
                    "dataContainers": [
                        {
                            "values": {
                                "EmailField": {
                                    "value": {
                                        "value": "Aliquam.nisl.Nulla@Donecsollicitudinadipiscing.co.uk"
                                    }
                                },
                                "EmailType": {
                                    "value": {
                                        "value": "Work"
                                    }
                                }
                            }
                        }
                    ]
                },
                "MainAddressDataContainer": {
                    "dataContainers": [
                        {
                            "values": {
                                "InputCountry": {
                                    "value": {
                                        "value": "US"
                                    }
                                },
                                "InputStreet": {
                                    "value": {
                                        "value": "539 59th St"
                                    }
                                }
                            }
                        }
                    ]
                },
                "PhoneDataContainer": {
                    "dataContainers": [
                        {
                            "values": {
                                "PhoneNumber": {
                                    "value": {
                                        "value": "(225) 168-9574"
                                    }
                                },
                                "PhoneType": {
                                    "value": {
                                        "value": "Home"
                                    }
                                }
                            }
                        }
                    ]
                }
            },
            "id": "",
            "name": "string",
            "objectType": "IndividualCustomer",
            "parent": "111656",
            "values": {
                "FirstName": {
                    "value": {
                        "value": "Meg"
                    }
                },
                "LastName": {
                    "value": {
                        "value": "Bright"
                    }
                }
            }
        }
    }
]

SOAP

Copy
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://stibo.com/step/ws/matching/1.0" xmlns:ns1="http://stibo.com/step/ws/types/1.0" xmlns:step="http://www.stibosystems.com/step">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:matchAndMergeRequest>
         <accessContext>
            <ns1:userName>stepsys</ns1:userName>
            <ns1:password>stepsys</ns1:password>
            <ns1:contextUrl>step://context?id=Context1</ns1:contextUrl>
         </accessContext>
 <webserviceConfigurationID>IndividualRequest</webserviceConfigurationID>
               <matchAndMergeRecord CorrelationID="9">
                  <ns1:Entity ParentID="111656" UserTypeID="IndividualCustomer">
                     <step:Name>Meg Bright</step:Name>
                     <step:Entity/>
                     <step:Values>
                        <step:Value AttributeID="FirstName">Meg</step:Value>
                        <step:Value AttributeID="LastName">Bright</step:Value>
                     </step:Values>
                     <step:DataContainers>
                        <step:DataContainer Type="MainAddressDataContainer">
                           <step:Values>
                              <step:Value AttributeID="InputStreet">539 59th St</step:Value>
                              <step:Value AttributeID="InputCountry">US</step:Value>
                           </step:Values>
                        </step:DataContainer>
                        <step:MultiDataContainer Type="PhoneDataContainer">
                           <step:DataContainer>
                              <step:Values>
                                 <step:Value AttributeID="PhoneNumber">(225) 168-9574</step:Value>
                           <step:Value AttributeID="PhoneType">Home</step:Value>
                              </step:Values>
                           </step:DataContainer>
                        </step:MultiDataContainer>
                        <step:MultiDataContainer Type="EmailDataContainer">
                           <step:DataContainer>
                              <step:Values>
                                 <step:Value AttributeID="EmailField">Aliquam.nisl.Nulla@Donecsollicitudinadipiscing.co.uk</step:Value>
                           <step:Value AttributeID="EmailType">Work</step:Value>
                              </step:Values>
                           </step:DataContainer>
                        </step:MultiDataContainer>
                     </step:DataContainers>
                  </ns1:Entity>
               </matchAndMergeRecord>
            </ns:matchAndMergeRequest>
         </soapenv:Body>
</soapenv:Envelope>

Update Existing Individual Customer Web Service Response

REST

Copy
{
  "matchAndMergeGeneralExecutionReport": {
    "httpStatus": 200,
    "message": null,
    "httpReason": "OK"
  },
  "matchAndMergeResponses": [
    {
      "correlationID": "1",
      "status": "PROCESSED",
      "potentialDuplicates": [],
      "matchAndMergeExecutionReport": {
        "operation": "UPDATE",
        "errorMessage": null,
        "rejectedByBusinessCondition": [],
        "rejectedByPotentialDuplicates": false
      },
      "entity": {
        "id": "1313764",
        "name": null,
        "objectType": "IndividualCustomer",
        "parent": "111656",
        "values": {
          "FirstName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Meg",
              "valueId": null,
              "unit": null
            }
          },
          "LastName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Bright",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {
          "CustomerSourceSystem": {
            "references": [
              {
                "contextLocal": true,
                "target": "SystemY",
                "targetType": "entity",
                "values": {
                  "SourceRecordID": {
                    "contextLocal": true,
                    "inherited": null,
                    "values": [
                      {
                        "value": "78945-44623",
                        "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": "Aliquam.nisl.Nulla@Donecsollicitudinadipiscing.co.uk",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              }
            ],
            "inherited": null
          },
          "MainAddressDataContainer": {
            "dataContainer": {
              "values": {
                "InputCountry": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "US",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputStreet": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "539 59th St",
                    "valueId": null,
                    "unit": null
                  }
                }
              },
              "references": {}
            },
            "inherited": null
          },
          "PhoneDataContainer": {
            "dataContainers": [
              {
                "values": {
                  "PhoneNumber": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "(225) 168-9574",
                      "valueId": null,
                      "unit": null
                    }
                  },
                  "PhoneType": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "Home",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              }
            ],
            "inherited": null
          }
        }
      }
    }
  ]
}                                              

SOAP

Copy
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns5:matchAndMergeResponse xmlns:ns2="http://stibo.com/step/ws/types/1.0" xmlns:ns3="http://www.stibosystems.com/step" xmlns:ns4="http://www.stibosystems.com/step/outputtemplate" xmlns:ns5="http://stibo.com/step/ws/matching/1.0">
         <matchAndMergeRecord CorrelationID="9">
            <ns2:status>PROCESSED</ns2:status>
            <ns2:matchAndMergeExecutionReport>
               <ns2:operation>UPDATE</ns2:operation>
            </ns2:matchAndMergeExecutionReport>
            <ns2:Entity ParentID="111656" ID="387305" UserTypeID="IndividualCustomer">
               <ns3:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
                  <ns3:MetaData>
                     <ns3:MultiValue AttributeID="SourceRecordID">
                        <ns3:Value>16660526-6110</ns3:Value>
                     </ns3:MultiValue>
                  </ns3:MetaData>
               </ns3:EntityCrossReference>
               <ns3:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemY"/>
               <ns3:EntityCrossReference Type="PotentialDuplicates" EntityID="387305"/>
               <ns3:Values>
                  <ns3:Value AttributeID="LastName">Bright</ns3:Value>
                  <ns3:Value AttributeID="FirstName">Meg</ns3:Value>
               </ns3:Values>
               <ns3:DataContainers>
                  <ns3:MultiDataContainer Type="EmailDataContainer">
                     <ns3:DataContainer ID="387308">
                        <ns3:Values>
                           <ns3:Value AttributeID="EmailField">Aliquam.nisl.Nulla@Donecsollicitudinadipiscing.co.uk</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:MultiDataContainer>
                  <ns3:MultiDataContainer Type="PhoneDataContainer">
                     <ns3:DataContainer ID="387309">
                        <ns3:Values>
                           <ns3:Value AttributeID="PhoneNumber">(225) 168-9574</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:MultiDataContainer>
                  <ns3:DataContainer ID="390718" Type="MainAddressDataContainer">
                     <ns3:Values>
                        <ns3:Value AttributeID="CalcFormattedAddress" Derived="true">539 59th St
United States</ns3:Value>
                     </ns3:Values>
                  </ns3:DataContainer>
               </ns3:DataContainers>
            </ns2:Entity>
         </matchAndMergeRecord>
      </ns5:matchAndMergeResponse>
   </S:Body>
</S:Envelope>