Difference between revisions of "MatchUp Web Service:RetrieveRecords"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{MatchUpWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key, ...")
 
 
Line 9: Line 9:


MatchUp Web Service supports the JSON and REST protocols to access the service.
MatchUp Web Service supports the JSON and REST protocols to access the service.
{{HTTPHeader-MatchUp}}


==Field Names==
==Field Names==

Latest revision as of 17:07, 26 March 2021

← MatchUp

MatchUp Navigation
Introduction
Licensing
Input/Output
GetMatchcodeList
CreateJob
SubmitRecords
SubmitJob
GetJobStatus
RetrieveRecords
Examples
REST JSON
Batch JSON
Result Codes
Result Code Use
MatchUp Result Codes
Sample Code



A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key, Job ID, and Data Frame are all required.

MatchUp Web Service supports the JSON and REST protocols to access the service.

Header

HTTP headers need to match the protocols and formats being used.

MatchUp requires the values of Content-Type and Accept.

Example JSON Request Header

{
    "Content-Type": "application/json; charset=utf-8",
    "Accept": "application/json"
}


Field Names

This is a list of the field names and their protocol naming conventions.

Request

Field Name REST JSON
License Key id CustomerID
Job ID job JobID
Data Frame frame DataFrame
Transmission Reference t TransmissionReference
Format format Format


Response

Field Name
Records
RecordID
DupeGroup
Count
MatchcodeKey
Results
TransmissionReference


RetrieveRecordsRequest

This will retrieve the processing results.

License Key

Required.
This is a string value containing the License Key issued to the customer by Melissa for the MatchUp Web Service.
If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "CustomerID":"string"
REST &id = string


Job ID

Required.
This is a string value with the Job ID returned by CreateJob.
Protocol Syntax
JSON "JobID":"string"
REST &job = string


Data Frame

Required.
This is a string value with a user-specified unique identification for this set of record(s). This was previously set with SubmitRecordsRequest.
Protocol Syntax
JSON "DataFrame":"string"
REST &frame = string


Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "TransmissionReference":"string"
REST &t = string


Format

Optional.
Specify the desired output format (XML or JSON). Default is .
Protocol Syntax
JSON "Format":"string"
REST &format = string


RetrieveRecordsResponse

This will return the record response, including the dupe group and matchcode key.

Records

This is an array containing the
Protocol Syntax
JSON "Records":{array}


RecordID

This is a string value with a user-specified unique identification for this record. This was set with SubmitRecords.
Protocol Syntax
JSON "RecordID":"string"


DupeGroup

This is a unique number assigned by MatchUp to each group of duplicate records.
Protocol Syntax
JSON "DupeGroup":number


Count

This is a number indicating the number of matching records.
Protocol Syntax
JSON "Count":number


MatchcodeKey

This is a string value containing the matching key used during deduplication.
Protocol Syntax
JSON "MatchcodeKey":"string"


Results

This is a string value containing the results of the RetrieveRecordsRequest.
Protocol Syntax
JSON "Results":"string"


TransmissionReference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "TransmissionReference":"string"