Skip to main content
Aria Knowledge Central

advance_virtual_datetime_m

Summary

API Name advance_virtual_datetime_m
Class system_services_m
Update Version 3.5

Description

Takes a number of hours by which to further advance virtual time for the given client, then returns the same output elements as "get_virtual_datetime", as well as the new/current offset hours value AFTER application of the input offset hours value. Use of this method in production systems will return an "operation not allowed" error as virtual time is only supported in non-production systems.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

offset_hours long 4 Yes

Positive integer number of hours to advance the given client's current virtual time.

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.

error_msg string   No

Description of any error that occurred. "OK" if there was no error.

virtual_date string   No

Current virtual system date for the given client, in format yyyy-mm-dd (after application of input parameter "offset_hours").

virtual_time string   No

Current virtual system time for the given client, in format hh24:mi:ss (after application of input parameter "offset_hours").

system_date string   No

Current actual system date,in format yyyy-mm-dd.

system_time string   No

Current actual system time,in format hh24:mi:ss.

current_offset_hours long   No

Difference, in truncated hours, between the client's current virtual date/time and the actual system date/time. Is always zero or a positive integer in non-production systems, and is always zero in production systems after application of input parameter "offset_hours").

TOP
  • Was this article helpful?