Group Anchor Switch Current

Description

Switches the current anchor for the particular user. Users can have many anchors into the OneGreatFamily system, the current anchor is the one that is used by when getting a tree or navigating a tree. If you want to navigate or manipulate a different tree, you will need to switch the current anchor.

URI

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Group.svc/CurrentAnchorSwitch?SessionId=gl4q23cwofpshi55sg1pvc3o&IndiOgfn=123456
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 individual ogfn to switch anchors too

Type: UInt64

Default: None

Constraints: Must be a valid individual ogfn

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.