Currently selected Anchor Switch

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.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Group.svc/CurrentAnchorSwitch/{indiOgfn}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Group.svc/CurrentAnchorSwitch/123456?SessionId=gl4q23cwofpshi55sg1pvc3o
Success Response Payload 
0
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

Int32

This operation returns a result code of 0 if successfull, otherwise an error will be returned.

Type: Int32

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.