Ofcas.Lk.Api.V3  3.0.0.98
Ofcas.Lk.Api.Core.LoginScopeFactory Class Reference

Class for creating the login scope (LoginScope). More...

Public Member Functions

 LoginScopeFactory (IApiService apiService)
 
LoginScope Login (string programMode, string user, string password)
 Login to the API to get access to projects, elvations etc. . Without login no access to the API is available. Attention: Before a login is possible, a service must be started. More...
 

Detailed Description

Class for creating the login scope (LoginScope).

Member Function Documentation

◆ Login()

LoginScope Ofcas.Lk.Api.Core.LoginScopeFactory.Login ( string  programMode,
string  user,
string  password 
)

Login to the API to get access to projects, elvations etc. . Without login no access to the API is available. Attention: Before a login is possible, a service must be started.

Parameters
programModeThe program mode provided from Orgadata for the associated partner
userThe name of the LogiKal user. LogiKal users are administered in LogiKal.
passwordThe password for the LogiKal user.
Returns
The LoginScope to interact with LogiKal
Exceptions
ExceptionIf creating login scope fails.

The documentation for this class was generated from the following file: