Individual Match Now

Description

The individual match now operation asks the system to start matching the individual against the entire OGF system immediatly.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Indi.svc/MatchNow/Indi/{indiOgfn}?SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Indi.svc/MatchNow/Indi/12345/?SessionId=gl4q23cwofpshi55sg1pvc3o
Success Response Payload 
1122334455
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

SessionId

The current session Id

Type: string

Default: None

Yes

Request Parameters

Name Description Required

indiOgfn

The OneGreatFamily ID for the individual to match now

Type: UInt64

Default: None

Constraints: Must be a valid individual ID.

Yes

Response Elements

Name Description

JobId

This operation returns a ulong that represents the JobId for the MatchNow. You can use this JobId to obtain status for the match job.

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.