Home > Aria Crescendo Documentation > Aria Crescendo core api > get_virtual_datetime_m


Returns the current virtual date, and virtual time for the given client, plus actual system date and system time, and the number of offset hours between the virtual and system date/time. In Production systems these values will have no offset/delta between them as virtual time is only supported in non-production systems.

For a list of error messages generated by this API, see get_virtual_datetime_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
virtual_date string The current virtual system date for the given client, in format yyyy-mm-dd (after application of input parameter "offset_hours").
virtual_time string The current virtual system time for the given client, in format hh24:mi:ss (after application of input parameter "offset_hours").
system_date string The current actual system date,in format yyyy-mm-dd.
system_time string The current actual system time,in format hh24:mi:ss.
current_offset_hours long The difference, in truncated hours, between the client's current virtual date/time and the actual system date/time. Will always be zero or a positive integer in non-production systems, and will always be a zero in production systems after application of input parameter "offset_hours").
is_batch_running string Returns "Y" or "N" depending on if the batch jobs are running in the background.
Last modified


This page has no custom tags.


This page has no classifications.