Skip to main content
Omnitracs Knowledge Base

Get Current Date - OMCURDAT

Get Current Date (OMCURDAT)

Required Parameter Group:

1

Include Separators

Input

Char(1)

2

Date/Time Length Type

Input

Char(1)

3

Date/Time Format

Input

Char(4)

4

Return Status

Output

Char(1)

5

Date/Time String

Output

Char(50)

API Overview:
The Get Current Date API (OMCURDAT) retrieves the current system date/time and returns it formatted as requested by the input parameters. The date/time of the host system is assumed to be in the same time zone as that specified in the QTRACS System Configuration screen. The date/time string is returned in the user's configurable time zone.

Programs calling this API are urged to check the return status field. The date/time string will be blank if any validation failed or if input parameters are incorrect.

Required Parameter Group Details:
(1) Include Separators
INPUT; CHAR(1)
This parameter indicates if the Date/Time String should include separators. Valid values are:

0

Do not include separators

1

Include separators

(2) Date/Time Length Type
INPUT; CHAR(1)
This parameter indicates the length type for the Date/Time String. Valid values are:

0

Long (includes year, month, day, hours, minutes, seconds, & time zone)

1

Short (includes month, day, hours, minutes, & time zone)

2

Extra long (includes century, year, month, day, hours, minutes, seconds, & time zone)

(3) Date/Time Format
INPUT; CHAR(4)
This parameter contains the requested output format for the Date/Time String. Valid values are:

*MDY

Month, day, year format (MM/DD/YY)

*DMY

Day, month, year format (DD/MM/YY)

*YMD

Year, month, day format (YY/MM/DD)

*JUL

Julian format (YY/JJJ)

*JOB

Evaluates to one of the above (unless job is set to Julian, then it is overridden to *YMD)

(4) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:

0

Success, date returned

1

Failure, error encountered

(5) Date/Time String
OUTPUT; CHAR(50)
This parameter returns the left-justified converted date string in the format specified by the input parameters.

  • Was this article helpful?