cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #113 from CartoDB/docs-726-zcta-explanation

Browse Source 
added note about zcta under postal codes generator section
This commit is contained in:
csobier
2016-03-23 08:45:19 -04:00
parent 0117830ffd 0ca1b84096
commit 1d5545b239
5 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/API.md
View File

@@ -9,6 +9,7 @@ The isoline functions provide a way to generate isolines in terms of distance an
## Documentation
* [Quickstart](quickstart.md)
* [General concepts](general_concepts.md)
* [Geocoding functions](geocoding_functions.md)
* [Isoline functions](isoline_functions.md)
* [General Concepts](general_concepts.md)
* [Geocoding Functions](geocoding_functions.md)
* [Isoline Functions](isoline_functions.md)
* [Quota Information](quota_information.md)

2
doc/general_concepts.md
View File

@@ -1,4 +1,4 @@
# General concepts
# General Concepts
The Data Services API offers geocoding and isoline services on top of the CartoDB SQL API by means of a set of functions. Each one of these functions is oriented to one kind of operation and returns the corresponding geometry (a `polygon` or a `point`), according to the input information.

6
doc/geocoding_functions.md
View File

@@ -1,4 +1,4 @@
# Geocoding functions
# Geocoding Functions
The following geocoding functions are available, grouped by categories.
@@ -181,6 +181,8 @@ UPDATE {tablename} SET the_geom = cdb_geocode_namedplace_point({city_column}, {p
The following functions provide a postal code geocoding service that can be used to obtain points or polygon results. The postal code polygon geocoder covers the United States, France, Australia and Canada; a request for a different country will return an empty response.
**Note:** For the USA, US Census [Zip Code Tabulation Areas](https://www.census.gov/geo/reference/zctas.html) (ZCTA) are used to reference geocodes for USPS postal codes service areas. See the [FAQs](http://docs.cartodb.com/faqs/datasets-and-data/#why-does-cartodb-use-census-bureau-zctas-and-not-usps-zip-codes-for-postal-codes) about datasets and data for details.
### cdb_geocode_postalcode_polygon(_postal_code text, country_name text_)
#### Arguments
@@ -208,8 +210,6 @@ SELECT cdb_geocode_postalcode_polygon('11211', 'USA')
UPDATE {tablename} SET the_geom = cdb_geocode_postalcode_polygon({postal_code_column}, 'USA')
```
**Note:** For the USA, US Census ZCTAs are considered.
### cdb_geocode_postalcode_point(_code text, country_name text_)
#### Arguments

2
doc/isoline_functions.md
View File

@@ -1,4 +1,4 @@
# Isoline functions
# Isoline Functions
The following functions provide an isolines generator service based on time or distance. This service uses the isolines service defined for the user (currently, only the Here isolines service is available).

2
doc/quota_information.md
View File

@@ -1,4 +1,4 @@
# Quota information
# Quota Information
**This Data Services API provides functions which are subject to quota limitations, and extra fees may apply**. Please check our [terms and conditions](https://cartodb.com/terms/).