EMS.Services.TEMSInternalAPI.SignupUser

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
EMS.Services.pas
EMS.Services.hpp
Unit: EMS.Services
Parent: TEMSInternalAPI

Delphi

function SignupUser(const AUserName, APassword: string;
const AUserFields: TJSONObject): IEMSResourceResponseContent; overload;
function SignupUser(const AJSONBody: TJSONObject): IEMSResourceResponseContent; overload;

C++

_di_IEMSResourceResponseContent __fastcall SignupUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, System::Json::TJSONObject* const AUserFields)/* overload */;
_di_IEMSResourceResponseContent __fastcall SignupUser(System::Json::TJSONObject* const AJSONBody)/* overload */;

Description

Signs up a new EMS User in the EMS Server.

The SignupUser method is overloaded:

  • The first overloaded method adds the AUserName, the APassword, and (optionally) the custom AUserFields to a TJSONObject. This method calls the second overloaded SignupUser method with the resulting TJSONObject.
  • The second overloaded method signs up a new EMS User to the EMS Server. AJSONBody contains the EMS User data as a TJSONObject. The EMS Username and Password fields are required.

SignupUser returns an IEMSResourceResponseContent to read the response from the resource. The response from the EMS Server includes the session identifier.

See Also