MatchUp Web Service:REST JSON

← MatchUp

GetMatchcodeList

REST Request

GetMatchcodeList
?loc={Localization}
&t={TransmissionReference}
&format={Format}

JSON Response

{
  "Matchcodes":[
    {
      "Name": {"type":"string"},
      "Description": {"type":"string"},
      "InputFields":[{"type":"array"}]
    }
  ],
  "TransmissionReference": {"type":"string"},
  "Version": {"type":"string"}
}

CreateJob

REST Request

CreateJob
?id={CustomerID}
&mc={Matchcode}
&opt={Options}
&t={TransmissionReference}
&format={Format}

JSON Response

{
  "JobID": {"type":"string"},
  "Results": {"type":"string"},
  "TransmissionReference": {"type":"string"}
}

SubmitRecords

REST Request

SubmitRecords
?id={CustomerID}
&job={JobID}
&frame={DataFrame}
&recid={RecordID}
&full={FullName}
&fn={FirstName}
&ln={LastName}
&comp={CompanyName}
&a1={AddressLine1}
&a2={AddressLine2}
&a3={AddressLine3}
&city={City}
&state={State}
&postal={PostalCode}
&phone={PhoneNumber}
&email={EmailAddress}
&t={TransmissionReference}
&format={Format}

JSON Response

{
  "Results": {"type":"string"},
  "TransmissionReference": {"type":"string"}
}

SubmitJob

REST Request

SubmitJob
?id={CustomerID}
&job={JobId}
&recs={TotalRecords}
&t={TransmissionReference}
&format={Format}

JSON Response

{
  "EstimatedExecutionTime": {"type":"integer"},
  "Results": {"type":"string"},
  "TransmissionReference": {"type":"string"}
}

GetJobStatus

REST Request

GetJobStatus
?id={CustomerID}
&job={JobID}
&t={TransmissionReference}
&format={Format}

JSON Response

{
  "EstimatedExecutionTime": {"type":"integer"},
  "PercentComplete": {"type":"string"},
  "Results": {"type":"string"},
  "TransmissionReference": {"type":"string"}
}

RetrieveRecords

REST Request

RetrieveRecords
?id={CustomerID}
&job={JobId}
&frame={DataFrame}
&t={TransmissionReference}
&format={Format}

JSON Response

{
  "Records":[
    {
      "RecordID": {"type":"string"},
      "DupeGroup": {"type":"integer"},
      "Count": {"type":"integer"},
      "MatchcodeKey": {"type":"string"},
      "Results": {"type":"string"}
    }
  ],
  "TransmissionReference": {"type":"string"}
}