The following section includes sample REST and SOAP XML request call as well as the XML response.
Required values to identify match:
- Name
- Address
- Phone
New Contact Web Service Request
REST
Copy
[{
"correlationID": "1",
"entity": {
"id": "",
"name": "string",
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"FirstName": {
"value": {
"value": "Joanna"
}
},
"LastName": {
"value": {
"value": "Nuckols"
}
}
},
"references": {
"CustomerSourceSystem": {
"references": [{
"target": "SystemX",
"targetType": "entity",
"values": {
"SourceRecordID": {
"values": [{
"value": "123"
}
]
}
}
}
]
}
},
"dataContainers": {
"MainAddressDataContainer": {
"dataContainers": [{
"values": {
"InputStreet": {
"value": {
"value": "195 horseshoe ln"
}
},
"InputCity": {
"value": {
"value": "Missoula"
}
},
"InputState": {
"value": {
"value": "MT"
}
},
"InputZip": {
"value": {
"value": "59803"
}
},
"InputCountry": {
"value": {
"value": "USA"
}
}
}
}
]
},
"PhoneDataContainer": {
"dataContainers": [{
"values": {
"PhoneNumber": {
"value": {
"value": "4065467413"
}
}
}
}
]
},
"EmailDataContainer": {
"dataContainers": [{
"values": {
"EmailField": {
"value": {
"value": "jonuckols@aol.com"
}
}
}
}
]
}
}
}
}
]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>ContactRequest</webserviceConfigurationID>
<matchAndMergeRecord CorrelationID="9">
<ns1:Entity ParentID="111660" UserTypeID="ContactPerson">
<step:Name>Joanna Nuckols</step:Name>
<step:Entity/>
<step:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
<step:MetaData>
<step:Value AttributeID="SourceRecordID">123</step:Value>
</step:MetaData>
</step:EntityCrossReference>
<step:Values>
<step:Value AttributeID="FirstName">Joanna</step:Value>
<step:Value AttributeID="LastName">Nuckols</step:Value>
</step:Values>
<step:DataContainers>
<step:DataContainer Type="MainAddressDataContainer">
<step:Values>
<step:Value AttributeID="InputStreet">195 horseshoe ln</step:Value>
<step:Value AttributeID="InputCity">Missoula</step:Value>
<step:Value AttributeID="InputCountry">USA</step:Value>
<step:Value AttributeID="InputState">MT</step:Value>
<step:Value AttributeID="InputZip">59803</step:Value>
</step:Values>
</step:DataContainer>
<step:MultiDataContainer Type="PhoneDataContainer">
<step:DataContainer>
<step:Values>
<step:Value AttributeID="PhoneNumber">4065467413</step:Value>
</step:Values>
</step:DataContainer>
</step:MultiDataContainer>
<step:MultiDataContainer Type="EmailDataContainer">
<step:DataContainer>
<step:Values>
<step:Value AttributeID="EmailField">jonuckols@aol.com</step:Value>
</step:Values>
</step:DataContainer>
</step:MultiDataContainer>
</step:DataContainers>
</ns1:Entity>
</matchAndMergeRecord>
</ns:matchAndMergeRequest>
</soapenv:Body>
</soapenv:Envelope>New Contact Web Service Response
REST
Copy
{
"matchAndMergeGeneralExecutionReport": {
"httpStatus": 200,
"message": null,
"httpReason": "OK"
},
"matchAndMergeResponses": [
{
"correlationID": "1",
"status": "PROCESSED",
"potentialDuplicates": [],
"matchAndMergeExecutionReport": {
"operation": "NEW",
"errorMessage": null,
"rejectedByBusinessCondition": [],
"rejectedByPotentialDuplicates": false
},
"entity": {
"id": "382420",
"name": null,
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"FirstName": {
"calculated": false,
"contextLocal": true,
"value": {
"value": "Joanna",
"valueId": null,
"unit": null
}
},
"LastName": {
"calculated": false,
"contextLocal": true,
"value": {
"value": "Nuckols",
"valueId": null,
"unit": null
}
}
},
"references": {
"CustomerSourceSystem": {
"references": [
{
"contextLocal": true,
"target": "SystemX",
"targetType": "entity",
"values": {
"SourceRecordID": {
"contextLocal": true,
"values": [
{
"value": "123",
"valueId": null,
"unit": null
}
]
}
},
"entity": null
}
]
}
},
"dataContainers": {
"EmailDataContainer": {
"dataContainers": [
{
"values": {
"EmailField": {
"calculated": false,
"contextLocal": true,
"value": {
"value": "jonuckols@aol.com",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
]
},
"PhoneDataContainer": {
"dataContainers": [
{
"values": {
"PhoneNumber": {
"calculated": false,
"contextLocal": true,
"value": {
"value": "4065467413",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
]
},
"MainAddressDataContainer": {
"dataContainer": {
"values": {
"CalcFormattedAddress": {
"calculated": true,
"contextLocal": true,
"value": {
"value": "195 Horseshoe Ln\nMissoula MT 59803-9702\nUnited States",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
}
}
}
}
]
}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>NEW</ns2:operation>
</ns2:matchAndMergeExecutionReport>
<ns2:Entity UserTypeID="ContactPerson" ID="382408" ParentID="111660">
<ns3:EntityCrossReference EntityID="SystemX" Type="CustomerSourceSystem">
<ns3:MetaData>
<ns3:MultiValue AttributeID="SourceRecordID">
<ns3:Value>123</ns3:Value>
</ns3:MultiValue>
</ns3:MetaData>
</ns3:EntityCrossReference>
<ns3:Values>
<ns3:Value AttributeID="FirstName">Joanna</ns3:Value>
<ns3:Value AttributeID="LastName">Nuckols</ns3:Value>
</ns3:Values>
<ns3:DataContainers>
<ns3:MultiDataContainer Type="EmailDataContainer">
<ns3:DataContainer ID="fe8dabbc-0331-4c54-81eb-8b5451265ea6">
<ns3:Values>
<ns3:Value AttributeID="EmailField">jonuckols@aol.com</ns3:Value>
</ns3:Values>
</ns3:DataContainer>
</ns3:MultiDataContainer>
<ns3:MultiDataContainer Type="PhoneDataContainer">
<ns3:DataContainer ID="382410">
<ns3:Values>
<ns3:Value AttributeID="PhoneNumber">4065467413</ns3:Value>
</ns3:Values>
</ns3:DataContainer>
</ns3:MultiDataContainer>
<ns3:DataContainer Type="MainAddressDataContainer" ID="382409">
<ns3:Values>
<ns3:Value Derived="true" AttributeID="CalcFormattedAddress">195 Horseshoe Ln
Missoula MT 59803-9702
United States</ns3:Value>
</ns3:Values>
</ns3:DataContainer>
</ns3:DataContainers>
</ns2:Entity>
</matchAndMergeRecord>
</ns5:matchAndMergeResponse>
</S:Body>
</S:Envelope>