Admin at 17:07, 26 March 2021

2021-03-26T17:07:29Z

← Older revision		Revision as of 17:07, 26 March 2021
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==

Admin: 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, ..."

2017-03-23T22:54:58Z

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, ..."

New page

{{MatchUpWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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.

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

<h3 style="background-color:rgb(240,240,240);">Request</h3>
{| class="alternate01 sortable"
!Field Name !! REST !! JSON
|-
|License Key||id||CustomerID
|-
|Job ID||job||JobID
|-
|Data Frame||frame||DataFrame
|-
|Transmission Reference||t||TransmissionReference
|-
|Format||format||Format
|}

<h3 style="background-color:rgb(240,240,240);">Response</h3>
{| class="alternate01 sortable"
!Field Name
|-
|Records
|-
|RecordID
|-
|DupeGroup
|-
|Count
|-
|MatchcodeKey
|-
|Results
|-
|TransmissionReference
|}

==RetrieveRecordsRequest==
This will retrieve the processing results.

<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Job ID</h3>
:''Required.''

:This is a string value with the Job ID returned by [[MatchUp Web Service:CreateJob|CreateJob]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"JobID":"'''''string'''''"</code>
|-
|REST||<code>&job = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Data Frame</h3>
:''Required.''

:This is a string value with a user-specified unique identification for this set of record(s). This was previously set with [[MatchUp Web Service:SubmitRecordsRequest#Data Frame|SubmitRecordsRequest]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DataFrame":"'''''string'''''"</code>
|-
|REST||<code>&frame = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:''Optional.''

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

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|REST||<code>&t = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''

:Specify the desired output format (XML or JSON). '''Default is '''.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Format":"'''''string'''''"</code>
|-
|REST||<code>&format = '''''string'''''</code>
|}

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

<h3 style="background-color:rgb(240,240,240);">Records</h3>
:This is an array containing the

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Records":{'''''array'''''}</code>
|}

<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:This is a string value with a user-specified unique identification for this record. This was set with [[MatchUp Web Service:SubmitRecords#RecordID|SubmitRecords]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">DupeGroup</h3>
:This is a unique number assigned by MatchUp to each group of duplicate records.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DupeGroup":'''''number'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Count</h3>
:This is a number indicating the number of matching records.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Count":'''''number'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">MatchcodeKey</h3>
:This is a string value containing the matching key used during deduplication.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MatchcodeKey":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value containing the results of the [[#RetrieveRecordsRequest|RetrieveRecordsRequest]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

[[Category:MatchUp Web Service]]
[[Category:Reference]]

MatchUp Web Service:RetrieveRecords - Revision history

Admin at 17:07, 26 March 2021

Admin: 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, ..."