User Logout

Description

The UserLogout operation logs the user out of the system and clears the session id.

Version

2011-02-02

URI's

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

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/User.svc/logout?sessionid=q340ulxbcqgf41riz0jbzbog

Success Response Payload

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>

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

Name	Description	Required
`SessionId`	Session id for the currently logged in user Type: String Default: None Constraints: Must be a valid session id.	Yes

SessionId

Session id for the currently logged in user

Type: String

Default: None

Constraints: Must be a valid session id.

Yes

Response Elements

Name Description

Name	Description
return code	An integer value where 0 means success. Type: Integer
`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.

return code

An integer value where 0 means success.

Type: Integer

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.