Logout API
  • 1 Minute to read
  • Dark
    Light
  • PDF

Logout API

  • Dark
    Light
  • PDF

Article summary

Logs out of the Planful Web Service application.

Syntax

OperationResult = api.Logout()

Usage

Use the Logout call to log out of the Planful Web Service application. When a Client application invokes the Logout call, the Web Service abandons the current user session.

The Client application must be logged in with sufficient access rights to logout from the application. Client applications do not need to explicitly log out to end the session. Sessions expire automatically after a predetermined length of time, which is 120 minutes (two hours).

Response

OperationResult

The Logout method call returns an OperationResult object, which contains the status and the status message of the logout method call.

Sample Code

Private Sub Logout()
Dim objResult As OperationResult
Try
'Call the web method to logout from the API
		objResult = api.Logout()
		Console.WriteLine (objResult.message)
Catch ex As Exception
End Try
End Sub

Was this article helpful?