Individual Match Now Async

Description

The individual match now operation asks the system to start matching the individual(s) against the entire OGF system immediately. This call is asynchronous and will return a job id you can use to track the progress.

URI

REST URI [GET]:
/v11.02/Individual.svc/MatchNow?SessionId={SessionId}&IndiOgfns={indiOgfn,indiOgfn,indiOgfn...}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Individual.svc/MatchNow?SessionId=gl4q23cwofpshi55sg1pvc3o&IndiOgfns=123456789,987654321

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="a:unsignedLong">1855450</Value>
</Result>

Failed Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>27001</Code>
	<Message>Your developer Id does not have permissions to make this call</Message>
</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
SessionId	The current session Id Type: string Default: None	Yes
IndiOgfns	One or more indi ogfn's in a comma seperated list Type: UInt64 Default: None Constraints: Must be a valid individual ID.	Yes

Name

Description

Required

SessionId

The current session Id

Type: string

Default: None

Yes

IndiOgfns

One or more indi ogfn's in a comma seperated list

Type: UInt64

Default: None

Constraints: Must be a valid individual ID.

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a UInt64 for the jobId of the asynchronous job Type: UInt64
`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.