MatchUp Web Service:Batch JSON
Jump to navigation
Jump to search
| MatchUp Navigation | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| Sample Code |
A maximum of up to 100 records per request can be sent.
HTTP Request Header
The HTTP header requires the following values:
Content-Type: application/json Accept: application/json
GetMatchcodeList
JSON Request
{
"Localization": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
JSON Response
{
"Matchcodes":[
{
"Name": {"type":"string"},
"Description": {"type":"string"},
"InputFields":[{"type":"array"}]
}
],
"TransmissionReference": {"type":"string"},
"Version": {"type":"string"}
}
CreateJob
JSON Request
{
"CustomerID": {"type":"string"},
"Matchcode": {"type":"string"},
"Options": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
JSON Response
{
"JobID": {"type":"string"},
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
SubmitRecords
JSON Request
{
"CustomerID": {"type":"string"},
"JobID": {"type":"string"},
"DataFrame": {"type":"string"},
"Records":[
{
"RecordID": {"type":"string"},
"FullName": {"type":"string"},
"FirstName": {"type":"string"},
"LastName": {"type":"string"},
"CompanyName": {"type":"string"},
"AddressLine1": {"type":"string"},
"AddressLine2": {"type":"string"},
"AddressLine3": {"type":"string"},
"City": {"type":"string"},
"State": {"type":"string"},
"PostalCode": {"type":"string"},
"PhoneNumber": {"type":"string"},
"EmailAddress": {"type":"string"}
}
],
"TransmissionReference": {"type":"string"}
}
JSON Response
{
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
SubmitJob
JSON Request
{
"CustomerID": {"type":"string"},
"JobID": {"type":"string"},
"TotalRecords": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
JSON Response
{
"EstimatedExecutionTime": {"type":"integer"},
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
GetJobStatus
JSON Request
{
"CustomerID": {"type":"string"},
"JobID": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
JSON Response
{
"EstimatedExecutionTime": {"type":"integer"},
"PercentComplete": {"type":"string"},
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
RetrieveRecords
JSON Request
{
"CustomerID": {"type":"string"},
"JobID": {"type":"string"},
"DataFrame": {"type":"integer"},
"TransmissionReference":{"type":"string"}
}
JSON Response
{
"Records":[
{
"RecordID": {"type":"string"},
"DupeGroup": {"type":"integer"},
"Count": {"type":"integer"},
"MatchcodeKey": {"type":"string"},
"Results": {"type":"string"}
}
],
"TransmissionReference": {"type":"string"}
}