Commences a Firmwater LMS web service client session.

Syntax

LmsLoginResult = lmsBinding.Login (string licenseeLoginId, string username, string password);

Usage

A client application must invoke the Login call passing in a licensee ID, a username and password. During invocation, Firmwater LMS web service authenticates the login information, and upon successful authentication, returns an identifier for the session and a URL address pointing to the Firmwater LMS web service server that is to be used for future calls for the duration of the session.

Immediately following a successful Login call, the client application shall specify the new target URL for all subsequent calls. It must also include the session identifier inside the SOAP header of all future calls. Methods of accomplishing this differ between development platforms. Sample code is included below for a small number of platforms. Refer to your particular platform's documentation for further details.

Arguments

Name	Type	Description
licenseeLoginId	string	Client ID of the organization the user is associated with
username	string	Login username
password	string	Login password

Return Object

LmsLoginResult

Sample Code - C#

public void wsLogin () {

LmsLoginResult loginResult;
LMSService1 lmsBinding = new LMSService1();

// call login
loginResult = lmsBinding.Login ("myClientId", "myUsername", "myPassword");

// set the session id header
lmsBinding.SessionHeaderValue = new SessionHeader();
lmsBinding.SessionHeaderValue.sessionId = loginResult.SessionId;

// reset the end point
lmsBinding.Url = loginResult.ServerUrl;
}

Sample SOAP messages

Request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
 xmlns:ns4="http://firmwater.com/webservices/lms/lmsservice1"
>

  <SOAP-ENV:Body>
    <ns4:Login>
      <ns4:licenseeLoginId>acme</ns4:licenseeLoginId>
      <ns4:username>jsmith</ns4:username>
      <ns4:password>Y5k9lP</ns4:password>
    </ns4:Login>
  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
>

  <soap:Body>
    <LoginResponse xmlns="http://firmwater.com/webservices/lms/lmsservice1">
      <LoginResult>
        <SessionId>15c868ef-d1f0-4f17-9406-baf21e0dbca4</SessionId>
        <ServerUrl>http://lms.firmwater.com/lms/webservices/LMSService1.asmx</ServerUrl>
      </LoginResult>
    </LoginResponse>
  </soap:Body>

</soap:Envelope>