YAddress SQL Client API Manual

Size: px

Start display at page:

Download "YAddress SQL Client API Manual"

Griffin Mathews
6 years ago
Views:

1 YAddress SQL Client API Manual Yuri Software, Inc. Sept 2017

2 Table of Contents YADDRESS... 3 ARCHITECTURE... 3 Project Setup... Error! Bookmark not defined. PROGRAMMING REFERENCE... 4 YADDRESSCLIENT CLASS... 4 Constructors... Error! Bookmark not defined. Methods... Error! Bookmark not defined. YADDRESSCLIENT.ADDRESS CLASS... ERROR! BOOKMARK NOT DEFINED. Properties... Error! Bookmark not defined. SAMPLE CODE... 8 Page 2

3 YAddress Architecture Installation YAddress provides developers with interface for address correction, validation, standardization and geocoding. This manual describes YAddress client for Microsoft SQL Server. YAddress client is implemented as a Common Language Runtime (CLR) User Defined Function (UDF). The UDF needs to be installed in each database where you plan to use it, by adding a CLR assembly to the database and creating the corresponding UDF. Alternatively, you can create a single instance of the UDF in your master database and add synonyms for it in each user database. YAddress UDF is a table-valued function. For every call, it returns one row of data with columns corresponding to various fields of the processed postal address. To install YAddress SQL Client, download YAddress SQL Client DLL and the setup script. Start SQL Server Management Studio and open the setup script. Follow the steps in the script. Note that you will need to change the name of your database and location of the DLL on disk within the script. Page 3

4 Programming Reference YAddress SQL Client UDF After running the installation script, a single User Defined Function (UDF) named dbo.processaddress is created. Syntax dbo.processaddress(addressline1, AddressLine2) Arguments Return Value AddressLine1 The first line of subject postal address containing the street address, such as 123 Main St Apt 45. AddressLine1 can be blank. AddressLine2 Second line of the address, containing city, state and Zip code, such as San Diego, CA At the very minimum, either city-state or Zip code must be specified. The function returns a table of data consisting of a single row. The table includes the following columns. AddressLine1 Type varchar. First line of the parsed address. Includes secondary address designator if supplied in the original address. If the address failed to validate, this line is a copy of the input line. AddressLine2 Type varchar. City-state-ZIP line of the parsed address. If the address failed to validate, this line is a copy of the input line. CensusBlock Type varchar. Census block number in four digits. Blank if not determined. Census block numbers are unique within a census tract. CensusTract Page 4

5 Type varchar. Census tract number in the format XXXX.XX. Blank if not determined. Census tract numbers are unique within a county. City Type varchar. City of the parsed address. Blank if city was not validated. County Type varchar. County of the parsed address. Blank if county was not validated. CountyFP Type varchar. County FP number in three digits. Blank if county was not validated. County FP numbers are unique within a state. ErrorCode Type int. Error code according to the table below: Code Meaning 0 No error. 1 System error. See returned Error Message for more details. 2 Input address was supplied in an invalid format. 3 Specified street was not found in the ZIP code provided or in any ZIP code of the city-state. 4 City is not found in the state. 5 Ambiguous street name. More than one street matches the search address with equal accuracy. 6 YAddress installation is corrupted. Reinstall the application. 7 YAddress data edition has expired. Contact Yuri Software to obtain current edition. 8 No such house number in the street. ErrorMessage Type varchar. Textual error message. Blank if error code is 0. GeoPrecision Type int. Precision with which coordinates of the location were determined. Possible values are: Value Meaning 0 Location could not be determined. 1 Center point of the state. 2 City center. Usually points to the downtown city district. 3 Center point of the ZIP code. 4 Nearest end of the nearest street block. For example, if input address is "105 Main St", and Main St only has Page 5

6 addresses up to 100, the coordinates of "100 Main St" are returned. 5 Location of the exact address. Latitude Type float. Latitude of the address location. 0 if address cannot be geocoded. Longitude Type float. Longitude of the address location. 0 if address cannot be geocoded. Number Type varchar. House number of the parsed address. Blank if street address was not validated. PostDir Type varchar. Street post-direction of the parsed address. Blank if street address was not validated. PreDir Type varchar. Street pre-direction of the parsed address. Blank if street address was not validated. Sec Type varchar. Secondary designator of the parsed address, such as apartment, suite, unit, etc. Blank if secondary designator was not validated. SecNumber Type varchar. Secondary number of the parsed address, such as apartment, suite, unit, etc. Blank if secondary number was not validated. State Type varchar. State of the parsed address. Blank if address was not validated. StateFP Type varchar. State FP number in two digits. Blank if state was not validated. Street Type varchar. Street name of the parsed address, not including pre-direction, postdirection, and suffix. Blank if street address was not validated. Suffix Type varchar. Street suffix of the parsed address. Blank if street address was not validated. Zip Type varchar. ZIP code of the parsed address. Blank if address was not validated. Page 6

7 Zip4 Type varchar. ZIP+4 code of the parsed address. Blank if address was not validated. Page 7

8 Sample Code Query: SELECT * FROM ProcessAddress('506 Fourth Avenue Unit 1', 'Asbury Prk, NJ') Response: ErrorCode 0 ErrorMessage AddressLine TH AVE APT 1 AddressLine2 ASBURY PARK, NJ Number 506 PreDir Street 4TH Suffix AVE PostDir Sec APT SecNumber 1 City ASBURY PARK State NJ Zip 7712 Zip County MONMOUTH CountyFP 25 CensusTract 1015 CensusBlock Latitude Longitude GeocodePrecision 5 Page 8

Household Information (Portal)

Household Information (Portal) Updating Household Information Updating Household Phone Number Updating Household Address PATH: Campus Portal > Family This tab lists the household phone number and all current