User Signout

Description

The user signout operation signs the user out of the system and clears the user information associated with the sessionId.

URI's

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

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/User.svc/Signout?SessionId=q340ulxbcqgf41riz0jbzbog

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</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

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

SessionId

Session id for the currently signed in user

Type: String

Default: None

Constraints: Must be a valid session id.

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Nothing is returned for Result.Value in this call Type: None
`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.