Admin at 17:06, 26 March 2021

2021-03-26T17:06:51Z

← Older revision		Revision as of 17:06, 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 at 22:57, 23 March 2017

2017-03-23T22:57:49Z

← Older revision		Revision as of 22:57, 23 March 2017
Line 116:		Line 116:


	=CreateJobResponse=		==CreateJobResponse==
	This will return a job id and any results of the request.		This will return a job id and any results of the request.

Line 130:		Line 130:

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

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 21:23, 23 March 2017

2017-03-23T21:23:29Z

← Older revision		Revision as of 21:23, 23 March 2017
Line 17:		Line 17:
	!Field Name !! REST !! JSON		!Field Name !! REST !! JSON
	\|-		\|-
	\|License Key\|id\|\|CustomerID		\|License Key\|\|id\|\|CustomerID
	\|-		\|-
	\|Matchcode\|\|mc\|\|Matchcode		\|Matchcode\|\|mc\|\|Matchcode

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

2017-03-23T21:22:48Z

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

New page

{{MatchUpWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is 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
|-
|Matchcode||mc||Matchcode
|-
|Options||opt||Options
|-
|Transmission Reference||t||TransmissionReference
|-
|Format||format||Format
|}

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

==CreateJobRequest==
This will request the initiation of a job.

<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);">Matchcode</h3>
:''Required.''

:This is a string value that is the matchcode that will be used.

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

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

:This is a string value of the matching options to be used.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Options":"'''''string'''''"</code>
|-
|REST||<code>&opt = '''''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>
|}

=CreateJobResponse=
This will return a job id and any results of the request.

<h3 style="background-color:rgb(240,240,240);">JobID</h3>
:This is a string value containing a job id assigned to this job.

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

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

:{| 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:CreateJob - Revision history

Admin at 17:06, 26 March 2021

Admin at 22:57, 23 March 2017

Admin at 21:23, 23 March 2017

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