Read Group

Description

The GroupRead operation returns the currently selected group for the currently logged in user.

Version

2011-02-02

URI

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Group.svc/Read/12345?SessionId=24354354353451534514545
Success Response Payload
<Group xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
  <AdminUserName>UserWSAPI</AdminUserName>
  <AnchorOgfns xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:unsignedLong>0</a:unsignedLong>
  </AnchorOgfns>
  <GroupOgfn>143713</GroupOgfn>
  <Name>groupWSAPI</Name>
  <Password>groupWSAPI</Password>
</Group>
 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

Response Elements

Name Description

Group

This operation returns a Group aggregate upon success. Otherwise an error is returned.

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 aggregate. Retrieve the RestFault from the Webexception response property.