The following section includes sample REST request call as well as the response.
Required values to identify match:
- Legal Name
- Address
- First Name
- Last Name
- Phone
New Organization and Contact Person Web Service Request
REST
Copy
[
{
"correlationID": "22",
"entity": {
"id": "130748",
"objectType": "OrganizationCustomer",
"references": {
"CustomerSourceSystem": {
"references": [
{
"target": "SystemY",
"targetType": "entity",
"values": {
"SourceRecordID": {
"values": [
{
"value": "52855-1250"
}
]
}
}
}
]
}
},
"values": {
"LegalName": {
"value": {
"value": "ACC Distributors, Inc."
}
}
}
}
},
{
"correlationID": "31",
"entity": {
"objectType": "ContactPerson",
"references": {
"ContactPersonOrganization": {
"references": [
{
"entity": {
"references": {
"CustomerSourceSystem": {
"references": [
{
"target": "SystemY",
"targetType": "entity",
"values": {
"SourceRecordID": {
"values": [
{
"value": "52855-1250"
}
]
}
}
}
]
}
}
},
"targetType": "entity"
}
]
},
"CustomerSourceSystem": {
"references": [
{
"target": "SystemY",
"targetType": "entity",
"values": {
"SourceRecordID": {
"values": [
{
"value": "52855-1250"
}
]
}
}
}
]
}
},
"values": {
"FirstName": {
"value": {
"value": "Anna"
}
},
"LastName": {
"value": {
"value": "Paul"
}
}
}
}
}
]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:Value AttributeID="PhoneType">Cell</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:Value AttributeID="EmailType">Personal</step:Value>
</step:Values>
</step:DataContainer>
</step:MultiDataContainer>
</step:DataContainers>
</ns1:Entity>
</matchAndMergeRecord>
</ns:matchAndMergeRequest>
</soapenv:Body>
</soapenv:Envelope>New Organization and Contact Person Web Service Response
REST
Copy
{
"matchAndMergeGeneralExecutionReport": {
"httpStatus": 200,
"message": null,
"httpReason": "OK"
},
"matchAndMergeResponses": [
{
"correlationID": "22",
"status": "PROCESSED",
"potentialDuplicates": [],
"matchAndMergeExecutionReport": {
"operation": "UPDATE",
"errorMessage": null,
"rejectedByBusinessCondition": [],
"rejectedByPotentialDuplicates": false
},
"entity": {
"id": "130748",
"name": null,
"objectType": "OrganizationCustomer",
"parent": "111301",
"values": {
"LegalName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "ACC Distributors, Inc.",
"valueId": null,
"unit": null
}
}
},
"references": {
"CustomerSourceSystem": {
"references": [
{
"contextLocal": true,
"target": "SystemY",
"targetType": "entity",
"values": {
"SourceRecordID": {
"contextLocal": true,
"inherited": null,
"values": [
{
"value": "52855-1250",
"valueId": null,
"unit": null
},
{
"value": "52855-12501",
"valueId": null,
"unit": null
}
]
}
},
"inherited": null,
"entity": null
}
]
}
},
"dataContainers": {}
}
},
{
"correlationID": "31",
"status": "PROCESSED",
"potentialDuplicates": [],
"matchAndMergeExecutionReport": {
"operation": "UPDATE",
"errorMessage": null,
"rejectedByBusinessCondition": [],
"rejectedByPotentialDuplicates": false
},
"entity": {
"id": "131509",
"name": null,
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"FirstName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Anna",
"valueId": null,
"unit": null
}
},
"LastName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Paul",
"valueId": null,
"unit": null
}
}
},
"references": {
"ContactPersonOrganization": {
"reference": {
"contextLocal": true,
"target": "130748",
"targetType": "entity",
"values": {},
"inherited": null,
"entity": {
"id": "130748",
"name": null,
"objectType": "OrganizationCustomer",
"parent": "111301",
"values": {
"LegalName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "ACC Distributors, Inc.",
"valueId": null,
"unit": null
}
}
},
"references": {
"CustomerSourceSystem": {
"references": [
{
"contextLocal": true,
"target": "SystemY",
"targetType": "entity",
"values": {
"SourceRecordID": {
"contextLocal": true,
"inherited": null,
"values": [
{
"value": "52855-1250",
"valueId": null,
"unit": null
},
{
"value": "52855-12501",
"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": "52855-1250",
"valueId": null,
"unit": null
}
]
}
},
"inherited": null,
"entity": null
}
]
}
},
"dataContainers": {}
}
}
]
}SOAP
Copy
SYS CMDM
Software project
MENU
PLANNING
DEVELOPMENT
OPERATIONS
This is a company-managed project
Learn more
Projects
SYS CMDM
Add parent
CMDM-555
Update webservice examples to account for DC keys
Time tracking
No time logged
Description
Add a description...
Attachments (14)
SourceRecordIDReference REST REQUEST.txt
07 Feb 2024, 02:30 PM
SourceRecordIDReference REST RESPONSE.txt
07 Feb 2024, 02:30 PM
Create New Contact REST REQUEST.txt
07 Feb 2024, 01:52 PM
Create New Contact REST RESPONSE.txt
07 Feb 2024, 01:52 PM
Create New Contact SOAP REQUEST.txt
07 Feb 2024, 01:42 PM
Create New Contact SOAP RESPONSE.txt
07 Feb 2024, 01:42 PM
Activity
Show:
All
Comments
History
Work log
Checklist history
Newest first
Add a comment…
Pro tip: press
M
to comment
Marty Jenkins
2 hours ago
Coexistence Examples
Marty Jenkins
February 5, 2024 at 11:05 AM
With the addition of adding DC keys for phone and email type the current webservice examples are now giving an error due to type not being provided in the request.
In Progress
Flag removed
Actions
Details
Parent
NEW
None
Team
CMDM Enablement
Assignee
Unassigned
Assign to me
Development
Create branch
Create commit
Releases
Add feature flag
Labels
None
Prism Link
Reporter
Marty Jenkins
Priority
Medium
Fix versions
None
Original estimate
0d
Sprint
Enablement Sprint 18
+1
More fields
Story Points
None
Components
None
Automation
Rule executions
Checklist
Open Checklist
Whiteboards
Open Whiteboards
Created February 5, 2024 at 11:04 AM
Updated 2 hours ago
Configure
Create New Contact SOAP RESPONSE.txt
text · 2 KB
<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 ParentID="111660" ID="390703" UserTypeID="ContactPerson">
<ns3:EntityCrossReference Type="CustomerSourceSystem" EntityID="SystemX">
<ns3:MetaData>
<ns3:MultiValue AttributeID="SourceRecordID">
<ns3:Value>123</ns3:Value>
</ns3:MultiValue>
</ns3:MetaData>
</ns3:EntityCrossReference>
<ns3:Values>
<ns3:Value AttributeID="LastName">Nuckols</ns3:Value>
<ns3:Value AttributeID="FirstName">Joanna</ns3:Value>
</ns3:Values>
<ns3:DataContainers>
<ns3:MultiDataContainer Type="EmailDataContainer">
<ns3:DataContainer ID="390705">
<ns3:Values>
<ns3:Value AttributeID="EmailField">jonuckols@aol.com</ns3:Value>
</ns3:Values>
</ns3:DataContainer>
</ns3:MultiDataContainer>
<ns3:MultiDataContainer Type="PhoneDataContainer">
<ns3:DataContainer ID="390706">
<ns3:Values>
<ns3:Value AttributeID="PhoneNumber">4065467413</ns3:Value>
</ns3:Values>
</ns3:DataContainer>
</ns3:MultiDataContainer>
<ns3:DataContainer ID="390704" Type="MainAddressDataContainer">
<ns3:Values>
<ns3:Value AttributeID="CalcFormattedAddress" Derived="true">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>Contact to Organization Reference Request
Reference the new contact person to an existing organization customer using the Source Record ID.
REST
Copy
[{
"correlationID": "1",
"entity": {
"id": "",
"name": "string",
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"FirstName": {
"value": {
"value": "Joanna"
}
},
"LastName": {
"value": {
"value": "Nuckols"
}
}
},
"references": {
"ContactPersonOrganization": {
"reference": {
"entity": {
"references": {
"CustomerSourceSystem": {
"references": [{
"target": "SystemX",
"targetType": "entity",
"values": {
"SourceRecordID": {
"values": [{
"value": "81661-8996"
}
]
}
}
}
]
}
}
}
}
}
},
"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"
}
},
"PhoneType": {
"value": {
"value": "Cell"
}
}
}
}
]
},
"EmailDataContainer": {
"dataContainers": [{
"values": {
"EmailField": {
"value": {
"value": "jonuckols@aol.com"
}
},
"EmailType": {
"value": {
"value": "Personal"
}
}
}
}
]
}
}
}
}
]Contact to Organization Reference 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": "390714",
"name": null,
"objectType": "ContactPerson",
"parent": "111660",
"values": {
"LastName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Nuckols",
"valueId": null,
"unit": null
}
},
"FirstName": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "Joanna",
"valueId": null,
"unit": null
}
}
},
"references": {
"ContactPersonOrganization": {
"reference": {
"contextLocal": true,
"target": "387233",
"targetType": "entity",
"values": {},
"inherited": null,
"entity": null
}
},
"CustomerSourceSystem": {
"references": [
{
"contextLocal": true,
"target": "SystemX",
"targetType": "entity",
"values": {},
"inherited": null,
"entity": null
}
]
}
},
"dataContainers": {
"EmailDataContainer": {
"dataContainers": [
{
"values": {
"EmailField": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "jonuckols@aol.com",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
],
"inherited": null
},
"PhoneDataContainer": {
"dataContainers": [
{
"values": {
"PhoneNumber": {
"calculated": false,
"contextLocal": true,
"inherited": null,
"value": {
"value": "4065467413",
"valueId": null,
"unit": null
}
}
},
"references": {}
}
],
"inherited": null
},
"MainAddressDataContainer": {
"dataContainer": {
"values": {},
"references": {}
},
"inherited": null
}
}
}
}
]
}