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

Update API.md

Browse Source
This commit is contained in:
Carla 2015-11-13 16:01:44 +01:00
parent e7f2a71c48
commit 900ca6002d
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/API.md
View File

@ -3,15 +3,27 @@
### Overview
### Quickstart
### General concepts
#### Auth?
#### Errors
Errors will be described in the response of the geocoder request. An example is as follows:
```json
{
error: [
"function geocode_countries(text) does not exist"
]
}
```
Due to the fact that the Geocoder API is used on top of the CartoDB SQL API you can check the [Making calls to the SQL API](http://docs.cartodb.com/cartodb-platform/sql-api/making-calls/) section to help you debug your SQL errors.
### Pre/post conditions
#### Possible side-effects
For each function:
function names
function parameters and types
return type for the functions (Geometry or NULL if not found, with SRID 4326)
pre- and post-conditions or invariants
### Reference
#### Geocoding functions