Application Program Interface
Introduction
In order to effectively integrate the QTRACS/400 system with your existing software systems, various programs and utilities are provided to the user at the call level. You may wish to modify existing programs to take advantage of these calls. The following sections describe the calling interface to be used to call the QTRACS/400 API.
QTAPI and QTAPILE Copy Members
In order to facilitate easier usage of the API's by SAE's and customers, two deliverable source members are available. These source members, QTAPI (RPG) and QTAPILE (RPGLE), contain code snippets that may be copied to site-specific external application programs as needed. These code snippets are 'API calling sequences' and 'transaction packet formats'. These members are unconditionally delivered to each customer and may be found in OMRPGSRC in library OMNIDLVSRC.
Implementation Note
The QTRACS/400 API suite consists entirely of ILE programs (no old-style OPM programs exist anymore). These ILE programs run in QTRACS' persistent activation group OMACTGRP. Therefore, be aware that all callers of these APIs shall have this activation group created in their PAG. The calling application may use the RCLACTGRP command if it desires to explicitly remove this activation group. In most cases this shouldn't be necessary. The activation group will dissolve automatically when the job completes or the user signs off.
General Purpose Utilities
- Add a QTRACS Place - OMADDPLC
- Add a QTRACS Place Enhanced - OMADDPLCE (new for v7.0)
- Add Remove User from Address List - OMADLUSR
- Add Remove Vehicle to Group - OMGRPVEH
- Attach Vehicle Position Data Stream - OMPOSCON
- Cancel Message - OMCNLMSG
- CC Additional Recipients on a Return Message - OMCCRMSG
- Change a QTRACS Place Record - OMCHGPLC
- Change a QTRACS Place Record Enhanced - OMCHGPLCE (new for v7.0)
- Change Vehicle Coverage - OMCHGCVG
- Change Vehicle Description - OMVEHDSC
- Create Default Auxiliary Vehicle - OMDFTAVH
- Create Default User - OMDFTUSR
- Create Default Vehicle - OMDFTVEH
- Create Forward Message - OMMSCRT
- Create Message - OMCRTMSG
- Create Message Rejection Warning - OMEAWARN
- Create Monitor Landmark Export File for QMI - OMQMIPLC
- Delete a QTRACS Vehicle - OMDLTVEH
- Driver Management - OMDRVMGT
- Get Component Version Information - OMGETCVI
- Get Macro Information - OMGMAC
- Get Macro Template Information - OMGMACT
- Get Message Information - OMGETMSG
- Get Next Driver - OMNXTDRV
- Get Next Unseen Message - OMGETUNS
- Get Next User - OMNXTUSR
- Get Next Vehicle by UA - OMNXTVUA
- Get Next Vehicle - OMNXTVEH
- Get QMASS Routing Assignments - OMQMVRA
- Get System Configuration Data -OMGCFG
- Get Unseen Forward Message Count - OMGTUFMC
- Get Unseen Messages Count - OMGTUNSC
- Get User Capability - OMCAPVAL
- Get Vehicle Identifier - OMGETVID
- Maintain QMASS Routing Assignment - OMQMSRA
- Manage Vehicle Parameters - OMMCTMGT
- Mark a Message as Seen - OMMKSEEN
- Obtaining a Host Message Number - OMGETHMN
- QTRACS Displays Utility - OMQTDSP
- Receive File Queue - OMRCVFIL
- Release Scheduled Message by Vehicle - OMSCDVEH
- Remove a QTRACS Place - OMRMVPLC
- Remove Message Text - OMNUKTXT
- Rename a QTRACS Vehicle Identifier - OMRNMVEH
- Request Vehicle Parameter Update - OMRQVPRM
- Request Vehicle Position Update - OMUPDPOS
- Reset System Counters - OMRSTSYS
- Retrieve a Global Message Handle Number - OMRTVGMH
- Retrieve a Postal Code - OMGETZIP
- Retrieve Auxiliary Account Info - OMAUXRTV
- Retrieve Vehicle Group Membership - OMRTVGRP
- Set Vehicle's Next Stop - OMSETSTP
- Stopping an OMNIX Background Process - STOPTASK
- Update a QTRACS Place Alias - OMUPALIS
- Validate a QTRACS Entity - OMVENT
- Verify Delete QTRACS User - OMVDUSR
- Window a QTRACS Entity List - OMWENT
- Window a QTRACS Geography List - OMWGEO
- Window a QTRACS Place List - OMWPLC
- Work with Messages - OMWWMSG
Date & Time Conversion Utilities
- Convert Date Time, Given a Place, to GMT Secs - OMDP2GMT
- Convert Date Time, Given a Time Zone, to GMT Secs - OMDZ2GMT
- Convert Date Time to GMT Seconds - OMDT2GMT
- Convert GMT Seconds to Date Time Given a Place - OMGMT2DP
- Convert GMT Seconds to Date Time - OMGMT2DT
- Convert GMT Secs to Date Time in a Given Time Zone - OMGMT2DZ
- Get Current Date - OMCURDAT
- Parse and Validate Date Time String - OMPVDAT
- Return Current Date Time in GMT Seconds - OMCGMTS
- Set Daylight Savings Flag - OMSETDSF
Vehicle Location Utilities
- Compute Line of Sight Distance and Direction - OMLOSDD
- Compute Line of Sight Distance and Direction Enhanced - OMLOSDDE (new for v7.0)
- Convert Degrees, Minutes, Seconds to Seconds - OMCDMSS
- Convert Seconds to Degrees, Minutes, Seconds - OMCSDMS
- Get List of Vehicles Near a Given Place - OMVEHLST
- Get List of Vehicles Near a Given Place Enhanced - OMVEHLSTE (new for v7.0)
- Get Places Near Request - OMPRXPLC
- Get Places Near Request Enhanced - OMPRXPLCE (new for v7.0)
- Get Proximity Reference - OMGETPRX
- Get Proximity Reference Enhanced - OMGETPRXE (new for v7.0)
- Get QTRACS Place Information - OMGETPLC
- Get Three Proximity References - OMTHRPRX
- Get Three Proximity References Enhanced - OMTHRPRXE (new for v7.0)
- Get Trailers Near Request - TTPRXTRL
- Get Vehicle Position History - OMGETPHS
- Get Vehicle Position History Enhanced - OMGETPHSE (new for v7.0)
- Get Vehicle Proximity Reference - OMVEHPRX
- Get Vehicles Near Request - OMPRXVEH
- Get Vehicles Near Request Enhanced - OMPRXVEHE (new for v7.0)
- Request Proximity Query - OMPRXQRY
- Request Proximity Query Enhanced - (OMPRXQRYE) (new for v7.0)
- Return Places Near - OMPLCNER
- Return Places Near Enhanced - OMPLCNERE (new for v7.0)
- Work with Vehicle Position History - OMWWVPH