Api session items zipcodes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "api session items Zip Codes Endpoints. Manipulate items with event: [[]].==Limit Queries==version=100: <pre>https://engine.tygron.com/api/session/items/zipcodes/?version=100&token=API_TOKEN</pre> Pseudo-Mercator: <pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&token=API_TOKEN</pre> Degrees: <pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=4326&token=API_TOKEN</pre> Amersfoort / RD New: <pre>https://engine.tygron.com/api/session/i..."
 
No edit summary
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Zip Code]]s Endpoints.
API Endpoint: /api/session/items/zipcodes/
Manipulate items with event: [[]].==Limit Queries==version=100:  
 
<pre>https://engine.tygron.com/api/session/items/zipcodes/?version=100&token=API_TOKEN</pre>
Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ ]</syntaxhighlight>
==Limit Queries==
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&token=API_TOKEN</syntaxhighlight>
Degrees:  
Degrees:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=4326&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?crs=4326&token=API_TOKEN</syntaxhighlight>
Amersfoort / RD New:  
Amersfoort / RD New:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=28992&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?crs=28992&token=API_TOKEN</syntaxhighlight>
Local Coordinates:  
Local Coordinates:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=LOCAL&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?crs=LOCAL&token=API_TOKEN</syntaxhighlight>
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</syntaxhighlight>
FOO:  
FOO:  
<pre>https://engine.tygron.com/api/session/items/zip_codes-foo/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zip_codes-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Limit Queries==max version:  
==Get Queries==
<pre>https://engine.tygron.com/api/session/items/zipcodes/version/?token=API_TOKEN</pre>
attributes:
size:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/attributes/?token=API_TOKEN</syntaxhighlight>
<pre>https://engine.tygron.com/api/session/items/zipcodes/size/?token=API_TOKEN</pre>
max version:  
==Limit Queries==HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/version/?token=API_TOKEN</syntaxhighlight>
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=HTML&token=API_TOKEN</pre>
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=GEOJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=GPKG&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=DXF&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/zipcodes/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model GeometryCollection==
API Model description of GeometryCollection
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model MultiPolygon==
API Model description of MultiPolygon
 
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[MultiPolygon]]
|-
| coordinates
| double[][][][]
| 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]
|}
 
==Api Model TColor==
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model ZipCode==
API Model description of ZipCode
 
{|class=wikitable
!Name
!Type
!Description
|-
| color
| TColor
| [[Color]]
|-
| id
| int
|
|-
| name
| String
|
|-
| polygons
| MultiPolygon
| [[MultiPolygon]]
|-
| sourceIDs
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
| version
| int
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor]]
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:14, 7 July 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

Get Queries

attributes:

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

max version:

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

count:

https://engine.tygron.com/api/session/items/zipcodes/count/?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