EMS.Services.TEMSInternalAPI.UpdateUser

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function UpdateUser(const AObjectID: string;  const AUserFields: TJSONObject): IEMSResourceResponseContent; overload;

C++

_di_IEMSResourceResponseContent __fastcall UpdateUser(const System::UnicodeString AObjectID, System::Json::TJSONObject* const AUserFields)/* overload */;

Properties

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

Description

Updates the fields from an EMS User.

UpdateUser updates the content of a given EMS User in the EMS Server, adding, updating or deleting custom fields.

  • To add a new custom field, add a custom name/value pair to the TJSONObject.
  • To delete a field, pass a null value in the JSON object for that pair.
 {"description":null}

The UpdateUser method receives the following parameters:

  • AObjectID: EMS User identifier that uniquely identifies an EMS User in the EMS Server.
  • AUserFields: TJSONObject with the custom fields of an EMS User.

UpdateUser returns an IEMSResourceResponseContent to read the response from the EMS Server.

See Also