MatchUp Web Service:SubmitJob

From Melissa Data Wiki
Jump to navigation Jump to search

← MatchUp Web Service

MatchUp Web Service Navigation
Introduction
Licensing
Input/Output
GetMatchcodeList
CreateJob
SubmitRecords
SubmitJob
GetJobStatus
RetrieveRecords
Examples
REST JSON
Batch JSON
Result Codes
Result Code Use
MatchUp Web Service Result Codes
Sample Code



A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key and Job ID are 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
Total Records recs TotalRecords
Transmission Reference t TransmissionReference
Format format Format


Response

Field Name
EstimatedExecutionTime
Results
TransmissionReference


SubmitJobRequest

This will submit a job 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


Total Records

Optional.
This is a string value that sets the total number of records submitted. This will be compared by the service with the number of records received and a result code will be returned if they don't match.
Protocol Syntax
JSON "TotalRecords":"string"
REST &recs = 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


SubmitJobResponse

This will return the approximate processing time and any result codes for the job.

EstimatedExecutionTime

This is a string value containing the approximate processing time of the job.
Currently not implemented
Protocol Syntax
JSON "EstimatedExecutionTime":"string"


Results

This is a string value containing the results of the SubmitJobRequest.
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"