Api session items overlays: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Overlay]] Endpoints.
Api session items [[Overlay]] Endpoints.
 
Manipulate items with event: [[Api session event editor overlay|editoroverlay]].
Manipulate items with event: [[Api session event editor overlay|editoroverlay]].
==Limit Queries==version=100:  
 
Default Query:
<pre>https://engine.tygron.com/api/session/items/overlays/?f=JSON&token=API_TOKEN</pre>
Example Response:
<pre>[ {
  "attributes" : {
    "FOO" : [ 1.0 ],
    "PINO" : [ 79.000965 ],
    "SINGLE" : [ 75.624039 ],
    "SJAAKIE" : [ 6.79401 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "id" : 0,
  "imageName" : "normal.png",
  "imageVersion" : 0,
  "legend" : [ ],
  "maquetteOverride" : null,
  "name" : "fzh8W",
  "parentID" : -1,
  "sortIndex" : 52,
  "type" : null,
  "version" : 1,
  "visible" : true
}, {
  "attributes" : {
    "PINO" : [ 1.0 ],
    "SJAAKIE" : [ 1.0 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "id" : 1,
  "imageName" : "neighborhoods.png",
  "imageVersion" : 0,
  "legend" : [ {
    "color" : {
      "argb" : -9772392
    },
    "entryName" : "buurt",
    "id" : 1,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -1877165
    },
    "entryName" : "Sonsbeek-Noord",
    "id" : 2,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -16173383
    },
    "entryName" : "Onder de Linden",
    "id" : 3,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -6740311
    },
    "entryName" : "St. Janskerkstraat e.o.",
    "id" : 4,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -15232895
    },
    "entryName" : "Hazegrietje",
    "id" : 5,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -4609484
    },
    "entryName" : "Klarenbeek",
    "id" : 6,
    "value" : "-Infinity"
  } ],
  "maquetteOverride" : null,
  "name" : "ee27M",
  "parentID" : -1,
  "sortIndex" : 51,
  "type" : "NEIGHBORHOODS",
  "version" : 12,
  "visible" : true
} ]</pre>
==Limit Queries==
version=100:  
<pre>https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN</pre>
<pre>https://engine.tygron.com/api/session/items/overlays/?version=100&token=API_TOKEN</pre>
==Limit Queries==max version:  
==Show Queries==
max version:  
<pre>https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN</pre>
<pre>https://engine.tygron.com/api/session/items/overlays/version/?token=API_TOKEN</pre>
size:  
size:  
Line 9: Line 99:
Overlays (GeoJSON):  
Overlays (GeoJSON):  
<pre>https://engine.tygron.com/web/overlays.geojson?token=API_TOKEN</pre>
<pre>https://engine.tygron.com/web/overlays.geojson?token=API_TOKEN</pre>
==Limit Queries==HTML:  
==Formats==
HTML:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN</pre>
<pre>https://engine.tygron.com/api/session/items/overlays/?f=HTML&token=API_TOKEN</pre>
JSON:  
JSON:  
Line 23: Line 114:
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</pre>
<pre>https://engine.tygron.com/api/session/items/overlays/?f=ZIPSMILE&token=API_TOKEN</pre>
{{article end|seealso=*[[Api Content Items]]}}
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor overlay]]
}}


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

Latest revision as of 14:29, 1 April 2026

Api session items Overlay Endpoints.

Manipulate items with event: editoroverlay.

Default Query:

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

Example Response:

[ {
  "attributes" : {
    "FOO" : [ 1.0 ],
    "PINO" : [ 79.000965 ],
    "SINGLE" : [ 75.624039 ],
    "SJAAKIE" : [ 6.79401 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "id" : 0,
  "imageName" : "normal.png",
  "imageVersion" : 0,
  "legend" : [ ],
  "maquetteOverride" : null,
  "name" : "fzh8W",
  "parentID" : -1,
  "sortIndex" : 52,
  "type" : null,
  "version" : 1,
  "visible" : true
}, {
  "attributes" : {
    "PINO" : [ 1.0 ],
    "SJAAKIE" : [ 1.0 ]
  },
  "colorMultiplier" : 1.0,
  "colorOffset" : 127,
  "customLegend" : false,
  "id" : 1,
  "imageName" : "neighborhoods.png",
  "imageVersion" : 0,
  "legend" : [ {
    "color" : {
      "argb" : -9772392
    },
    "entryName" : "buurt",
    "id" : 1,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -1877165
    },
    "entryName" : "Sonsbeek-Noord",
    "id" : 2,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -16173383
    },
    "entryName" : "Onder de Linden",
    "id" : 3,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -6740311
    },
    "entryName" : "St. Janskerkstraat e.o.",
    "id" : 4,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -15232895
    },
    "entryName" : "Hazegrietje",
    "id" : 5,
    "value" : "-Infinity"
  }, {
    "color" : {
      "argb" : -4609484
    },
    "entryName" : "Klarenbeek",
    "id" : 6,
    "value" : "-Infinity"
  } ],
  "maquetteOverride" : null,
  "name" : "ee27M",
  "parentID" : -1,
  "sortIndex" : 51,
  "type" : "NEIGHBORHOODS",
  "version" : 12,
  "visible" : true
} ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

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

Overlays (GeoJSON):

https://engine.tygron.com/web/overlays.geojson?token=API_TOKEN

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

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