User Read

Description

The UserRead operation retreives the user object for the currently logged in user.

Version

2011-02-02

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

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/User.svc/Read?sessionid=qwo1ybhpm5yenbuy1bn3btet
Success Response Payload
<UserWS xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<AccountId>0</AccountId>
	<Address1>Address1</Address1>
	<Address2>Address2</Address2>
	<City>Springville</City>
	<Country>USA</Country>
	<Email>test@onegreatfamily.com</Email>
	<FirstName>First Name</FirstName>
	<GroupOgfns xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
		<a:unsignedLong>5</a:unsignedLong>
		<a:unsignedLong>6</a:unsignedLong>
	</GroupOgfns>
	<LastName>Surname</LastName>
	<Ogfn>1854111</Ogfn>
	<Password>wsuser-1947946234</Password>
	<State>Utah</State>
	<SubscriptionType>NONE</SubscriptionType>
	<UserType>NONE</UserType>
	<Username>wsuser-1947946234</Username>
	<Zip>84663</Zip>
</UserWS>
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 session id for the currently logged in user

Type: String

Default: None

Constraints: Must be a valid session id.

Yes

Response Elements

The only thing returned is the aggregate below:

Name Description

User

This operation returns a UserWS aggregate upon success.

Type: UserWS

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.