WsPostalinputRecord

extends WsDsRecord

Required Fields:

customerpk

firmorrecipientinput

• Nillable: true

• Type: string

• Description: The name of the company, building, apt. complex, shopping center, or other entity.

firmorrecipientinputmsg

• Nillable: true

• Type: string

• Description:

deliveryaddressline1Input

• Nillable: true

• Type: string

• Description: The first line of address information, such as 123 Main Street.

deliveryaddressline2Input

• Nillable: true

• Type: string

• Description: The second line of address information. Line 2 can contain secondary information such as Suite 123 or a private mailbox number (PMB123).

lastlineinput

• Nillable: true

• Type: string

• Description: The last line of address information, including city name, state, and ZIP4.

foreignid

• Nillable: true

• Type: string

• Description: This must be unique within the record's address list. This is the id which a client application sets and stores to identify with a specific record. If this is left null, DuoShare will assign a value.

originalfirmname

• Nillable: true

• Type: string

• Description:

originallastline

• Nillable: true

• Type: string

• Description:

originaldeliveryline

• Nillable: true

• Type: string

• Description:

addressmsg

• Nillable: true

• Type: string

• Description:

deliveryaddressline1Inputmsg

• Nillable: true

• Type: string

• Description:

originaldeliveryline2

• Nillable: true

• Type: string

• Description:

urbanizationinput

• Nillable: true

• Type: string

• Description: The name of an urban development in Puerto Rico.

listpk

• Nillable: true

• Type: long

• Description: This is required when the user wants an interactive validation to insert or update this record in the associated list. listpk identifies the list to insert/update the address in.

addressinputparsedyn

• Nillable: true

• Type: boolean

• Description: Identifies if the address input data is parsed. True for yes, False for no.

addressinputparsedynmsg

• Nillable: true

• Type: string

• Description:

addressprimarynumberinput

• Nillable: true

• Type: string

• Description: The numeric or alphanumeric component preceding the street name.

addressprimarynumberinputmsg

• Nillable: true

• Type: string

• Description:

addresssecondaryabbrinput

• Nillable: true

• Type: string

• Description: The abbreviation for the address secondary range.

addresssecondaryabbrinputmsg

• Nillable: true

• Type: string

• Description:

addresssecondarynumberinput

• Nillable: true

• Type: string

• Description: The numeric or alphanumeric number of the secondary address.

addresssecondarynumberinputmsg

• Nillable: true

• Type: string

• Description:

citynameinput

• Nillable: true

• Type: string

• Description: The city name in the last line of address information.

citynameinputmsg

• Nillable: true

• Type: string

• Description:

departmentinput

• Nillable: true

• Type: string

• Description: The group, department, or division name associated with the individual.

departmentinputmsg

• Nillable: true

• Type: string

• Description:

firstnameinput

• Nillable: true

• Type: string

• Description: The first name of the individual.

firstnameinputmsg

• Nillable: true

• Type: string

• Description:

functionaltitleinput

• Nillable: true

• Type: string

• Description: The job function title of the individual, such as Engineering Manager.

functionaltitleinputmsg

• Nillable: true

• Type: string

• Description:

lastlineinputparsedyn

• Nillable: true

• Type: boolean

• Description: Set to true if the lastline is provided parsed.

lastlineinputparsedynmsg

• Nillable: true

• Type: string

• Description:

lastnameinput

• Nillable: true

• Type: string

• Description: The last name of the individual.

lastnameinputmsg

• Nillable: true

• Type: string

• Description:

mailstopcodeinput

• Nillable: true

• Type: string

• Description: The internal mail designation code, such as a unique identifier assigned by a company or building.

mailstopcodeinputmsg

• Nillable: true

• Type: string

• Description:

middlenameinput

• Nillable: true

• Type: string

• Description: The middle name or initial of the individual.

middlenameinputmsg

• Nillable: true

• Type: string

• Description:

nameinputparsedyn

• Nillable: true

• Type: boolean

• Description: Set to true if the name associated with this record is parsed in the firstname, middlename, and lastname fields.

nameinputparsedynmsg

• Nillable: true

• Type: string

• Description:

prefixtitleinput

• Nillable: true

• Type: string

• Description: The prefix preceding the individual's name, such as Mr., Ms., Dr., etc.

prefixtitleinputmsg

• Nillable: true

• Type: string

• Description:

professionaltitleinput

• Nillable: true

• Type: string

• Description: The professional title of the individual, such asCertified Programmer.

professionaltitleinputmsg

• Nillable: true

• Type: string

• Description:

statecodeinput

• Nillable: true

• Type: string

• Description: The 2-digit abbreviation for the state in the last line of address information.

statecodeinputmsg

• Nillable: true

• Type: string

• Description:

streetnameinput

• Nillable: true

• Type: string

• Description: The street name in the delivery address.

streetnameinputmsg

• Nillable: true

• Type: string

• Description:

streetpostdirectionalabbrinput

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation following the street name.

streetpostdirectionalabbrinputmsg

• Nillable: true

• Type: string

• Description:

streetpredirectionalabbrinput

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation preceding the street name.

streetpredirectionalabbrinputmsg

• Nillable: true

• Type: string

• Description:

streetsuffixabbrinput

• Nillable: true

• Type: string

• Description: The street trailing designator abbreviation.

streetsuffixabbrinputmsg

• Nillable: true

• Type: string

• Description:

suffixtitleinput

• Nillable: true

• Type: string

• Description: The suffix following the last name of the individual, such as Jr. or PhD.

suffixtitleinputmsg

• Nillable: true

• Type: string

• Description: The suffix following the last name of the individual, such as Jr. or PhD.

unparsednameinput

• Nillable: true

• Type: string

• Description: The name goes here when it is not already parsed as first, middle, last. Ex. “John Doe” as one string.

unparsednameinputmsg

• Nillable: true

• Type: string

• Description:

zip4Addoninput

• Nillable: true

• Type: string

• Description: The 4-digit ZIP Add-On Code in the last line of address information.

zip4Addoninputmsg

• Nillable: true

• Type: string

• Description: The 4-digit ZIP Add-On Code in the last line of address information.

zipcodeinput

• Nillable: true

• Type: string

• Description: The 5-digit ZIP in the last line of address information.

zipcodeinputmsg

• Nillable: true

• Type: string

• Description:

deliveryaddressline2Inputmsg

• Nillable: true

• Type: string

• Description:

customerpk required

• Nillable: true

• Type: long

• Description: This is the customerpk provided to the user by DuoShare. When you login to DuoShare you may have access to multiple customers, this should be set to the pk of the customer you want this record to associate with. (most users will only have one customerpk. If you have more customers registered with us and need to dynamically see which customers you have access to see our UserEF and CustaccessEF services)

listdetailpk

• Nillable: true

• Type: long

• Description: This is the primary key to the listdetail record and is the most specific key associated with this record. You can store and send this back with a record in place of foreignid, but you cannot invent a new one as with foreign id, you can only use the listdetailpk given to you as a response a validation of this record.

actioncode

• Nillable: true

• Type: string

• Description:

mode

• Nillable: true

• Type: string

• Description: If you are doing an interactive call you should set this to “Interactive” to get all of the hint data back.

originatingcallbackurl

• Nillable: true

• Type: string

• Description:

processicamefrom

• Nillable: true

• Type: string

• Description:

WsDsRecord

locale

• Nillable: true

• Type: string

• Description: The two letter abbreviation for the user's locale. Default is 'en' for English.

errorlevel

• Nillable: true

• Type: int

• Description: 0 no error, greater than 0 means an error occured.

active

• Nillable: true

• Type: boolean

• Description: Indicates a record available for use. A checkmark or True=Active. A blank field or False=Inactive/Not available for use.

activemsg

• Nillable: true

• Type: string

• Description:

createuserpk

• Nillable: true

• Type: long

• Description: Primary key of the user which created this record.

createuserpkmsg

• Nillable: true

• Type: string

• Description:

error

• Nillable: false

• Type: boolean

• Description: True if an error occurred processing this record. This should always be checked before using the record for local processing.

errormsg

• Nillable: true

• Type: string

• Description: When error is true, this field contains details regarding the error.

modifyuserpk

• Nillable: true

• Type: long

• Description: The primary key of the last user to modify this record.

modifyuserpkmsg

• Nillable: true

• Type: string

• Description:

WsPostaloutputRecord

extends WsPostalinputRecord

allerrormessages

• Nillable: true

• Type: string

• Description: All of the error messages resulting from validation

addressprimarynumberanswer

• Nillable: true

• Type: string

• Description: The numeric or alphanumeric component that precedes the street name in an address returned by address matching.

addressprimarynumberanswermsg

• Nillable: true

• Type: string

• Description:

addressprimarynumbercoaanswer

• Nillable: true

• Type: string

• Description: The numeric or alphanumeric component that precedes the street name returned using COA.

addressprimarynumbercoaanswermsg

• Nillable: true

• Type: string

• Description:

addressprimaryoddevencode

• Nillable: true

• Type: string

• Description: Identifies the side/sides of a street for which a given address range is applicable. For street, highrise, firm and multi-carrier records: B = Both sides of a street, E = Even side of a street (even-numbered addresses in the range); O = Odd side of a street (odd-numbered addresses in the range).

addresssecondaryabbranswer

• Nillable: true

• Type: string

• Description: The abbreviation that identifies the type of address secondary range. It may indicate apartment, suite, trailer, etc.

addresssecondaryabbranswermsg

• Nillable: true

• Type: string

• Description:

addresssecondaryabbrcoaanswer

• Nillable: true

• Type: string

• Description: The abbreviation returned by COA that identifies the type of address secondary range.

addresssecondaryabbrcoaanswermsg

• Nillable: true

• Type: string

• Description:

addresssecondarynumberanswer

• Nillable: true

• Type: string

• Description: The numeric or alphanumeric number of a secondary address following the street name, such as an apartment number, as returned by address matching.

addresssecondarynumberanswermsg

• Nillable: true

• Type: string

• Description:

addresssecondarynumcoaanswer

• Nillable: true

• Type: string

• Description: The numeric or alphanumeric number of a secondary address following the street name returned by COA matching.

addresssecondarynumcoaanswermsg

• Nillable: true

• Type: string

• Description:

addresssecondaryoddevencode

• Nillable: true

• Type: string

• Description: Identifies a secondary address within a range of secondary addresses as being odd (0), even (E), or both (B).

alphanumericprimarynum

• Nillable: false

• Type: boolean

• Description:

alphanumericsecondarynum

• Nillable: false

• Type: boolean

• Description:

approvedabbrsecunit

• Nillable: true

• Type: string

• Description: The approved abbreviation for the alphabetic component of the secondary level of an address, such as APT=Apartment, BSMT=Basement, BLDG=Building, DEPT=Department, FL=Floor.

basealtcode

• Nillable: true

• Type: string

• Description:

box

• Nillable: true

• Type: string

• Description:

buildingtype

• Nillable: true

• Type: string

• Description: The kind of government agency at a delivery address and/or whether a firm is the only delivery at an address, such as "City government building" or "Firm only."

carrierroutecoaanswer

• Nillable: true

• Type: string

• Description: The carrier route for the address returned by COA matching.

carrierroutecoaanswermsg

• Nillable: true

• Type: string

• Description:

carrierrouteidanswer

• Nillable: true

• Type: string

• Description: The 4-character code for a carrier's mail delivery route within a 5-digit ZIP The first character is alphabetical and the remaining 3 characters are numeric.

carrierrouteidanswermsg

• Nillable: true

• Type: string

• Description:

citymailingname

• Nillable: true

• Type: string

• Description: The city name returned by address matching.

citynameanswer

• Nillable: true

• Type: string

• Description: The city name returned by address matching.

citynameanswermsg

• Nillable: true

• Type: string

• Description:

citynamecoaanswer

• Nillable: true

• Type: string

• Description: The city for the address returned by COA matching.

citynamecoaanswermsg

• Nillable: true

• Type: string

• Description:

citystatemailingnameind

• Nillable: false

• Type: boolean

• Description: Indicates whether an alternate mailing name is also approved for use.

coafootnote

• Nillable: true

• Type: string

• Description: The footnote explaining the Match/No Match result returned by COA matching.

coafootnotemsg

• Nillable: true

• Type: string

• Description:

coamatchrejected

• Nillable: true

• Type: boolean

• Description: The total number of COA matches rejected based on Move Effective Date.

coamatchrejectedmsg

• Nillable: true

• Type: string

• Description:

congressionaldistrictnum

• Nillable: true

• Type: string

• Description: The code identifying a geographic area within the United States served by a member of the US House of Representatives.

congressionaldistrictnummsg

• Nillable: true

• Type: string

• Description:

countyname

• Nillable: true

• Type: string

• Description: The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state.

countynamemsg

• Nillable: true

• Type: string

• Description:

countynum

• Nillable: true

• Type: string

• Description: The Federal Information Processing Standard (FIPS) code returned by address matching that is assigned to a given county or parish within a state.

cridFlag

• Nillable: false

• Type: boolean

• Description:

decimalof17Resultvalue

• Nillable: true

• Type: string

• Description:

decimalof17Resultvaluemsg

• Nillable: true

• Type: string

• Description:

defaultflagind

• Nillable: true

• Type: string

• Description: The indicator specifying whether one or more default records were found during address matching.

deliveryaddressline1Answer

• Nillable: true

• Type: string

• Description: The first line of the delivery address returned by address matching.

deliveryaddressline1Answermsg

• Nillable: true

• Type: string

• Description:

deliveryaddressline2Answer

• Nillable: true

• Type: string

• Description: The second line of the delivery address returned by address matching.

deliveryaddressline2Answermsg

• Nillable: true

• Type: string

• Description:

deliveryline1Shortanswer

• Nillable: true

• Type: string

• Description: The abbreviated form of the street name in the delivery address for labels and mailing lists which cannot accommodate the standard 64 character length allotted for Delivery Address Line 1.

deliveryline2Shortanswer

• Nillable: true

• Type: string

• Description: The second address line returned by address matching.

deliverypointcheckdigitanswer

• Nillable: true

• Type: string

• Description: The one-digit hash number calculated by address matching that is added to the 10-digit delivery point to assist bar code reader hardware in determining the accuracy of a scan.

departmentanswer

• Nillable: true

• Type: string

• Description:

dpbccoaanswer

• Nillable: true

• Type: string

• Description: The delivery point barcode associated with the new address returned by COA matching.

dpbccoaanswermsg

• Nillable: true

• Type: string

• Description:

dpcanswer

• Nillable: true

• Type: string

• Description: The delivery point barcode for the validated address. Required for automation rates.

dpcanswermsg

• Nillable: true

• Type: string

• Description:

dpcFlag

• Nillable: false

• Type: boolean

• Description:

dpvcmraind

• Nillable: true

• Type: string

• Description: The indicator specifying if the input address was found in the Commercial Mail Receiving (CMRA) table.

dpvconfirmind

• Nillable: true

• Type: string

• Description: The indicator specifying the deliverability of validated addresses based on the primary and/or secondary numbers in the addresses. Users interested in determining the potential deliverability of each address will want to select the DPV Confirmation field for export.

dpvfalsepositiveind

• Nillable: true

• Type: string

• Description: The indicator specifying if an address was found in the false positive table. False positive flagging prevents the creation of a mail list using Delivery Point Validation to confirm the existence of real addresses by searching every possible address in a range of addresses.

dpvfootnote1

• Nillable: true

• Type: string

• Description: The footnote indicator used to return flag values in accordance with delivery sequence file license requirements.

dpvfootnote2

• Nillable: true

• Type: string

• Description: The footnote indicator used to return flag values in accordance with delivery sequence file license requirements.

dpvfootnote3

• Nillable: true

• Type: string

• Description: The footnote indicator used to return flag values in accordance with delivery sequence file license requirements.

dpvmsg

• Nillable: true

• Type: string

• Description:

dropflagind

• Nillable: true

• Type: string

• Description: The indicator that specifies if a ZIP4 and individual name were matched by dropping the secondary number to make the match using COA.

dropflagindmsg

• Nillable: true

• Type: string

• Description:

dropnflagind

• Nillable: true

• Type: string

• Description: The indicator that specifies if a complete middle name and individual name match was made in COA by truncating the first name to an initial.

dropnflagindmsg

• Nillable: true

• Type: string

• Description:

elotascdesanswer

• Nillable: true

• Type: string

• Description: The indicator that is returned by address matching to specify the order in which delivery points are delivered within the carrier route delivery sequence.

elotsequencenumberanswer

• Nillable: true

• Type: string

• Description:

ewsflag

• Nillable: true

• Type: string

• Description: Indicates if a match has been made to the Early Warning System.

financenum

• Nillable: true

• Type: string

• Description: The code returned by address matching that is assigned to postal facilities to collect cost and statistical data and compile revenue and expense data.

firmorrecipientanswer

• Nillable: true

• Type: string

• Description:

firmorrecipientanswermsg

• Nillable: true

• Type: string

• Description:

firstnameanswer

• Nillable: true

• Type: string

• Description: The first name returned when a match was made using COA.

firstnameanswermsg

• Nillable: true

• Type: string

• Description:

firstnameof48Object

• Nillable: true

• Type: string

• Description:

firstnameof48Objectmsg

• Nillable: true

• Type: string

• Description:

foreigncountrynameanswer

• Nillable: true

• Type: string

• Description:

foreigncountrynameanswermsg

• Nillable: true

• Type: string

• Description:

foreignpostalcodeanswer

• Nillable: true

• Type: string

• Description:

foreignpostalcodeanswermsg

• Nillable: true

• Type: string

• Description:

functionaltitleanswer

• Nillable: true

• Type: string

• Description:

gendercoaanswer

• Nillable: true

• Type: string

• Description:

gendercoaanswermsg

• Nillable: true

• Type: string

• Description:

hexemdp

• Nillable: true

• Type: string

• Description:

hexemdpmsg

• Nillable: true

• Type: string

• Description:

hexofdataretrieved

• Nillable: true

• Type: string

• Description:

hexofdataretrievedmsg

• Nillable: true

• Type: string

• Description:

hexoffirst8Of48Object

• Nillable: true

• Type: string

• Description:

hexoffirst8Of48Objectmsg

• Nillable: true

• Type: string

• Description:

hexshaemdp

• Nillable: true

• Type: string

• Description:

hexshaemdpmsg

• Nillable: true

• Type: string

• Description:

hexshaof48Object

• Nillable: true

• Type: string

• Description:

hexshaof48Objectmsg

• Nillable: true

• Type: string

• Description:

highrisedefaultalternate

• Nillable: false

• Type: boolean

• Description: The highrise record returned as the default when an input address for a highrise matches the primary address information to a highrise (type H) record in the ZIP4 data, but the secondary designator or range input does not match the secondary values in the ZIP4 match. This indicator specifies if the alternate record is approved for use.

highrisedefaultFlag

• Nillable: false

• Type: boolean

• Description: The highrise record returned as the default when an input address for a highrise matches the primary address information to a highrise (type H) record in the ZIP4 data, but the secondary designator or range input does not match the secondary values in the ZIP4 match.

highriseFlag

• Nillable: false

• Type: boolean

• Description:

hintcoaanswer

• Nillable: true

• Type: string

• Description:

hintcoaanswermsg

• Nillable: true

• Type: string

• Description:

lacsfalsepositiveind

• Nillable: false

• Type: boolean

• Description:

lacsFlag

• Nillable: false

• Type: boolean

• Description:

lacslinkind

• Nillable: true

• Type: string

• Description: The indicator specifying if the input address has been found using the Locatable Address Conversion System and may have been converted from a rural route to a city-style address.

lacslinkreturncode

• Nillable: true

• Type: string

• Description: The code which indicates the result of the attempt to match the address against Locatable Address Conversion data to determine the new address.

lacsstatus

• Nillable: true

• Type: string

• Description: Describes address records that have been converted by the Locatable Address Conversion System.

lastlineanswer

• Nillable: true

• Type: string

• Description: The last line of the address, such as the city, state and ZIP.

lastlineanswermsg

• Nillable: true

• Type: string

• Description:

lastnameanswer

• Nillable: true

• Type: string

• Description: The last name returned when a match was made using COA.

lastnameanswermsg

• Nillable: true

• Type: string

• Description:

lastnameof48Object

• Nillable: true

• Type: string

• Description:

lastnameof48Objectmsg

• Nillable: true

• Type: string

• Description:

mailstopcodeanswer

• Nillable: true

• Type: string

• Description: The internal mail designation code, such as a unique identifier assigned by a company or building.

middlenameanswer

• Nillable: true

• Type: string

• Description:

middlenameanswermsg

• Nillable: true

• Type: string

• Description:

middlenamecoaanswer

• Nillable: true

• Type: string

• Description: The middle name or initial returned when a match was made using COA.

middlenamecoaanswermsg

• Nillable: true

• Type: string

• Description:

moveeffectivedatecoaanswer

• Nillable: true

• Type: string

• Description: The date the change of address became effective.

moveeffectivedatecoaanswermsg

• Nillable: true

• Type: string

• Description:

movetypeind

• Nillable: true

• Type: string

• Description: The type of move for the address found using COA, such as F (Family), I (Individual), or B (Business).

movetypeindmsg

• Nillable: true

• Type: string

• Description:

nondeliverable

• Nillable: false

• Type: boolean

• Description: Indicates that an address is a match to a ZIP+4 record, when the match is made against a non-deliverable type record.

pmbanswer

• Nillable: true

• Type: string

• Description:

pmbdesignatoranswer

• Nillable: true

• Type: string

• Description: The private mailbox designator returned by address matching.

pmbnumberanswer

• Nillable: true

• Type: string

• Description: The private mailbox number returned by address matching.

poboxlowaddon

• Nillable: false

• Type: boolean

• Description:

preferredlastlinecitystateid

• Nillable: true

• Type: string

• Description: The unique identifier for the default favored last line of a mailing address for a given ZIP.

prefixtitleanswer

• Nillable: true

• Type: string

• Description: The title preceding an individual's name, such as Mr. or Dr. The field will be blank if no match was made using COA.

prefixtitleanswermsg

• Nillable: true

• Type: string

• Description:

professionaltitleanswer

• Nillable: true

• Type: string

• Description:

rdi

• Nillable: true

• Type: string

• Description:

recordtype

• Nillable: true

• Type: string

• Description: The code specifying the type of address identified during address matching.

ruralroutedefaultFlag

• Nillable: ruralroutedefaultFlag

• Type: boolean

• Description: The indicator specifying if the rural route address matches the primary address for a rural route ZIP4 record, but does not match the primary number range.

ruralrouteFlag

• Nillable: ruralrouteFlag

• Type: boolean

• Description: The indicator specifying if a rural route address is an exact match to a rural route ZIP4 record.

secondaryabbr1

• Nillable: true

• Type: string

• Description: The first secondary address abbreviation returned in address matching.

secondaryabbr2

• Nillable: true

• Type: string

• Description: An alternate secondary address abbreviation returned in address matching.

secondarynumber1

• Nillable: true

• Type: string

• Description: The first numeric or alphanumeric secondary address component returned in address matching.

secondarynumber2

• Nillable: true

• Type: string

• Description: An alternate numeric or alphanumeric secondary address component returned in address matching.

standardsecunit

• Nillable: true

• Type: string

• Description: The approved abbreviation for the alphabetic component of the secondary level of an address, such as APT=Apartment, BSMT=Basement, BLDG=Building, DEPT=Department, FL=Floor.

statecodeanswer

• Nillable: true

• Type: string

• Description: The state code returned in address matching.

statecodeanswermsg

• Nillable: true

• Type: string

• Description:

statecodecoaanswer

• Nillable: true

• Type: string

• Description: The state abbreviation for the new address returned by COA matching.

statecodecoaanswermsg

• Nillable: true

• Type: string

• Description:

streetnameabbr

• Nillable: true

• Type: string

• Description: The abbreviated form of the street name returned in address matching.

streetnameanswer

• Nillable: true

• Type: string

• Description: The street name returned in address matching.

streetnameanswermsg

• Nillable: true

• Type: string

• Description:

streetnamecoaanswer

• Nillable: true

• Type: string

• Description: The name of the street for the address returned by COA matching.

streetnamecoaanswermsg

• Nillable: true

• Type: string

• Description:

streetpostdirectionalabbranswer

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation that follows a street name, such as N = North, E = East, NE = Northeast, NW = Northwest, S = South, SE = Southeast, SW = Southwest, W = West, returned in address matching.

streetpostdirectionalabbranswermsg

• Nillable: true

• Type: string

• Description:

streetpostdirectionalcoaanswer

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation that follows the street name returned by COA matching.

streetpostdirectionalcoaanswermsg

• Nillable: true

• Type: string

• Description:

streetpredirectionalabbranswer

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation that precedes a street name, such as N = North, E = East, NE = Northeast, NW = Northwest, S = South, SE = Southeast, SW = Southwest, W = West, returned by address matching.

streetpredirectionalabbranswermsg

• Nillable: true

• Type: string

• Description:

streetpredirectionalcoaanswer

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation that precedes the street name returned by COA matching.

streetpredirectionalcoaanswermsg

• Nillable: true

• Type: string

• Description:

streetspellingvariation

• Nillable: false

• Type: boolean

• Description:

streetsuffix

• Nillable: true

• Type: string

• Description:

streetsuffixabbranswer

• Nillable: true

• Type: string

• Description: The standard abbreviation for the trailing designator in the street address, such as DR (Drive) or ST (Street).

streetsuffixabbranswermsg

• Nillable: true

• Type: string

• Description:

streetsuffixabbrcoaanswer

• Nillable: true

• Type: string

• Description: The standard abbreviation for the trailing designator in the street address returned by COA matching.

streetsuffixabbrcoaanswermsg

• Nillable: true

• Type: string

• Description:

streetsuffixprimaryname

• Nillable: true

• Type: string

• Description: The street name designator returned in address matching, such as Drive or Street.

suffixnameof48Object

• Nillable: true

• Type: string

• Description:

suffixnameof48Objectmsg

• Nillable: true

• Type: string

• Description:

suffixtitleanswer

• Nillable: true

• Type: string

• Description: The suffix that follows an individual's name, such as Jr. or Ph.D.

suffixtitleanswermsg

• Nillable: true

• Type: string

• Description:

totalnumcoaqueries

• Nillable: true

• Type: int

• Description:

totalnumcoaqueriesmsg

• Nillable: true

• Type: string

• Description:

uniquezip

• Nillable: uniquezip

• Type: boolean

• Description: Indicator that specifies whether the city/state record contains the organization name for a unique ZIP Code.

unparsednameanswer

• Nillable: true

• Type: string

• Description:

urbanizationanswer

• Nillable: true

• Type: string

• Description: The Puerto Rican urbanization name returned by address matching.

urbanizationcoaanswer

• Nillable: true

• Type: string

• Description: The Puerto Rican urbanization name returned using COA.

urbanizationcoaanswermsg

• Nillable: true

• Type: string

• Description:

zip4Addoncoaanswer

• Nillable: true

• Type: string

• Description: The new ZIP+4 add-on returned by COA matching.

zip4Addoncoaanswermsg

• Nillable: true

• Type: string

• Description:

zipclasstype

• Nillable: true

• Type: string

• Description: The kind of ZIP area that a 5-digit ZIP Code serves, such as a single educational institution, post office boxes only, or a single address that has unusually high mail volume or many different addresses. Codes include: M=Military ZIP; P=ZIP only post office boxes; U=Unique ZIP assigned to a single organization; Blank=Standard ZIP with many addresses.

zipcodeanswer

• Nillable: true

• Type: string

• Description: The 5-digit ZIP returned by address matching.

zipcodeanswermsg

• Nillable: true

• Type: string

• Description:

zipcodecoaanswer

• Nillable: true

• Type: string

• Description: The new 5-digit ZIP returned by COA matching.

zipcodecoaanswermsg

• Nillable: true

• Type: string

• Description:

zipcodeFlag

• Nillable: false

• Type: boolean

• Description:

zipplus4Answer

• Nillable: true

• Type: string

• Description: The 5-digit ZIP with 4-digit Add-On Code returned by address matching.

zipplus4Flag

• Nillable: false

• Type: boolean

• Description:

zipsector

• Nillable: true

• Type: string

• Description: The first two digits of the ZIP Add-On Code representing the geographic portion of a ZIP area as returned by address matching.

zipsectorhighnum

• Nillable: true

• Type: string

• Description: The high-end of the number range that forms the first two digits of the ZIP Add-On Code (the sixth and seventh digits of a ZIP4).

zipsectorlownum

• Nillable: true

• Type: string

• Description: The low-end of the number range that forms the first two digits of the ZIP Add-On Code (the sixth and seventh digits of a ZIP4).

zipsectormsg

• Nillable: true

• Type: string

• Description:

zipsegment

• Nillable: true

• Type: string

• Description: The last two digits of the ZIP Add-On Code representing the specific block face, building floor, etc. as returned by address matching.

zipsegmenthighnum

• Nillable: true

• Type: string

• Description: The high-end of the number range that forms the last two digits of the ZIP Add-On Code (the eighth and ninth digits of a ZIP4).

zipsegmentlownum

• Nillable: true

• Type: string

• Description: The low-end of the number range that forms the last two digits of the ZIP Add-On Code (the eighth and ninth digits of a ZIP4).

zipsegmentmsg

• Nillable: true

• Type: string

• Description:

zip4Records

• Nillable: true

• Type: ArrayOf_tns2_nillable_WsZip4Record

• Description: The total number of records assigned a ZIP Add-On.

cityStateRecords

• Nillable: true

• Type: ArrayOf_tns2_nillable_WsCitystateRecord

• Description:

stateRecords

• Nillable: true

• Type: ArrayOf_tns2_nillable_WsStateRecord

• Description:

stateCityRecords

• Nillable: true

• Type: ArrayOf_tns2_nillable_WsStatecityRecord

• Description:

stateCityStreetRecords

• Nillable: true

• Type: ArrayOf_tns2_nillable_WsStatecitystreetRecord

• Description:

WsZip4Record

actioncode

• Nillable: true

• Type: string

• Description: The indicator for the action to be taken in updating the base master files, either A (add record to file) or D (delete base master record).

active

• Nillable: true

• Type: boolean

• Description: Indicates the record is available for use.

addressprimaryhighnum

• Nillable: true

• Type: string

• Description: The high-end of the range of valid primary numeric or alphanumeric number of an address that precedes the street name.

addressprimarylownum

• Nillable: true

• Type: string

• Description: The low-end of the range of valid primary numeric or alphanumeric number of an address that precedes the street name.

addressprimaryoddevencode

• Nillable: true

• Type: string

• Description: The code returned by address matching to identify the side⁄sides of a street for which a given address range is applicable.

addresssecondaryabbr

• Nillable: true

• Type: string

• Description: The abbreviation returned by address matching that identifies the type of address secondary range.

addresssecondaryhighnum

• Nillable: true

• Type: string

• Description: The high-end of the range of valid secondary numeric or alphanumeric number that follows the street address.

addresssecondarylownum

• Nillable: true

• Type: string

• Description: The low-end of the range of valid secondary numeric or alphanumeric number that follows the street address.

addresssecondaryoddevencode

• Nillable: true

• Type: string

• Description: The code returned by address matching to identify a secondary address within a range of secondary addresses as being odd, even, or both.

basealtcode

• Nillable: true

• Type: string

• Description: Specifies whether the record is a base (preferred) or alternate record.

buildingorfirmname

• Nillable: true

• Type: string

• Description: The name of the company, building, apartment complex, shopping center, or other distinguishing place.

carrierrouteid

• Nillable: true

• Type: string

• Description: The 4-character code assigned to the mail delivery route within a 5-digit ZIP.

congressionaldistrictnum

• Nillable: true

• Type: string

• Description: The code returned by address matching to identify a geographic area within the United States served by a member of the U.S. House of Representatives.

countynum

• Nillable: true

• Type: string

• Description: The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state.

created

• Nillable: true

• Type: dateTime

• Description: The date the record was created.

createuserpk

• Nillable: true

• Type: long

• Description: The unique identifier for the user who created the record.

createuserpkdesc

• Nillable: true

• Type: string

• Description: The name of the user who created the record.

financenum

• Nillable: true

• Type: string

• Description: The code returned by address matching that is assigned to postal service facilities to collect cost and statistical data and compile revenue and expense data.

firmhash

• Nillable: true

• Type: string

• Description:

fullhash

• Nillable: true

• Type: long

• Description:

govbldgtypeid

• Nillable: true

• Type: string

• Description: The alphabetic identifier for the government building type record.

lacsstatus

• Nillable: true

• Type: string

• Description:

modified

• Nillable: true

• Type: dateTime

• Description: The date and time that the record was last modified.

modifyuserpk

• Nillable: true

• Type: long

• Description: The unique identifier for the user who made the last update to the address record.

modifyuserpkdesc

• Nillable: true

• Type: string

• Description: The name of the user who made the last update to the address record.

municipalitycitystateid

• Nillable: true

• Type: string

• Description:

preferredlastlinecitystateid

• Nillable: true

• Type: string

• Description: The unique identifier for the default favored last line of a mailing address for a given ZIP.

recordtypeid

• Nillable: true

• Type: string

• Description: The code which identifies the kind of data in the record. Codes include: G (General delivery); H (Highrise); F (Firm); S (Street); P (PO box); R (Rural route/highway contract); M (Multi-carrier).

stateabbr

• Nillable: true

• Type: string

• Description: The 2-character abbreviation for the valid state name, U.S. territory, or armed forces ZIP Code designation.

streetname

• Nillable: true

• Type: string

• Description: The identifying title of the street.

streetnamehash

• Nillable: true

• Type: string

• Description: The variation of the street name that is designed to compensate for mispellings made when entering a street name.

streetpostdirectionalabbr

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation that follows a street name.

streetpredirectionalabbr

• Nillable: true

• Type: string

• Description: The geographic direction abbreviation that precedes a street name.

streetsuffixabbr

• Nillable: true

• Type: string

• Description: The standard abbreviation for the trailing designator in the street address, such as DR (Drive) or ST (Street).

urbanizationcitystateid

• Nillable: true

• Type: string

• Description: The field that is an index to the urbanization name which denotes an area in Puerto Rico and precedes the name of the area in addresses.

zip4Highnum

• Nillable: true

• Type: string

• Description: The high-end of the range for the ZIP Add-On Code representing the geographic sector and segment for the carrier route delivery sequence.

zip4Id

• Nillable: true

• Type: string

• Description: The unique identifier for the ZIP4 record.

zip4Lownum

• Nillable: true

• Type: string

• Description: The low-end of the range for the ZIP Add-On Code representing the geographic sector and segment for the carrier route delivery sequence.

zipcode

• Nillable: true

• Type: string

• Description: The 5-digit code that identifies a specific geographic delivery area.

zipsectorhighnum

• Nillable: true

• Type: string

• Description: The high-end of the number range that forms the first two digits of the ZIP Add-On Code.

zipsectorlownum

• Nillable: true

• Type: string

• Description: The low-end of the number range that forms the first two digits of the ZIP Add-On Code.