API:REST.Backend.EMSServices.TEMSUsersAPI.UpdateUser

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure UpdateUser(const AObject: TBackendEntityValue;  const AUserData: TJSONObject; out AUpdatedObject: TBackendEntityValue);

C++

HIDESBASE void __fastcall UpdateUser(const Rest::Backend::Metatypes::TBackendEntityValue &AObject, System::Json::TJSONObject* const AUserData, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUpdatedObject);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSUsersAPI

Description

Replaces the existing information about the specified user with the specified information.

REST.Backend.EMSServices.TEMSUsersAPI.UpdateUser inherits from REST.Backend.EMSServices.TEMSLoginAPI.UpdateUser. All content below this line refers to REST.Backend.EMSServices.TEMSLoginAPI.UpdateUser.

Replaces the existing information about the specified user with the specified information.

UpdateUser receives the following parameters:

  • AUser is an instance of TBackendEntityValue that indicates the target user.
  • AUserObject is a JSON object that contains the new data for the target user.
  • AUpdatedAt is an instance of TBackendEntityValue that UpdateUser fills with the date and time when the EMS Server applied the requested change.

Exceptions

Exception Message Description

EEMSClientAPIError

MasterSecret required

The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string.

Session token required

The type of authentication is TAuthentication.Session you did not log in.

See Also