Match Now Status Get

Description

The MatchStatus operation is used to retrieve the status of a job in the OneGreatFamily system.

URI

REST URI [GET]:
/v11.02/Status.svc/MatchStatus?SessionId={sessionId}&JobId={jobId}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Status.svc/MatchStatus?SessionId=y31cusfxzcmjikeyttwptx5n&JobId=58402583

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="MatchNowJobStatus">
		<JobId>58406443</JobId>
		<UserOgfn>1856968</UserOgfn>
		<GroupOgfn>1438575</GroupOgfn>
		<AnchorOgfn>225586336</AnchorOgfn>
		<CurrentProgress>100</CurrentProgress>
		<ErrorLast>0</ErrorLast>
		<JobCreated>2011-03-28T09:02:05</JobCreated>
		<JobStarted>2011-03-28T09:02:06</JobStarted>
		<JobEndTimeEstimate>0001-01-01T00:00:00</JobEndTimeEstimate>
		<JobEnded>2011-03-28T09:02:08</JobEnded>
		<Stage>67</Stage>
		<TotalProgress>100</TotalProgress>
		<MatchResults>
			<MatchResult>
				<Action>Merged</Action>
				<OriginalOgfn>225586333</OriginalOgfn>
				<MatchedOgfn>605311178</MatchedOgfn>
				<Score>100</Score>
			</MatchResult>
			<MatchResult>
				<Action>Merged</Action>
				<OriginalOgfn>225586334</OriginalOgfn>
				<MatchedOgfn>225574889</MatchedOgfn>
				<Score>100</Score>
			</MatchResult>
			<MatchResult>
				<Action>Merged</Action>
				<OriginalOgfn>225586335</OriginalOgfn>
				<MatchedOgfn>225574887</MatchedOgfn>
				<Score>100</Score>
			</MatchResult>
			<MatchResult>
				<Action>Merged</Action>
				<OriginalOgfn>225586336</OriginalOgfn>
				<MatchedOgfn>225586333</MatchedOgfn>
				<Score>100</Score>
			</MatchResult>
		</MatchResults>
	</Value>
</Result>

Fault Response Payload

<RestFault xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<ErrorCode>551</ErrorCode>
	<FaultMessage>An unhandled exception has occurred</FaultMessage>
</RestFault>

Query String Parameters

Name Description Required

Name	Description	Required
`JobId`	Id of the match Job Type: ulong Default: None Constraints: Must be a valid job Id	Yes
SessionId	The current session Id Type: string Default: None	Yes

JobId

Id of the match Job

Type: ulong

Default: None

Constraints: Must be a valid job Id

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

The only thing returned is the entity below:

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	This operation returns a `MatchNowJobStatus` entity upon success. Otherwise an error is returned. Type:`MatchNowJobStatus`
`HTTP Status Code`	The Web Server returns a status code which indicates if the operation was successful. Anything other than 200 should be regarded as a failure.
`HTTP Status Code` of 417	The Web Server threw an exception and contains a `RestFault` entity. Retrieve the RestFault from the Webexception response property.