Group Anchor Delete

Description

Removes the individual as an anchor from the current group for the logged in user associated with the session id. If the anchor does not exist, then the call does nothing.

URI

REST URI [GET]:
/v11.02/Group.svc/AnchorDelete?SessionId={sessionId}&IndiOgfn={IndiOgfn}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Group.svc/AnchorDelete?SessionId=gl4q23cwofpshi55sg1pvc3o&IndiOgfn={IndiOgfn}
Success Response Payload 
<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>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

Request Parameters

Name Description Required

indiOgfn

The OGFN of the individual to remove from the group as an anchor

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

Nothing is returned for the Result.Value

Type: Nothing

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.