Read Group

Description

This operation returns the currently selected group for the currently logged in user.

URI

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

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Group.svc/Read?SessionId=24354354353451534514545

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="Group">
		<AdminUserName>UserWSAPI</AdminUserName>
		<AnchorOgfns xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
			<a:unsignedLong>0</a:unsignedLong>
		</AnchorOgfns>
		<Ogfn>123456</Ogfn>
		<Name>group-name</Name>
		<Password>group-password</Password>
	</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

Name

Description

Required

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a group entity if successful, otherwise nothing Type: Group
`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.