Data Dictionary

Individual Data Elements

The elements of a results response are described in the Data Dictionary found in the following table.

 

GroupElementDescriptionNotes

H
E
A
D		 result The result status of the search request  
type The type of result error means the request contained invalid or ambiguous data
success means the request completed without errors. A success response may return 0 or more records
This attribute should be success in a results response.
message A textual description of the error This attribute should be " " in a results response

C
O
D
E		 code The result code Found Data means that the search response contains at least one record
Truncated Data means that more data was found than can be returned. As much as allowed is returned with this response.
No Data Found means that the search response contains no records
Server Error means that a server error occurred. These are generally database or back-end related.
Error means that an error occurred that was not a server error. These are generally front-end or input related.
Invalid Input means that one or more of the input parameters was invalid
Mismatched Input means that two input parameters had conflicting data
Missing Input means that at least one required input parameter was missing
Refine Input means that the input data was ambiguous
This attribute should be Found Data or Truncated Data in a results response.
message in case of an error, this would contain the specific error message See Error Response section for more information.

M
E
T
A		 linkexpiration The date after which the links are no longer valid These links are usually valid for several days.
lastrecord The index of the last record in the list of records This attribute should be at least 1 for a results response
firstrecord The index of the first record in the list of records This attribute should be 1 for a results response
totalavailable The total number of available records This attribute should be at least 1 for a results response. There may be more listings available than can be returned under the limits of the WPAPI.
apiversion The version of the API This is 1.0 for this release

L
I
N
K
S		 link A link to additional information related to the search  
linktext A textual description suitable for display  
linktype The type of link  

N
A
M
E		 person A person found in this search record  
rank The relation of the person to the address primary means a primary resident
secondary means someone other than a primary resident using the address, such as a roomer
tertiary means someone using the address as a second address
WPAPI currently only returns primary listings
firstname The first name of the person  
middlename The middle name or initial of the person  
lastname The last name of the person  

B
N
A
M
E		 business A business found in this search record  
businessname The business name of the business  

P
H
O
N
E		 type The type of telephone line work means the telephone is a work number
home means the telephone is at a residence
business means the telephone number is for a business
government means the telephone number is for a government entity
mobile means the telephone number is for a mobile/cell phone
rank Which number is this if there are multiple telephone numbers primary means the number is the first phone number in the record
secondary means the number is the second phone number in the listing
tertiary means the number is the third phone number in the listing
WPAPI currently only returns primary numbers
fullphone The complete telephone number  
areacode The area code portion of the telephone number  
exchange The exchange portion of the telephone number  
linenumber The line number portion of the telephone number  
carrier The telco carrier associated with this telephone number Note that due to number portability, numbers may have been transferred to a different carrier.

A
D
D
R
E
S
S		 address The address associated with the search record  
deliverable Whether the United States Postal Service can deliver to the address true means the address is deliverable
false means the address is not deliverable
fullstreet The complete street address
(concatenation of house, predir, street, and postdir.)		  
house The house portion of the address  
predir The directional prefix for the street  
street The street portion of the address  
postdir The directional suffix for the street  
city The city portion of the address  
state The state portion of the address  
zip The zip code for the address  
zip4 The +4 portion of the zip code for the address  
country The country portion of the address US means the United States of America
WPAPI currently only returns US listings

G
E
O		 geoprecision The precision of the data 0-6, where 0 means the data is more precise and 6 means the data is less precise.
Value 0: rooftop (address level)
Value 1: ZIP+4 centroid (about 8-12 households)
Value 2: ZIP sector centroid
Value 3: block group center (about 200-500 households)
Value 4: census tract (about 850-2000 households)
Value 5: ZIP code centroid
Value 6: unknown or no lat/long determined
latitude The latitude of the search record  
longitude The longitude of the search record  

M
O
R
E		 moreinfolinks A container for links to more information about the search record  
link See description below for URL Links Returned  

URL Links Returned

In addition to the data elements described in the above Data Dictionary, the WhitePages.com API will also return URL links that can be used to refer end users to other useful searches or additional information about the search just performed. Each search will return some subset of these links.

URL_TO_THIS_API_CALL is the same URL as the original query
URL_TO_FIND_NEIGHBORS is the URL to where additional information can be found on the neighbors
URL_TO_VIEW_MAP is the URL to where a map of the address can be found
URL_TO_DRIVING_DIRECTIONS is the URL to where driving directions to the address can be found
URL_TO_VIEW_LISTING_DETAIL is the URL to where additional information on the person can be found
URL_TO_VIEW_ALL is the URL to where additional listings can be found if more are available
URL_TO_VIEW_WORK_LISTINGS is the URL to where only work listings can be found
URL_TO_VIEW_SEARCH_SUGGESTIONS is the URL to where search suggestions for a follow-up search can be found
URL_TO_WHITEPAGES.COM is the URL to WhitePages.com home

Return to the main documentation page

Copyright © 2008 WhitePages.com. All rights reserved.

version 1 as of 5 months ago by Snezana123

Comments

Please sign in to post a comment.