Logs in to the Clarizen API server and starts a session
Parameters
- userName (String)
- Login user name
- password (String)
- Login password
- options (LoginOptions)
- Additional options such as partnerId and applicationId
Return Value
Usage
The login operation is used to authenticate a user and start a new session in Clarizen. After the server authenticates
the user it will start a new session and return that session as part of the LoginResult return value.
The session id must be sent on every call to the web service by using a SessionHeader SOAP header.
Sessions automatically expire after a period of inactivity (currently this is configured to be 30 minutes). If the session has
expired and the client tries to invoke a web service call, the call will fail with an exception code of SessionTimout
Examples
The following example shows how to authenticate against the Clarizen API server and start a session
Copy | |
---|---|
static void Main() { LoginOptions loginOptions=new LoginOptions(); loginOptions.PartnerId = "MyPartnerId"; loginOptions.ApplicationId = "applicationId"; LoginResult res=clarizen.Login("samh","mypassword",loginOptions); } |