Admin at 18:37, 24 March 2017

2017-03-24T18:37:09Z

← Older revision		Revision as of 18:37, 24 March 2017
Line 1:		Line 1:
	{{MatchUpWebServiceNav		{{MatchUpWebServiceNav
	\|~~InputOutputCollapse~~=		\|ExampleCollapse=
	}}		}}

Admin: Created page with "{{MatchUpWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} ==GetMatchcodeList== ===REST Request===

 GetMatchcodeList ?loc={Localization} &t={TransmissionReference} ..."

2017-03-24T18:36:50Z

Created page with "{{MatchUpWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} ==GetMatchcodeList== ===REST Request=== <pre> GetMatchcodeList ?loc={Localization} &t={TransmissionReference} ..."

New page

{{MatchUpWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

==GetMatchcodeList==
===REST Request===
<pre>
GetMatchcodeList
?loc={Localization}
&t={TransmissionReference}
&format={Format}
</pre>

===JSON Response===
<pre>
{
"Matchcodes":[
{
"Name": {"type":"string"},
"Description": {"type":"string"},
"InputFields":[{"type":"array"}]
}
],
"TransmissionReference": {"type":"string"},
"Version": {"type":"string"}
}
</pre>

==CreateJob==
===REST Request===
<pre>
CreateJob
?id={CustomerID}
&mc={Matchcode}
&opt={Options}
&t={TransmissionReference}
&format={Format}
</pre>

===JSON Response===
<pre>
{
"JobID": {"type":"string"},
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
</pre>

==SubmitRecords==
===REST Request===
<pre>
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}
</pre>

===JSON Response===
<pre>
{
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
</pre>

==SubmitJob==
===REST Request===
<pre>
SubmitJob
?id={CustomerID}
&job={JobId}
&recs={TotalRecords}
&t={TransmissionReference}
&format={Format}
</pre>

===JSON Response===
<pre>
{
"EstimatedExecutionTime": {"type":"integer"},
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
</pre>

==GetJobStatus==
===REST Request===
<pre>
GetJobStatus
?id={CustomerID}
&job={JobID}
&t={TransmissionReference}
&format={Format}
</pre>

===JSON Response===
<pre>
{
"EstimatedExecutionTime": {"type":"integer"},
"PercentComplete": {"type":"string"},
"Results": {"type":"string"},
"TransmissionReference": {"type":"string"}
}
</pre>

==RetrieveRecords==
===REST Request===
<pre>
RetrieveRecords
?id={CustomerID}
&job={JobId}
&frame={DataFrame}
&t={TransmissionReference}
&format={Format}
</pre>

===JSON Response===
<pre>
{
"Records":[
{
"RecordID": {"type":"string"},
"DupeGroup": {"type":"integer"},
"Count": {"type":"integer"},
"MatchcodeKey": {"type":"string"},
"Results": {"type":"string"}
}
],
"TransmissionReference": {"type":"string"}
}
</pre>

[[Category:MatchUp Web Service]]
[[Category:Reference]]

MatchUp Web Service:REST JSON - Revision history

Admin at 18:37, 24 March 2017

Admin: Created page with "{{MatchUpWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} ==GetMatchcodeList== ===REST Request===
GetMatchcodeList ?loc={Localization} &t={TransmissionReference} ..."