MatchUp Web Service:SubmitRecords: Difference between revisions

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, ..."
 
No edit summary
 
(4 intermediate revisions by the same user not shown)
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==
Line 68: Line 70:


==SubmitRecordsRequest==
==SubmitRecordsRequest==
<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>
|}
This will submit a set of records for processing.
This will submit a set of records for processing.


Line 124: Line 154:




<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
:<h4 style="border-bottom:1px solid black;">Record ID</h4>
:''Optional.''
::''Optional.''


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


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 138: Line 168:




<h3 style="background-color:rgb(240,240,240);">Full Name</h3>
:<h4 style="border-bottom:1px solid black;">Full Name</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the full name.
::This is a string value containing the full name.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 152: Line 182:




<h3 style="background-color:rgb(240,240,240);">First Name</h3>
:<h4 style="border-bottom:1px solid black;">First Name</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the first name.
::This is a string value containing the first name.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 166: Line 196:




<h3 style="background-color:rgb(240,240,240);">Last Name</h3>
:<h4 style="border-bottom:1px solid black;">Last Name</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the last name.
::This is a string value containing the last name.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 180: Line 210:




<h3 style="background-color:rgb(240,240,240);">Company Name</h3>
:<h4 style="border-bottom:1px solid black;">Company Name</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the company name.
::This is a string value containing the company name.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 194: Line 224:




<h3 style="background-color:rgb(240,240,240);">Address Line 1</h3>
:<h4 style="border-bottom:1px solid black;">Address Line 1</h4>
:''Optional.''
::''Optional.''


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


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 208: Line 238:




<h3 style="background-color:rgb(240,240,240);">Address Line 2</h3>
:<h4 style="border-bottom:1px solid black;">Address Line 2</h4>
:''Optional.''
::''Optional.''


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


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 222: Line 252:




<h3 style="background-color:rgb(240,240,240);">Address Line 3</h3>
:<h4 style="border-bottom:1px solid black;">Address Line 3</h4>
:''Optional.''
::''Optional.''


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


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 236: Line 266:




<h3 style="background-color:rgb(240,240,240);">City</h3>
:<h4 style="border-bottom:1px solid black;">City</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the city name.
::This is a string value containing the city name.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 250: Line 280:




<h3 style="background-color:rgb(240,240,240);">State</h3>
:<h4 style="border-bottom:1px solid black;">State</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the state.
::This is a string value containing the state.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 264: Line 294:




<h3 style="background-color:rgb(240,240,240);">Postal Code</h3>
:<h4 style="border-bottom:1px solid black;">Postal Code</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the postal code.
::This is a string value containing the postal code.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 278: Line 308:




<h3 style="background-color:rgb(240,240,240);">Phone Number</h3>
:<h4 style="border-bottom:1px solid black;">Phone Number</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the phone number.
::This is a string value containing the phone number.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 292: Line 322:




<h3 style="background-color:rgb(240,240,240);">Email Address</h3>
:<h4 style="border-bottom:1px solid black;">Email Address</h4>
:''Optional.''
::''Optional.''


:This is a string value containing the email address.
::This is a string value containing the email address.


:{| class="alternate01"
::{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
Line 306: Line 336:




<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
==SubmitRecordsResponse==
:''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.
This will return the '''SubmitRecordsRequest''' results.


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

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


Response

Field Name
Results
TransmissionReference


SubmitRecordsRequest

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


This will submit a set of records for processing.

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).
Protocol Syntax
JSON "DataFrame":"string"
REST &frame = string


Records

This is an array containing the record content. Only fields listed in the InputFields element of the matchcode's GetMatchcodeListResponse need to be input. Any other fields will be ignored.
Protocol Syntax
JSON "Records":{array}


Record ID

Optional.
This is a string value with a user-specified unique identification for this record.
Protocol Syntax
JSON "RecordID":"string"
REST &recid = string


Full Name

Optional.
This is a string value containing the full name.
Protocol Syntax
JSON "FullName":"string"
REST &full = string


First Name

Optional.
This is a string value containing the first name.
Protocol Syntax
JSON "FirstName":"string"
REST &fn = string


Last Name

Optional.
This is a string value containing the last name.
Protocol Syntax
JSON "LastName":"string"
REST &ln = string


Company Name

Optional.
This is a string value containing the company name.
Protocol Syntax
JSON "CompanyName":"string"
REST &comp = string


Address Line 1

Optional.
This is a string value containing the first address line.
Protocol Syntax
JSON "AddressLine1":"string"
REST &a1 = string


Address Line 2

Optional.
This is a string value containing the second address line.
Protocol Syntax
JSON "AddressLine2":"string"
REST &a2 = string


Address Line 3

Optional.
This is a string value containing the third address line.
Protocol Syntax
JSON "AddressLine3":"string"
REST &a3 = string


City

Optional.
This is a string value containing the city name.
Protocol Syntax
JSON "City":"string"
REST &city = string


State

Optional.
This is a string value containing the state.
Protocol Syntax
JSON "State":"string"
REST &state = string


Postal Code

Optional.
This is a string value containing the postal code.
Protocol Syntax
JSON "PostalCode":"string"
REST &postal = string


Phone Number

Optional.
This is a string value containing the phone number.
Protocol Syntax
JSON "PhoneNumber":"string"
REST &phone = string


Email Address

Optional.
This is a string value containing the email address.
Protocol Syntax
JSON "EmailAddress":"string"
REST &email = string


SubmitRecordsResponse

This will return the SubmitRecordsRequest results.

Results

This is a string value containing the results of the SubmitRecordsRequest.
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"
Retrieved from "http://wiki.melissadata.com/index.php?title=MatchUp_Web_Service:SubmitRecords&oldid=17651"