Trillium Software System™ Programmer’s Guide, Volume 2 includes: Calling all modules on IBM Mainframe Output Data Tables for all API Modules Version 7.16 May 2017 This manual, as well as the software described in it, are furnished under license and may be used only in accordance with the terms of such license. The content of this manual is furnished for informational purposes only, is subject to change without notice, and should not be construed as a commitment by Trillium Software. Trillium Software assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. The customer shall not disclose, copy, reproduce, distribute, or display any portion of the Trillium Software System or this manual in any form to any third person without the prior written consent of Trillium Software, nor allow third parties to do the same. The customer shall keep the Trillium Software System and all confidential information in the strictest confidence. Trillium Software System Programmer’s Guide, Volume 2 53017 Trillium Software, Inc. owns all rights in and to the marks "TRILLIUM SOFTWARE" and "TRILLIUM SOFTWARE SYSTEM," which marks are registered in various countries throughout the world (including, without limitation, the United States Patent and Trademark Office). All other trademarks are the property of their respective owners. © 2008-2017 Trillium Software, Inc. Table of Contents iii TABLE OF CONTENTS CHAPTER 1 Trillium Software System Applications Programming Interface (API) ........................ 1-1 CHAPTER 2 Trillium Software System API Calls on IBM Mainframe ........................................... 2-1 API Calls from COBOL on IBM Mainframe ..................... 2-2 The Call Types for ‘Action’ Parameter (COBOL) ........... 2-6 Xpediter Considerations ........................................ 2-6 Calling the Investigator API from COBOL ................. 2-7 Calling the Converter API from COBOL .................... 2-9 Calling the Customer Data Parser API from COBOL ..2-11 Calling the Business Data Parser API from COBOL ...2-13 Calling the Global Data Router API from COBOL ......2-15 Calling the US Postal Geocoder API from COBOL......2-17 Calling the US Geocoder API from COBOL (DPV, LACSLink, and SuiteLink Supported)......................................2-21 Calling US Centroid Census Geocoder API from COBOL ..............................................................2-51 Calling the US Interpolated Rooftop Census Geocoder API from COBOL .......................................................2-54 Calling the API for All US Census Geocoders from COBOL ..............................................................2-58 Calling the CA Postal Geocoder API from COBOL......2-62 Calling the AU Postal Geocoder API from COBOL......2-67 Calling the DE Postal Geocoder API from COBOL......2-71 Calling the HK Postal Geocoder API from COBOL .....2-76 Calling the IT Postal Geocoder API from COBOL.......2-81 Calling the UK Postal Geocoder API from COBOL .....2-86 Calling the TG Postal Geocoder API from COBOL......2-94 Calling the Create Window Key API from COBOL.... 2-100 Calling the Data Reconstructor API from COBOL .... 2-102 Calling the Matcher API from COBOL.................... 2-104 CHAPTER 3 Trillium Software System Return Data & Output Tables ............................................................... 3-1 Converter/Investigator API Error Codes ..................... 3-2 Customer Data Parser API Output ............................. 3-3 Customer Data Parser API Error Codes...................3-32 Trillium Software System™ Programmer’s Guide, Volume 2 iv Table of Contents Business Data Parser API Output .............................3-33 Business Data Parser API Error Codes ....................3-35 Global Data Router API Error Codes .........................3-36 Data Reconstructor Output .....................................3-37 Data Reconstructor API Error Codes.......................3-37 Data Reconstructor API Compiler Error Messages ....3-38 Window Key Generator API Error Codes....................3-44 US Postal Geocoder API Output ...............................3-46 US Postal Geocoder Input/Output Data ..................3-46 Return Info Data Area .........................................3-48 US Match Possibilities Data Area ...........................3-59 DISPLAY_BASEDATA Parameter Options.................3-61 US Centroid Census Geocoder API Output .................3-69 Input Data to Centroid Census Geocoder ................3-69 US Centroid Census Geocoder Output Data.............3-72 US Centroid Census Geocoder Street Tract Match Section Error Codes........................................................3-80 US Centroid Census Geocoder DISPLAY_BASEDATA Options .............................................................3-81 US Interpolated Rooftop Census Geocoder API Output 3-82 Output Data Layout.............................................3-84 Error Codes........................................................3-87 CA Postal Geocoder API Output ...............................3-88 CA Postal Geocoder Input and Output Data.............3-88 CA Match Possibilities Data Area ...........................3-96 CA DISPLAY_BASEDATA Parameter Options.......... 3-100 AU Geocoder API Output ...................................... 3-103 AU Postal Geocoder Input and Output Data .......... 3-103 AU DISPLAY_BASEDATA Parameter Options.......... 3-109 AU Geocoder Error Codes ................................... 3-110 DE Geocoder API Output ...................................... 3-112 DE Postal Geocoder Input and Output Data........... 3-112 DE Match Possibilities Data Area ......................... 3-115 DE DISPLAY_BASEDATA Parameter Options.......... 3-116 HK Geocoder API Output ...................................... 3-119 HK Postal Geocoder Input and Output Data ........ 3-119 HK Match Possibilities Data Area ......................... 3-121 HK DISPLAY_BASEDATA Parameter Options.......... 3-121 IT Geocoder API Output ....................................... 3-125 IT Postal Geocoder Input and Output Data............ 3-125 IT Match Possibilities Data Area .......................... 3-127 Trillium Software System™ Programmer’s Guide, Volume 2 Table of Contents v IT DISPLAY_BASEDATA Parameter Options........... 3-128 UK Geocoder API Output ...................................... 3-131 UK Geocoder Input/Output Data ......................... 3-131 UK Match Possibilities Data Area ......................... 3-134 UK DISPLAY_BASEDATA Parameter Options.......... 3-135 TG Geocoder API Output....................................... 3-141 TG Geocoder DISPLAY_BASEDATA Parameter Options ........................................................... 3-145 LEVEL_MATCHING parameter values ................... 3-148 TG Geocoder Match Possibilities Data Area ........... 3-149 Matcher Functions – Error Codes ........................... 3-153 Universal Cleansing Adapter API Error Codes........... 3-161 XML Function Error Codes..................................... 3-163 Index .......................................................................I-1 Trillium Software System™ Programmer’s Guide, Volume 2 vi Table of Contents Trillium Software System™ Programmer’s Guide, Volume 2 CHAPTER 1 Trillium Software System Applications Programming Interface (API) Trillium Software System™ modules can be run on any platform that supports the ANSI standard C language. API languages supported through this document and Trillium Software Technical Support are listed below. This document is organized to assist developers in the creation of programs to execute a call to a specific function of their choice. To get started, find the platform you will be calling functions from and then locate the programming language you will be using. For additional assistance, call or E-mail Trillium Software Technical Support at [email protected]. Trillium Software System Applications Programming Interface (API) 1-2 This manual is the second of two volumes and contains the following chapters: • Chapter 2 “Trillium Software System API Calls on IBM Mainframe” • Chapter 3 “Trillium Software System Return Data & Output Tables” See the Programmer’s Guide, Volume I for an overview section describing all the basics involved with API functionality. See Volume I also for information about calling the Trillium Software System® from C, C++, C#, Visual Basic, Visual Basic .NET, and Java on the Microsoft Windows platform, and from C and Java on the UNIX platform. Volume I also contains information about using the Trillium Software System® Universal Cleansing Adapter (UCA). Trillium Software System™ Programmer’s Guide, Volume 2 CHAPTER 2 Trillium Software System API Calls on IBM Mainframe This chapter describes calls to the Trillium Software System API on the IBM Mainframe. The Trillium Software System® Applications Programming Interface (API) supports calls from the COBOL programming language on the IBM Mainframe. Trillium Software System API Calls on IBM Mainframe 2-2 API Calls from COBOL on IBM Mainframe API Calls from COBOL on IBM Mainframe Batch COBOL calls on the IBM Mainframe use the load modules located in the customer .TRIL7140.CALLABLE.LOADLIB of the Trillium Software System® base installation. • Most of the load modules contain an imbedded “#” sign in the name. • Sample batch programs are located in the library TRIL7140.SAMPLES.CALLABLE.SRCLIB PDS, under the COB* members as well as in the .\samples directory of the base installation. These Callable API Load Modules, created