MatchUp Web Service:SubmitRecords

← MatchUp

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"