Difference between revisions of "MatchUp Web Service:GetMatchcodeList"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 91: Line 91:
This will return a list of available matchcodes and their descriptions.
This will return a list of available matchcodes and their descriptions.


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


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




<h3 style="background-color:rgb(240,240,240);">Name</h3>
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value containing the matchcode name.
:This is a string value containing the current version number.


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




<h3 style="background-color:rgb(240,240,240);">Description</h3>
<h3 style="background-color:rgb(240,240,240);">Matchcodes</h3>
:This is a string value containing a description of this matchcode.
:This is an array containing a list of the available matchcodes.


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




<h3 style="background-color:rgb(240,240,240);">InputFields</h3>
<h3 style="background-color:rgb(240,240,240);">Name</h3>
:This is an array containing a list of input fields that should be specified when using this matchcode.
:This is a string value containing the matchcode name.


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




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


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




<h3 style="background-color:rgb(240,240,240);">Version</h3>
<h3 style="background-color:rgb(240,240,240);">InputFields</h3>
:This is a string value containing the current version number.
:This is an array containing a list of input fields that should be specified when using this matchcode.


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


Revision as of 21:07, 24 March 2017

← 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.

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.

Request

Field Name REST JSON
Localization loc Localization
Transmission Reference t TransmissionReference
Format format Format


Response

Field Name Level
TransmissionReference Response (Base)
Version
Matchcodes
Name Matchcodes
Description
InputFields


GetMatchcodeListRequest

This will request a list of available matchcodes and their descriptions.

Localization

Optional.
Language (culture code) to use for output fields Name and Description. Currently ignored.
Protocol Syntax
JSON "Localization":"string"
REST ?loc = 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


GetMatchcodeListResponse

This will return a list of available matchcodes and their descriptions.

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"


Version

This is a string value containing the current version number.
Protocol Syntax
JSON "Version":"string"


Matchcodes

This is an array containing a list of the available matchcodes.
Protocol Syntax
JSON "Matchcodes":{array}


Name

This is a string value containing the matchcode name.
Protocol Syntax
JSON "Name":"string"


Description

This is a string value containing a description of this matchcode.
Protocol Syntax
JSON "Description":"string"


InputFields

This is an array containing a list of input fields that should be specified when using this matchcode.
Protocol Syntax
JSON "InputFields":{array}
Retrieved from "http://wiki.melissadata.com/index.php?title=MatchUp_Web_Service:GetMatchcodeList&oldid=12785"