Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > advance_virtual_datetime_m

advance_virtual_datetime_m

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.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
offset_hours long 4 Positive integer number of hours to advance the given client's current virtual time.

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 Current virtual system date for the given client, in format yyyy-mm-dd (after application of input parameter "offset_hours").
virtual_time string Current virtual system time for the given client, in format hh24:mi:ss (after application of input parameter "offset_hours").
system_date string Current actual system date,in format yyyy-mm-dd.
system_time string Current actual system time,in format hh24:mi:ss.
current_offset_hours long 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").

You must to post a comment.
Last modified
14:40, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.