MatchUp Web Service:CreateJob: Difference between revisions
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 i..." |
No edit summary |
||
| 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 | ||
Revision as of 21:23, 23 March 2017
| MatchUp Navigation | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| Sample Code |
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.
Request
| Field Name | REST | JSON |
|---|---|---|
| License Key | id | CustomerID |
| Matchcode | mc | Matchcode |
| Options | opt | Options |
| Transmission Reference | t | TransmissionReference |
| Format | format | Format |
Response
| Field Name |
|---|
| JobID |
| Results |
| TransmissionReference |
CreateJobRequest
This will request the initiation of a job.
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
Matchcode
- Required.
- This is a string value that is the matchcode that will be used.
Protocol Syntax JSON "Matchcode":"string"REST &mc = string
Options
- Optional.
- This is a string value of the matching options to be used.
Protocol Syntax JSON "Options":"string"REST &opt = 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
CreateJobResponse
This will return a job id and any results of the request.
JobID
- This is a string value containing a job id assigned to this job.
Protocol Syntax JSON "Matchcodes":"string"
Results
- This is a string value containing the results of the CreateJobRequest.
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"