Match Now Status Get

Description

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

Version

2011-02-02

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Status.svc/MatchStatus/58402583?sessionid=y31cusfxzcmjikeyttwptx5n
Success Response Payload 
<JobStatus xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<AnchorOgfn>0</AnchorOgfn>
	<CurrentProgress>0</CurrentProgress>
	<ErrorLast>0</ErrorLast>
	<GroupOgfn>1437141</GroupOgfn>
	<JobCreated>2011-02-10T15:23:26</JobCreated>
	<JobEndTimeEstimate>0001-01-01T00:00:00</JobEndTimeEstimate>
	<JobEnded>0001-01-01T00:00:00</JobEnded>
	<JobId>58402583</JobId>
	<JobStarted>2011-02-10T15:23:26</JobStarted>
	<Stage>1</Stage>
	<TotalProgress>0</TotalProgress>
	<UserOgfn>1854214</UserOgfn>
</JobStatus> 
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
JobId

The given names of the individual you want to search for.

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 aggregate below:

Name Description

JobStatus

This operation returns a JobStatus aggregate upon success. Otherwise an error is returned.

Type:JobStatus

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 aggregate. Retrieve the RestFault from the Webexception response property.