Admin at 17:07, 26 March 2021

2021-03-26T17:07:04Z

← 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 at 21:21, 24 March 2017

2017-03-24T21:21:49Z

Show changes

Admin at 21:17, 24 March 2017

2017-03-24T21:17:50Z

@@ Line 68: / Line 68: @@
 ==SubmitRecordsRequest==
 This will submit a set of records for processing.
@@ Line 303: / Line 331: @@
 |-
 |REST||<code>&email = '''''string'''''</code>
 |}

Admin at 22:56, 23 March 2017

2017-03-23T22:56:29Z

← Older revision		Revision as of 22:56, 23 March 2017
Line 334:		Line 334:


	=SubmitRecordsResponse=		==SubmitRecordsResponse==
	This will return the '''SubmitRecordsRequest''' results.		This will return the '''SubmitRecordsRequest''' results.

Admin at 22:55, 23 March 2017

2017-03-23T22:55:58Z

← Older revision		Revision as of 22:55, 23 March 2017
Line 338:		Line 338:

	<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 ~~'''~~SubmitRecordsRequest~~'''~~.		:This is a string value containing the results of the [[#SubmitRecordsRequest\|SubmitRecordsRequest]].

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

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

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
|-
|Records|| ||
|-
|Record ID||recid||RecordID
|-
|Full Name||full||FullName
|-
|First Name||fn||FirstName
|-
|Last Name||ln||LastName
|-
|Company Name||comp||CompanyName
|-
|Address Line 1||a1||AddressLine1
|-
|Address Line 2||a2||AddressLine2
|-
|Address Line 3||a3||AddressLine3
|-
|City||city||City
|-
|State||state||State
|-
|Postal Code||postal||PostalCode
|-
|Phone Number||phone||PhoneNumber
|-
|Email Address||email||EmailAddress
|-
|Transmission Reference||t||TransmissionReference
|-
|Format||format||Format
|}

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

==SubmitRecordsRequest==
This will submit a set of records for processing.

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

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

<h3 style="background-color:rgb(240,240,240);">Records</h3>
:This is an array containing the record content. Only fields listed in the [[MatchUp Web Service:GetMatchcodeList#InputFields|InputFields]] element of the matchcode's [[MatchUp Web Service:GetMatchcodeList#GetMatchcodeListResponse|GetMatchcodeListResponse]] need to be input. Any other fields will be ignored.

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

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

:This is a string value with a user-specified unique identification for this record.

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

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

:This is a string value containing the full name.

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

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

:This is a string value containing the first name.

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

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

:This is a string value containing the last name.

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

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

:This is a string value containing the company name.

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

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

:This is a string value containing the first address line.

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

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

:This is a string value containing the second address line.

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

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

:This is a string value containing the third address line.

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

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

:This is a string value containing the city name.

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

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

:This is a string value containing the state.

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

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

:This is a string value containing the postal code.

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

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

:This is a string value containing the phone number.

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

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

:This is a string value containing the email address.

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

=SubmitRecordsResponse=
This will return the '''SubmitRecordsRequest''' results.

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

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

Admin at 17:07, 26 March 2021

Admin at 21:21, 24 March 2017

Admin at 21:17, 24 March 2017

Admin at 22:56, 23 March 2017

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