Window a QTRACS Geography List - OMWGEO
Window a QTRACS Geography List (OMWGEO) RI
Required Parameter Group:
| 1 | Function Code | Input | Char(1) |
| 2 | Country Abbreviation | I/O | Char(2) |
| 3 | State Abbreviation | I/O | Char(2) |
| 4 | Return Description | Output | Char(25) |
| 5 | Return Status | Output | Char(1) |
API Overview:
The Window a QTRACS Geography List API (OMWGEO) serves two purposes: 1) it provides pop-up window support for all QTRACS geography locations (ie. country/state locations), and 2) it validates a given geography location against those stored in the QTRACS database and returns its description to the calling application. The pop-up window will display a scrollable, position-to capable, list of geography locations allowing the user to make a selection. The selection may optionally be returned as a parameter to the calling program.
Required Parameter Group Details:
(1) Function Code
INPUT; CHAR(1)
This parameter is a function code that instructs the API what action to perform. Valid values are:
| E | Edit Geography Location |
| W | Window Geography List |
(2) Country Abbreviation
I/O; CHAR(2)
This parameter contains the country abbreviation for the geography location. For example, US = United States and CN = Canada.
(3) State Abbreviation
I/O; CHAR(2)
This parameter contains the state abbreviation for the geography location.
(4) Return Description
OUTPUT; CHAR(25)
This parameter returns the description for the geography location. If a geography location cannot be found to match the input given, this field will contain blanks.
(5) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, geography country and state found and description returned |
| 1 | Success, selection made from pop-up window and returned |
| 2 | Success, F3=Exit pressed |
| 3 | Success, F12=Cancel pressed |
| 4 | Failure, geography country and/or state not found |
| 5 | Failure, invalid function code |
| A | Failure, API failed when called remotely |