Api session items addresses: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(43 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Address]] Endpoints.
API Endpoint: /api/session/items/addresses/


Manipulate items with event: [[Api session event editor address|editoraddress]].
Edit items with events described at [[Api session event editor address]].


Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "addition" : "",
  "attributes" : {
    "BAG_ADDRESS_ID" : [ 2.02010000424801E14 ],
    "CADASTRAL_PURPOSE" : [ 1.0 ],
    "ENERGY_LABEL" : [ 4.0 ],
    "FLOOR_SPACE_M2" : [ 100.0 ],
    "INHABITANTS" : [ 1.651153 ],
    "RESIDENCE_TYPE" : [ 4.0 ]
  },
  "id" : 0,
  "letter" : "",
  "maquetteOverride" : null,
  "name" : "1",
  "number" : 5,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 659055.6574087205, 6798773.766250753, 50.08 ]
  },
  "sourceIDs" : [ ],
  "street" : "Lijsterstraat",
  "surfaceSize" : 0.0,
  "type" : "",
  "version" : 6,
  "zipCode" : "6822LB"
}, {
  "addition" : "",
  "attributes" : {
    "BAG_ADDRESS_ID" : [ 2.02010000402527E14 ],
    "CADASTRAL_PURPOSE" : [ 1.0 ],
    "ENERGY_LABEL" : [ 4.0 ],
    "FLOOR_SPACE_M2" : [ 91.0 ],
    "INHABITANTS" : [ 3.438969 ],
    "RESIDENCE_TYPE" : [ 4.0 ]
  },
  "id" : 1,
  "letter" : "",
  "maquetteOverride" : null,
  "name" : "2",
  "number" : 36,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 658709.4792968612, 6799041.675143169, 47.528 ]
  },
  "sourceIDs" : [ ],
  "street" : "Heselbergherweg",
  "surfaceSize" : 0.0,
  "type" : "",
  "version" : 7,
  "zipCode" : "6821JR"
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/addresses/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
<pre>https://engine.tygron.com/api/session/items/addresses/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?crs=3857&token=API_TOKEN</syntaxhighlight>
Degrees:  
Degrees:  
<pre>https://engine.tygron.com/api/session/items/addresses/?crs=4326&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?crs=4326&token=API_TOKEN</syntaxhighlight>
Amersfoort / RD New:  
Amersfoort / RD New:  
<pre>https://engine.tygron.com/api/session/items/addresses/?crs=28992&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?crs=28992&token=API_TOKEN</syntaxhighlight>
Local Coordinates:  
Local Coordinates:  
<pre>https://engine.tygron.com/api/session/items/addresses/?crs=LOCAL&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?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/addresses/?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/addresses/?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/addresses-foo/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/addresses/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/addresses/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=GEOJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=GPKG&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=DXF&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/addresses/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/addresses/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model Address==
API Model description of Address
 
{|class=wikitable
!Name
!Type
!Description
|-
| addition
| String
|
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| id
| int
|
|-
| letter
| String
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| number
| int
|
|-
| point
| Point
| [[Point]]
|-
| sourceIDs
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
| street
| String
|
|-
| surfaceSize
| double
|
|-
| type
| String
|
|-
| version
| int
|
|-
| zipCode
| String
|
|}
 
==Api Model Point==
API Model description of Point
 
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[Point]]
|-
| coordinates
| double[]
| x, y, (optional) z
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor address]]
}}


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

Latest revision as of 07:06, 14 July 2026

API Endpoint: /api/session/items/addresses/

Edit items with events described at Api session event editor address.

Default Query: 

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

Example Response: 

[ {
  "addition" : "",
  "attributes" : {
    "BAG_ADDRESS_ID" : [ 2.02010000424801E14 ],
    "CADASTRAL_PURPOSE" : [ 1.0 ],
    "ENERGY_LABEL" : [ 4.0 ],
    "FLOOR_SPACE_M2" : [ 100.0 ],
    "INHABITANTS" : [ 1.651153 ],
    "RESIDENCE_TYPE" : [ 4.0 ]
  },
  "id" : 0,
  "letter" : "",
  "maquetteOverride" : null,
  "name" : "1",
  "number" : 5,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 659055.6574087205, 6798773.766250753, 50.08 ]
  },
  "sourceIDs" : [ ],
  "street" : "Lijsterstraat",
  "surfaceSize" : 0.0,
  "type" : "",
  "version" : 6,
  "zipCode" : "6822LB"
}, {
  "addition" : "",
  "attributes" : {
    "BAG_ADDRESS_ID" : [ 2.02010000402527E14 ],
    "CADASTRAL_PURPOSE" : [ 1.0 ],
    "ENERGY_LABEL" : [ 4.0 ],
    "FLOOR_SPACE_M2" : [ 91.0 ],
    "INHABITANTS" : [ 3.438969 ],
    "RESIDENCE_TYPE" : [ 4.0 ]
  },
  "id" : 1,
  "letter" : "",
  "maquetteOverride" : null,
  "name" : "2",
  "number" : 36,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 658709.4792968612, 6799041.675143169, 47.528 ]
  },
  "sourceIDs" : [ ],
  "street" : "Heselbergherweg",
  "surfaceSize" : 0.0,
  "type" : "",
  "version" : 7,
  "zipCode" : "6821JR"
} ]

Limit Queries

version=100: 

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

Pseudo-Mercator: 

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

Degrees: 

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

Amersfoort / RD New: 

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

Local Coordinates: 

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

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785: 

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

FOO: 

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

Get Queries

attributes: 

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

max version: 

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

count: 

https://engine.tygron.com/api/session/items/addresses/count/?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

GEOJSON: 

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

GPKG: 

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

DXF: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model Address

API Model description of Address

Name Type Description
addition String
attributes Map<String,double[]>
id int
letter String
maquetteOverride Map<String,double[]>
name String
number int
point Point Point
sourceIDs int[] Sources ID
street String
surfaceSize double
type String
version int
zipCode String

Api Model Point

API Model description of Point

Name Type Description
type String Point
coordinates double[] x, y, (optional) z

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_addresses&oldid=91273"