Family Conflicts Read

Description

This operation allows getting all the conflicts for an family optionally filtering the results

URI

REST URI [GET]:
/v11.02/Familyl.svc/ConflictsGet?SessionId= &IndiOgfn=(Required-UInt64-Ogfn for the individual to get conflicts for) &ConflictType=(Optional-String - valid options: [DATA | RELATIONSHIP | ALL] - Default: ALL) &ConflictFilter=(Optional - String - valid options: [see below] - Default: No Filter)&IncludeConflictOwners(Optional -[TRUE | FALSE] - Default: FALSE)

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc/ConflictsGet?indiOgfn=280039571&conflictType=ALL&conflictFilter=START&currentOwners=True&sessionId=e4j5jodqx4tnt5i1pmk4ec5x

<Code>

</Code>

Success

</Message>

</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
IndiOgfn	OneGreatFamily ID for the individual Type: UInt64 Default: None Constraints: Must be a valid individual ID.	Yes
ConflictType	[DATA \| RELATIONSHIP \| ALL] Type: String Default: ALL Constraints: None
ConflictFilter	[ALL \| CHILD \| DIVORCEDATE \| DIVORCEPLACE \| HUSBAND \| MARRIAGEDATE \| MARRIAGEPLACE \| WIFE] Type: String Default: ALL Constraints: Must be a valid individual ID.
IncludeConflictOwners	[TRUE \| FALSE] Type: String Default: FALSE Constraints: None

Response Elements

The only thing returned is the return code below:

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a List<ConflictInfo> on success. Type: Array of ConflictInfo
`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.