preamble

On this page we, (Paul, Val, Sam) discuss the how the address lookup service should work.

The latest accepted revision is here.
The latest proposed revision is here.

To look up addresses (DEV):

Here are all possible parameters:

streetName
streetNameSuffix (optional)
baseNumber
baseNumberSuffix (optional)
unitNumber (optional)
unitNumberSuffix (optional)
block (optional)
lot (optional)

The street name must be in the DPW form more or less described here:

todo - We need a more definitive example here
http://dbiweb.sfgov.org/Dbipts/sfstreets.aspx

The street name suffix must be in the unabbreviated form as per

http://www.usps.com/ncsc/lookups/abbr_suffix.txt.

Example 1

    <address>
        <key>419709</key>
        <base_number_prefix></base_number_prefix>
        <base_number>1</base_number>
        <base_number_suffix></base_number_suffix>
        <longitude>-122.418876252</longitude>
        <latitude>37.774694542</latitude>
        <street_name>S VAN NESS</street_name>
        <street_name_suffix>AVE</street_name_suffix>
        <unit_number_prefix>XXX</unit_number_prefix>
        <unit_number>300</unit_number>
        <unit_number_suffix>YYY</unit_number_suffix>
        <create_tms>2010-08-13 12:15:43.828000</create_tms>
        <retire_tms>2010-08-13 18:41:16.149255</retire_tms>
        <disposition>provisional</disposition>
        <mailing>True</mailing>
        <block>3506</block>
        <lot>001</lot>
        <apn>3506001</apn>
    </address>

Example 2

    <address>
        <key>419709</key>
        <base_number_prefix></base_number_prefix>
        <base_number>1</base_number>
        <base_number_suffix></base_number_suffix>
        <jurisdiction>PRESIDIO</jurisdiction>
        <longitude>-122.418876252</longitude>
        <latitude>37.774694542</latitude>
        <street_name>SOUTH VAN NESS</street_name>
        <street_name_suffix>
            <abbreviated>AVE</abbreviated>
            <unabbreviated>AVENUE</unabbreviated>
        </street_name_suffix>
        <unit_number_prefix>XXX</unit_number_prefix>
        <unit_number>300</unit_number>
        <unit_number_suffix>YYY</unit_number_suffix>
        <create_tms>2010-08-13 12:15:43.828000</create_tms>
        <retire_tms>2010-08-13 18:41:16.149255</retire_tms>
        <disposition>provisional</disposition>
        <mailing>True</mailing>
        <block>3506</block>
        <lot>001</lot>
        <apn>3506001</apn>
    </address>

Example 3

This supports the changes that were precipitated by MAD-156.

<?xml version="1.0" encoding="utf-8"?>
<results>
    <addresses>
            
        <address>
            <base_address>
                <base_address_id>62706</base_address_id>
                <base_number_prefix></base_number_prefix>
                <base_number_prefix></base_number_prefix>
                <base_number>2655</base_number>
                <base_number_suffix></base_number_suffix>
                <jurisdiction>SF MAIN</jurisdiction>
                <longitude>6006839.6487</longitude>
                <latitude>2121446.3926</latitude>
                <street_name>HYDE</street_name>
                <street_name_suffix>
                    <abbreviated>ST</abbreviated>
                    <unabbreviated>STREET</unabbreviated>
                </street_name_suffix>
            </base_address>
            <unit_address>
                <address_id>62708</address_id>
                <unit_number_prefix></unit_number_prefix>
                <unit_number></unit_number>
                <unit_number_suffix></unit_number_suffix>
                <base_unit_address_flag>True</base_unit_address_flag>
                <disposition>official</disposition>
                <mailing>False</mailing>
                <create_tms>2009-09-01 16:47:33.977000</create_tms>
                <last_change_tms>2009-09-01 16:39:13.599000</last_change_tms>
                <retire_tms></retire_tms>
            </unit_address>
            <address_parcel_link>
                <id>88591</id>
                <create_tms>2010-09-30 16:08:34.655225</create_tms>
                <last_change_tms>2010-10-06 16:09:10.410440</last_change_tms>
                <retire_tms></retire_tms>
                <parcel>
                    <block>0026T</block>
                    <lot>646A</lot>
                    <apn>0026T646A</apn>
                </parcel>
            </address_parcel_link>
        </address>
        
    </addresses>
    <message>  </message>
</results>