REST.Backend.EMSApi.TEMSClientAPI.UpdateInstallation

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure UpdateInstallation(const AInstallationID: string; const AJSONObject: TJSONObject; out AUpdatedAt: TUpdatedAt);

C++

void __fastcall UpdateInstallation(const System::UnicodeString AInstallationID, System::Json::TJSONObject* const AJSONObject, /* out */ TUpdatedAt &AUpdatedAt);

Properties

Type Visibility Source Unit Parent
procedure
function
public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI

Description

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

UpdateInstallation receives the following parameters:

  • AInstallationID is a string with the ID of the target installation.
  • AInstallationObject is a JSON object that contains the new data for the target installation.
  • AUpdatedAt is an instance of TUpdatedAt that UpdateInstallation fills with the date and time when the EMS Server applied the requested change.

Exceptions

Exception Message Description

EEMSClientAPIError

Installation ID required

The specified installation ID is an empty string.

MasterSecret required

Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string.

Session token required

Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string.

See Also