Api session items zipcodes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 27: Line 27:
==Formats==
==Formats==
HTML:  
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=HTML&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=GEOJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=GPKG&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=DXF&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=CSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=SSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=SMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
==Api Model GeometryCollection==
==Api Model GeometryCollection==
API Model description of GeometryCollection
API Model description of GeometryCollection
Line 65: Line 65:
| type
| type
| String
| String
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| coordinates
| coordinates
| double[][][][]
| double[][][][]
| array of [[#Api Model Polygon|Polygon]]s; [[#Api Model Polygon|Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]
| array of [[Polygon]]s; [[Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]
|}
|}


Line 91: Line 91:
| color
| color
| TColor
| TColor
|  
| [[Color]]
|-
|-
| id
| id
Line 103: Line 103:
| polygons
| polygons
| MultiPolygon
| MultiPolygon
|  
| [[MultiPolygon]]
|-
|-
| sourceIDs
| sourceIDs

Latest revision as of 13:03, 19 June 2026

API Endpoint: /api/session/items/zipcodes/

Default Query:

https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN

Example Response:

[ ]

Limit Queries

version=100:

https://engine.tygron.com/api/session/items/zipcodes/?version=100&token=API_TOKEN

Pseudo-Mercator:

https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&token=API_TOKEN

Degrees:

https://engine.tygron.com/api/session/items/zipcodes/?crs=4326&token=API_TOKEN

Amersfoort / RD New:

https://engine.tygron.com/api/session/items/zipcodes/?crs=28992&token=API_TOKEN

Local Coordinates:

https://engine.tygron.com/api/session/items/zipcodes/?crs=LOCAL&token=API_TOKEN

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:

https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN

FOO:

https://engine.tygron.com/api/session/items/zip_codes-foo/?crs=3857&token=API_TOKEN

Show Queries

max version:

https://engine.tygron.com/api/session/items/zipcodes/version/?token=API_TOKEN

size:

https://engine.tygron.com/api/session/items/zipcodes/size/?token=API_TOKEN

Formats

HTML:

https://engine.tygron.com/api/session/items/zipcodes/?f=HTML&token=API_TOKEN&crs=3857

JSON:

https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN&crs=3857

GEOJSON:

https://engine.tygron.com/api/session/items/zipcodes/?f=GEOJSON&token=API_TOKEN&crs=3857

GPKG:

https://engine.tygron.com/api/session/items/zipcodes/?f=GPKG&token=API_TOKEN&crs=3857

DXF:

https://engine.tygron.com/api/session/items/zipcodes/?f=DXF&token=API_TOKEN&crs=3857

CSV:

https://engine.tygron.com/api/session/items/zipcodes/?f=CSV&token=API_TOKEN&crs=3857

SSV:

https://engine.tygron.com/api/session/items/zipcodes/?f=SSV&token=API_TOKEN&crs=3857

SMILE:

https://engine.tygron.com/api/session/items/zipcodes/?f=SMILE&token=API_TOKEN&crs=3857

ZIPJSON:

https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPJSON&token=API_TOKEN&crs=3857

ZIPSMILE:

https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPSMILE&token=API_TOKEN&crs=3857

Api Model GeometryCollection

API Model description of GeometryCollection

Name Type Description

Api Model MultiPolygon

API Model description of MultiPolygon

Name Type Description
type String MultiPolygon
coordinates double[][][][] array of Polygons; Polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]

Api Model TColor

API Model description of TColor

Name Type Description

Api Model ZipCode

API Model description of ZipCode

Name Type Description
color TColor Color
id int
name String
polygons MultiPolygon MultiPolygon
sourceIDs int[] Sources ID
version int