EMS.Services.TEMSInternalAPI.LoginUser

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function LoginUser(const AUserName, APassword: string): IEMSResourceResponseContent; overload;
function LoginUser(const AJSONLogin: TJSONObject): IEMSResourceResponseContent; overload;

C++

_di_IEMSResourceResponseContent __fastcall LoginUser(const System::UnicodeString AUserName, const System::UnicodeString APassword)/* overload */;
_di_IEMSResourceResponseContent __fastcall LoginUser(System::Json::TJSONObject* const AJSONLogin)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
EMS.Services.pas
EMS.Services.hpp
EMS.Services TEMSInternalAPI

Description

Logs on an EMS User to the EMS Server.

The LoginUser method is overloaded:

  • The first overloaded method adds the AUserName and the APassword to a TJSONObject. This method calls the second overloaded LoginUser method with the resulting TJSONObject.
  • The second overloaded method logs on a new EMS User to the EMS Server. AJSONBody contains the EMS User data as a TJSONobject.
Note: The EMS Username and Password fields are required.

LoginUser returns an IEMSResourceResponseContent to read the response from the resource.

See Also