MatchUp Web Service:GetJobStatus - Revision history

Admin at 17:07, 26 March 2021

2021-03-26T17:07:21Z

← Older revision		Revision as of 17:07, 26 March 2021
Line 9:		Line 9:

	MatchUp Web Service supports the JSON and REST protocols to access the service.		MatchUp Web Service supports the JSON and REST protocols to access the service.

			{{HTTPHeader-MatchUp}}

	==Field Names==		==Field Names==

Admin at 16:08, 6 April 2017

2017-04-06T16:08:49Z

← Older revision		Revision as of 16:08, 6 April 2017
Line 108:		Line 108:
	:This is a string value containing the approximate processing time of the job.		:This is a string value containing the approximate processing time of the job.

	:(Currently not implemented)		:<span style="color:red">'''Currently not implemented'''</span>

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 20:43, 5 April 2017

2017-04-05T20:43:25Z

← Older revision		Revision as of 20:43, 5 April 2017
Line 103:		Line 103:

	==GetJobStatusResponse==		==GetJobStatusResponse==
	This will return the ~~approximate processing time and any result codes for the~~ job.		This will return the current status of a submitted job.

	<h3 style="background-color:rgb(240,240,240);">EstimatedExecutionTime</h3>		<h3 style="background-color:rgb(240,240,240);">EstimatedExecutionTime</h3>
	:This is a string value containing the approximate processing time of the job.		:This is a string value containing the approximate processing time of the job.

			:(Currently not implemented)

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 22:27, 23 March 2017

2017-03-23T22:27:46Z

← Older revision		Revision as of 22:27, 23 March 2017
Line 102:		Line 102:


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

Line 116:		Line 116:

	<h3 style="background-color:rgb(240,240,240);">Results</h3>		<h3 style="background-color:rgb(240,240,240);">Results</h3>
	:This is a string value containing the results of the [[#~~SubmitJobRequest~~\|~~SubmitJobRequest~~]].		:This is a string value containing the results of the [[#GetJobStatusRequest\|GetJobStatusRequest]].

	:{\| class="alternate01"		:{\| class="alternate01"

Admin: 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 a..."

2017-03-23T22:26:44Z

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 a..."

New page

{{MatchUpWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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.

==Field Names==
This is a list of the field names and their protocol naming conventions.

<h3 style="background-color:rgb(240,240,240);">Request</h3>
{| class="alternate01 sortable"
!Field Name !! REST !! JSON
|-
|License Key||id||CustomerID
|-
|Job ID||job||JobID
|-
|Transmission Reference||t||TransmissionReference
|-
|Format||format||Format
|}

<h3 style="background-color:rgb(240,240,240);">Response</h3>
{| class="alternate01 sortable"
!Field Name
|-
|EstimatedExecutionTime
|-
|PercentComplete
|-
|Results
|-
|TransmissionReference
|}

==GetJobStatusRequest==
This will query a submitted job's status.

<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Job ID</h3>
:''Required.''

:This is a string value with the Job ID returned by [[MatchUp Web Service:CreateJob|CreateJob]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"JobID":"'''''string'''''"</code>
|-
|REST||<code>&job = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:''Optional.''

:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|REST||<code>&t = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''

:Specify the desired output format (XML or JSON). '''Default is '''.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Format":"'''''string'''''"</code>
|-
|REST||<code>&format = '''''string'''''</code>
|}

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

<h3 style="background-color:rgb(240,240,240);">EstimatedExecutionTime</h3>
:This is a string value containing the approximate processing time of the job.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EstimatedExecutionTime":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value containing the results of the [[#SubmitJobRequest|SubmitJobRequest]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

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