|
Zip
Codes allows a lender to search for ZIP Codes by field office, state,
city, county code, or county name. The search can be used to find
the field office location information by entering the ZIP Code.
For example, if the search was to find the ZIP Code for the field
office responsible for Leesburg, VA, enter and submit the location
information. To find which field office is responsible for a given
ZIP Code, enter and submit the ZIP Code.
To run Zip Codes post your data to:
https://hwvauwd491.hud.gov/b2b/lists/ziplookxml.cfm
Sample
Input File
<?xml version='1.0' standalone='yes'?>
<FHAENTITYDATA FHAVersionID = '1.0'>
<PROCESSSTATUS>
<ProcessStatusRequestor>ATS-B2B</ProcessStatusRequestor>
</PROCESSSTATUS>
<PROPERTY>
<State>WY</State>
<City>ENCAMPMENT</City>
<PostalCode>82325</PostalCode>
<County>CARBON</County>
<FHAVAFieldOfficeCode>0805</FHAVAFieldOfficeCode>
</PROPERTY>
<SUBJECTPROPERTY>
<CountyCode>007</CountyCode>
</SUBJECTPROPERTY>
</FHAENTITYDATA>
Zip
Codes
| Data
Item |
Valid
Entries |
Description |
<PROCESSSTATUS>
<ProcessStatusRequestor> |
Up
to 36 Alphanumeric characters |
(Required
Entry) Name of company issuing request. |
<PROPERTY>
<State> |
Valid
two character state name |
(Required
Entry If No Other Required Data Item Selected; Defaults To All
States) State in which the ZIP Code resides. |
<PROPERTY>
<City> |
Up
to seventeen alphanumeric characters |
(Required
Entry If No Other Required Data Item Selected) Name of the city
in which the ZIP Code resides. |
<PROPERTY>
<PostalCode> |
Five
numeric characters |
(Required
Entry If No Other Required Data Item Selected) ZIP Code in which
the ZIP Code resides. |
<PROPERTY>
<County> |
Up
to fifteen alphanumeric characters |
(Required
Entry If No Other Required Data Item Selected) Name of the county
in which the ZIP Code resides. |
<PROPERTY>
<FHAVAFieldOfficeCode> |
Field
Office |
(Required
Entry If No Other Required Data Item Selected; Defaults to All
Field Offices) Four digit code representing the appropriate
HUD Field Office in which the ZIP Code resides. |
<SUBJECTPROPERTY>
<CountyCode> |
Three
numeric characters |
(Required
Entry If No Other Required Data Item Selected) County Code in
which the ZIP Code resides. |
Information
Returned:
Using
the above input fields, the Zip Codes request will be processed or
rejected. The results of the request will be displayed in the <ProcessStatusCode>
field and will indicate either "Error" or "Success". When an error
occurs, a message pertaining to the error will be displayed in the
<ProcessStatusMessage> field.
Sample
Output File
<?xml version="1.0" standalone="yes" ?>
<FHAENTITYDATA FHAVersionID="1.0">
<PROCESSSTATUS>
<ProcessStatusCode>Success</ProcessStatusCode>
<ProcessStatusMessage sCode="1">Returned 1 zip code record(s)</ProcessStatusMessage>
</PROCESSSTATUS>
<PROPERTY PROPERTYID="1">
<State>WY</State>
<City>ENCAMPMENT</City>
<PostalCode>823250000</PostalCode>
<County>CARBON</County>
<FHAVAFieldOfficeCode>0805</FHAVAFieldOfficeCode>
</PROPERTY>
<SUBJECTPROPERTY SUBJECTPROPERTY="1">
<CountyCode>007</CountyCode>
</SUBJECTPROPERTY>
</FHAENTITYDATA>
End
of Output Fields for Zip Codes
|
Data Item |
Description |
<PROCESSSTATUS>
<ProcessStatusCode> |
Result
of the request. See below for values and meanings. |
<PROCESSSTATUS>
<ProcessStatusMessage sCode='1'> |
Message
detailing errors. Up to 80 alphanumeric characters. Up to 25
error messages may be returned (sCode). |
| <PROPERTY
PROPERTYID = 'VALUE'> |
Indicates a numeric counter of how many records were selected. |
<PROPERTY
PROPERTYID = 'VALUE'>
<State> |
State in which the ZIP Code resides. Two characters. |
<PROPERTY
PROPERTYID = 'VALUE'>
<City> |
City name in which the ZIP Code resides. Up to seventeen alphanumeric
characters. |
<PROPERTY
PROPERTYID = 'VALUE'>
<PostalCode> |
Zip code in which the ZIP Code resides. Five numeric characters. |
<PROPERTY
PROPERTYID = 'VALUE'>
<County> |
County name in which the ZIP Code resides. Up to fifteen alphanumeric
characters. |
<PROPERTY
PROPERTYID = 'VALUE'>
<FHAVAFieldOfficeCode> |
Four digit code representing the appropriate HUD Field Office
in which the ZIP Code resides. |
| <SUBJECTPROPERTY
PROPERTYID = 'VALUE'> |
Indicates a numeric counter of how many records were selected. |
<SUBJECTPROPERTY
PROPERTYID = 'VALUE'>
<CountyCode> |
County Code in which the ZIP Code resides. Three numeric characters. |
ProcessStatusCode
Values:
End
of ProcessStatusCode Values
| SuccessNoUpdateAllowed |
This
indicates that Zip Codes was processed, that is, the query has
been successful. |
| Error |
This
indicates that an error has occurred during the Zip Codes process
and that the case has not been processed successfully. Either
there were missing data or the data were in error. Please see
the ProcessStatusMessage for details. |
Comments or Questions?
<SF Administration>
|