API Template usage cheatsheet - Revision history

Rudolf@tygron.nl at 12:29, 8 April 2025

2025-04-08T12:29:56Z

← Older revision		Revision as of 12:29, 8 April 2025
Line 35:		Line 35:
	! !! URL !! Parameters !! Response		! !! URL !! Parameters !! Response
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/io/start/ {{!}}{{!}} ["EDITOR", "demo_heat_stress"] {{!}}{{!}} sessionId		{{!}} POST {{!}}{{!}} /api/event/io/start/ {{!}}{{!}} ["EDITOR", "demo_heat_stress"] {{!}}{{!}} sessionId
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/io/save_project_as/ {{!}}{{!}} [''sessionId'', "","my_project",false] {{!}}{{!}} Whether succesful		{{!}} POST {{!}}{{!}} /api/event/io/save_project_as/ {{!}}{{!}} [''sessionId'', "","my_project",false] {{!}}{{!}} Whether succesful
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/io/join/ {{!}}{{!}} [''sessionId'', "EDITOR"] {{!}}{{!}} json, including apiToken		{{!}} POST {{!}}{{!}} /api/event/io/join/ {{!}}{{!}} [''sessionId'', "EDITOR"] {{!}}{{!}} json, including apiToken
	{{!}}}		{{!}}}
	}}		}}

Rudolf@tygron.nl at 06:41, 3 April 2025

2025-04-03T06:41:59Z

← Older revision		Revision as of 06:41, 3 April 2025
Line 90:		Line 90:
	* Unless otherwise specified, calls should be accompanied with a query parameter "&f=JSON", to define JSON as the used datastructure in data and responses.		* Unless otherwise specified, calls should be accompanied with a query parameter "&f=JSON", to define JSON as the used datastructure in data and responses.
	* Any [[Project]] can be used as a Template, as long as there is no currently running [[Session]], or the [[Project]] is set to [[read-only]].		* Any [[Project]] can be used as a Template, as long as there is no currently running [[Session]], or the [[Project]] is set to [[read-only]].
	* All coordinates are x:y, or longitude:~~latitute~~. This also includes coordinates in MultiPolygons.		* All coordinates are x:y, or longitude:latitude. This also includes coordinates in MultiPolygons.
	* To add an Area of Interest, in the "start_map_creation" event replace the empty array with an array of MultiPolygons.		* To add an Area of Interest, in the "start_map_creation" event replace the empty array with an array of MultiPolygons.
	}}		}}

	}}		}}

Rudolf@tygron.nl at 06:41, 3 April 2025

2025-04-03T06:41:32Z

← Older revision		Revision as of 06:41, 3 April 2025
Line 56:		Line 56:
	{{!}} POST {{!}}{{!}} /api/session/event/editor/set_initial_map_size/ {{!}}{{!}} [2000,2000] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} /api/session/event/editor/set_initial_map_size/ {{!}}{{!}} [2000,2000] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} api/session/event/editor/start_map_creation?crs=4326 {{!}}{{!}} [4.312135, 52.080617, ~~false~~, []] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} api/session/event/editor/start_map_creation?crs=4326 {{!}}{{!}} [4.312135, 52.080617, null, []] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} GET {{!}}{{!}} /api/session/info/ {{!}}{{!}} {{!}}{{!}} json, including state.<br> "NORMAL" means<br>generation is done		{{!}} GET {{!}}{{!}} /api/session/info/ {{!}}{{!}} {{!}}{{!}} json, including state.<br> "NORMAL" means<br>generation is done

Rudolf@tygron.nl at 05:12, 2 April 2025

2025-04-02T05:12:24Z

← Older revision		Revision as of 05:12, 2 April 2025
Line 56:		Line 56:
	{{!}} POST {{!}}{{!}} /api/session/event/editor/set_initial_map_size/ {{!}}{{!}} [2000,2000] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} /api/session/event/editor/set_initial_map_size/ {{!}}{{!}} [2000,2000] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} api/session/event/editor/start_map_creation?crs=4326 {{!}}{{!}} [52.080617~~, 4.312135~~, false, []] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} api/session/event/editor/start_map_creation?crs=4326 {{!}}{{!}} [4.312135, 52.080617, false, []] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} GET {{!}}{{!}} /api/session/info/ {{!}}{{!}} {{!}}{{!}} json, including state.<br> "NORMAL" means<br>generation is done		{{!}} GET {{!}}{{!}} /api/session/info/ {{!}}{{!}} {{!}}{{!}} json, including state.<br> "NORMAL" means<br>generation is done

Rudolf@tygron.nl at 14:23, 27 March 2025

2025-03-27T14:23:54Z

← Older revision		Revision as of 14:23, 27 March 2025
Line 69:		Line 69:
	\|table=		\|table=
	{{{!}}		{{{!}}
	! ~~Vector~~ !! ~~Grid !! Indicator~~		! Data !! Calculation
	{{!}}-		{{!}}-
	{{!}}		{{!}}
	/api/session/wfs/		* /api/session/wfs/
	~~<br>~~ /api/session/items/neighborhoods?f=GEOJSON		* /api/session/items/neighborhoods?f=GEOJSON
	~~<br>~~ /api/session/items/areas?f=GEOJSON		* /api/session/items/areas?f=GEOJSON
	{{!}}{{!}}		{{!}}{{!}}
	/web/wms/		* /web/wms/
	~~<br>~~ /api/session/overlay.png?id=''overlayId''		* /api/session/overlay.png?id=''overlayId''
	~~<br>~~ /api/session/overlay.geotiff?id=''overlayId''		* /api/session/overlay.geotiff?id=''overlayId''
	~~{{!}}{{!}}~~		* /web/indicator.html?id=''indicatorId''
	/web/indicator.html?id=''indicatorId''
	{{!}}}		{{!}}}
	}}		}}

Rudolf@tygron.nl at 14:22, 27 March 2025

2025-03-27T14:22:38Z

← Older revision		Revision as of 14:22, 27 March 2025
Line 72:		Line 72:
	{{!}}-		{{!}}-
	{{!}}		{{!}}
	* /api/session/wfs/		/api/session/wfs/
	* /api/session/items/neighborhoods?f=GEOJSON		<br> /api/session/items/neighborhoods?f=GEOJSON
	* /api/session/items/areas?f=GEOJSON		<br> /api/session/items/areas?f=GEOJSON
	{{!}}{{!}}		{{!}}{{!}}
	* /web/wms/		/web/wms/
	* /api/session/overlay.png?id=''overlayId''		<br> /api/session/overlay.png?id=''overlayId''
	* /api/session/overlay.geotiff?id=''overlayId''		<br> /api/session/overlay.geotiff?id=''overlayId''
	{{!}}{{!}}		{{!}}{{!}}
	* /web/indicator.html?id=''indicatorId''		/web/indicator.html?id=''indicatorId''
	{{!}}}		{{!}}}
	}}		}}

Rudolf@tygron.nl at 14:21, 27 March 2025

2025-03-27T14:21:41Z

← Older revision		Revision as of 14:21, 27 March 2025
Line 75:		Line 75:
	* /api/session/items/neighborhoods?f=GEOJSON		* /api/session/items/neighborhoods?f=GEOJSON
	* /api/session/items/areas?f=GEOJSON		* /api/session/items/areas?f=GEOJSON
	~~ <br>~~
	{{!}}{{!}}		{{!}}{{!}}
	* /web/wms/		* /web/wms/
Line 82:		Line 81:
	{{!}}{{!}}		{{!}}{{!}}
	* /web/indicator.html?id=''indicatorId''		* /web/indicator.html?id=''indicatorId''
	~~ <br>~~
	~~ <br>~~
	{{!}}}		{{!}}}
	}}		}}

Rudolf@tygron.nl at 14:19, 27 March 2025

2025-03-27T14:19:07Z

← Older revision		Revision as of 14:19, 27 March 2025
Line 65:		Line 65:
	\|title=Get results		\|title=Get results
	\|type=results		\|type=results
	\|text=~~Various results endpoints~~		\|text=
	\|image=		\|image=
	\|table=		\|table=

Rudolf@tygron.nl at 14:14, 27 March 2025

2025-03-27T14:14:55Z

@@ Line 61: / Line 61: @@
    {{!}}}
 }}
 {{cheatsheet-block
 |title=Notes
@@ Line 66: / Line 92: @@
 |image=
 |text=<nowiki></nowiki>
-* All calls should be accompanied with a query parameter "&f=JSON", to define JSON as the used datastructure in data and responses.
+* Unless otherwise specified, calls should be accompanied with a query parameter "&f=JSON", to define JSON as the used datastructure in data and responses.
 * Any [[Project]] can be used as a Template, as long as there is no currently running [[Session]], or the [[Project]] is set to [[read-only]].
 * All coordinates are x:y, or longitude:latitute. This also includes coordinates in MultiPolygons.

Rudolf@tygron.nl at 13:56, 27 March 2025

2025-03-27T13:56:56Z

← Older revision		Revision as of 13:56, 27 March 2025
Line 35:		Line 35:
	! !! URL !! Parameters !! Response		! !! URL !! Parameters !! Response
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/io/start/~~?f=JSON~~ {{!}}{{!}} ["EDITOR", "demo_heat_stress"] {{!}}{{!}} sessionId		{{!}} POST {{!}}{{!}} /api/io/start/ {{!}}{{!}} ["EDITOR", "demo_heat_stress"] {{!}}{{!}} sessionId
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/io/save_project_as/~~?f=JSON~~ {{!}}{{!}} [''sessionId'', "","my_project",false] {{!}}{{!}} Whether succesful		{{!}} POST {{!}}{{!}} /api/io/save_project_as/ {{!}}{{!}} [''sessionId'', "","my_project",false] {{!}}{{!}} Whether succesful
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/io/join/~~?f=JSON~~ {{!}}{{!}} [''sessionId'', "EDITOR"] {{!}}{{!}} json, including apiToken		{{!}} POST {{!}}{{!}} /api/io/join/ {{!}}{{!}} [''sessionId'', "EDITOR"] {{!}}{{!}} json, including apiToken
	{{!}}}		{{!}}}
	}}		}}
Line 52:		Line 52:
	! !! URL !! Parameters !! Response		! !! URL !! Parameters !! Response
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} api/session/event/editor/clear_map/~~?f=JSON~~ {{!}}{{!}} [true] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} api/session/event/editor/clear_map/ {{!}}{{!}} [true] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} /api/session/event/editor/set_initial_map_size/~~?f=JSON~~ {{!}}{{!}} [2000,2000] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} /api/session/event/editor/set_initial_map_size/ {{!}}{{!}} [2000,2000] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} POST {{!}}{{!}} api/session/event/editor/start_map_creation?~~f=JSON&~~crs=4326 {{!}}{{!}} [52.080617, 4.312135, false, []] {{!}}{{!}} n/a		{{!}} POST {{!}}{{!}} api/session/event/editor/start_map_creation?crs=4326 {{!}}{{!}} [52.080617, 4.312135, false, []] {{!}}{{!}} n/a
	{{!}}-		{{!}}-
	{{!}} GET {{!}}{{!}} /api/session/info/~~?f=JSON~~ {{!}}{{!}} {{!}}{{!}} json, including state.<br> "NORMAL" means<br>generation is done		{{!}} GET {{!}}{{!}} /api/session/info/ {{!}}{{!}} {{!}}{{!}} json, including state.<br> "NORMAL" means<br>generation is done
	{{!}}}		{{!}}}
	}}		}}
Line 66:		Line 66:
	\|image=		\|image=
	\|text=<nowiki></nowiki>		\|text=<nowiki></nowiki>
			* All calls should be accompanied with a query parameter "&f=JSON", to define JSON as the used datastructure in data and responses.
	* Any [[Project]] can be used as a Template, as long as there is no currently running [[Session]], or the [[Project]] is set to [[read-only]].		* Any [[Project]] can be used as a Template, as long as there is no currently running [[Session]], or the [[Project]] is set to [[read-only]].
	* All coordinates are x:y, or longitude:latitute. This also includes coordinates in MultiPolygons.		* All coordinates are x:y, or longitude:latitute. This also includes coordinates in MultiPolygons.