API Changes: Difference between revisions
Jump to navigation
Jump to search
(Created page with "In order to improve the API we have made some changes: ==EditorScenario== Complete New event for setting scenario's ==Removed== Following events are no longer needed and thus removed: * EditorLevel (partly renamed to Scenario) * EditorMessage (also endpoint api/session/items/messages) * EditorContributor (also endpoint api/session/items/contributors) * FacilitatorSession ==EditorOverlay== {|class=wikitable ! 2022 ! 2023 |- | ADD_CUSTOM_GRIDOVERLAY_LEGEND_ENTRY | ADD_...") |
No edit summary |
||
| Line 1: | Line 1: | ||
In order to improve the API we have made some changes: | In order to improve the API we have made some changes: | ||
=2023.7.5 Update= | |||
* Added isActive boolean to Indicator endpoint, replaces deprecated active map. | |||
* Editor/START_MAP_CREATION has "optional" additional value to set the area of interest. | |||
* Editor/START_MAP_CREATION has option to change the CRS to something else then default EPSG 3857. | |||
* Location endpoint has new version with additional information, defaults to old info. | |||
=2023.6.0 Update= | |||
==EditorScenario== | ==EditorScenario== | ||
| Line 53: | Line 61: | ||
==EditorArea & EditorBuilding & EditorZoning== | ==EditorArea & EditorBuilding & EditorZoning== | ||
{|class=wikitable | {|class=wikitable | ||
Revision as of 12:21, 27 March 2023
In order to improve the API we have made some changes:
2023.7.5 Update
- Added isActive boolean to Indicator endpoint, replaces deprecated active map.
- Editor/START_MAP_CREATION has "optional" additional value to set the area of interest.
- Editor/START_MAP_CREATION has option to change the CRS to something else then default EPSG 3857.
- Location endpoint has new version with additional information, defaults to old info.
2023.6.0 Update
EditorScenario
Complete New event for setting scenario's
Removed
Following events are no longer needed and thus removed:
- EditorLevel (partly renamed to Scenario)
- EditorMessage (also endpoint api/session/items/messages)
- EditorContributor (also endpoint api/session/items/contributors)
- FacilitatorSession
EditorOverlay
| 2022 | 2023 |
|---|---|
| ADD_CUSTOM_GRIDOVERLAY_LEGEND_ENTRY | ADD_LEGEND_ENTRY (rename only) |
| REMOVE_CUSTOM_OVERLAY_LEGEND_ENTRY | REMOVE_LEGEND_ENTRY (rename only) |
| SET_CUSTOM_OVERLAY_LEGEND | SET_CUSTOM_LEGEND (rename only) |
| SET_CUSTOM_OVERLAY_LEGEND_ENTRY_COLOR | SET_LEGEND_ENTRY_COLOR (rename only) |
| SET_CUSTOM_OVERLAY_LEGEND_ENTRY_NAME | SET_LEGEND_ENTRY_NAME (rename only) |
| SET_CUSTOM_OVERLAY_LEGEND_ENTRY_VALUE | SET_LEGEND_ENTRY_VALUE (rename only) |
| SET_ICON (new functionality) | |
| SET_VISIBLE (new functionality) |
EditorActionMenu
| 2022 | 2023 |
|---|---|
| SET_ACTIVE_FOR_STAKEHOLDER_AND_LEVEL | SET_ACTIVE_FOR_STAKEHOLDER_AND_SCENARIO (rename only) |
EditorArea & EditorBuilding & EditorZoning
| 2022 | 2023 |
|---|---|
| IMPORT | Added optional parameter to set the buffer |
EditorGeoLink
| 2022 | 2023 |
|---|---|
| New functionality | REMOVE_FUNCTION, SET_POINT_BUFFER, SET_LINE_BUFFER, SET_GEOMETRY_MODE |
EditorGlobal
| 2022 | 2023 |
|---|---|
| SET_READ_ONLY_START_VALUE | Removed, no longer needed |
EditorIndicator
| 2022 | 2023 |
|---|---|
| DUPLICATE_PERSONAL_INDICATOR | Deprecated, use DUPLICATE_INDICATOR |
EditorLevee
| 2022 | 2023 |
|---|---|
| New functionality | REMOVE_SIDE_FUNCTION, REMOVE_TOP_FUNCTION |
EditorMeasure
| 2022 | 2023 |
|---|---|
| New functionality | ADD_TIFF_SPATIAL, ADD_TIFF_POLYGONS, IMPORT_BUILDING_EXISTING_MEASURE, REMOVE_TIFF_SPATIAL, SET_AUTOMATIC_TIFF_POLYGONS, SET_GEOTIFF, SET_SPATIAL_TERRAIN_TYPE |
| SET_FIXED_WATER_STORAGE | Removed, no longer needed |
EditorNeighborhood
| 2022 | 2023 |
|---|---|
| SET_ACTIVE | Removed parameter to level. |
EditorNetNode
| 2022 | 2023 |
|---|---|
| SET_LOCATION | Added parameter to set the merge distance. |
EditorSetting
| 2022 | 2023 |
|---|---|
| New functionality | GET_SUN_AZIMUTH, GET_SUN_ALTITUDE, GET_SUN_MOTION, GET_EPOCH_TIME, SET_IMPORT_CRS |
| SET_FACILITATOR_TAB_ACTIVE, SET_COMMERCIAL_NAME, SET_VIEWFLOW_ACTIVE, SET_INTRO_IMAGE | Removed functionality |
| Check Setting for all types. |
EditorStakeholder
| 2022 | 2023 |
|---|---|
| SELECT_PREF_OR_FIRST_PLAYABLE_STAKEHOLDER | SELECT_STAKEHOLDER (rename only) |
| SET_PLAYABLE | SET_ACTIVE (rename only) |
| ADD_WITH_TYPE_AND_PLAYABLE | ADD_WITH_TYPE_AND_ACTIVE (rename only) |
| SET_DESCRIPTION, SET_INDICATOR_WEIGHT, SET_LEVEL_ASSIGNMENT, SET_LEVEL_BUDGET_INCREMENT, ADD_INDICATOR_WEIGHT | Removed functionality |
EditorTime
| 2022 | 2023 |
|---|---|
| SET_NUMBER_OF_PAUSE_MOMENTS, SET_SESSION_DURATION_HOURS, SET_SIM_TIME_TYPE, SET_SIMULATION_DURATION_YEARS | Removed functionality |
EditorUpgrade
| 2022 | 2023 |
|---|---|
| SET_CONSTRUCTION_TIME_MONTHS | Removed functionality |
EditorNetCluster
| 2022 | 2023 |
|---|---|
| SET_LEVEL | SET_SCENARIO (rename only) |
Answer
| 2022 | 2023 |
|---|---|
| DELETE_MESSAGE, MEASURE_ASK_DEMOLISH_DATE, MEASURE_DEMOLISH_APPROVAL, WATER_ASK_APPROVAL, WATER_CONFIRM | Removed, no longer used |
Client
| 2022 | 2023 |
|---|---|
| MESSAGE_ANSWERED, MESSAGE_MOTIVATION_ANSWER | Removed, no longer used |
Logic
| 2022 | 2023 |
|---|---|
| BEAMER_SET_OVERLAY_ID, BEAMER_SET_OVERLAY_DIFFERENCE, BEAMER_SET_SCORE_PANEL, BEAMER_SET_VIEW, BEAMER_SWITCH, MEASURE_UPDATE_CUSTOM, MESSAGE_ACTIVATE, MESSAGE_RESET, MESSAGE_REVOKE, SETTINGS_ALLOW_INTERACTION, SETTINGS_SET_ALLOWED_WATER_LEVEL_INCREASE, SETTINGS_SET_MESSAGE_AUTO_RESPOND, SETTINGS_TEAM_NAME,TIME_SET_SIM_MULTIPLIER | Removed, no longer used |
| LEVEL_SET_ACTIVE | SCENARIO_SET_ACTIVE (rename only) |
Participant
| 2022 | 2023 |
|---|---|
| LOAN_ACTIVATE, LOAN_NEW, MEASURE_CREATE_CUSTOM, MEASURE_PLAN_DEMOLISH, MEASURE_SET_WATER_CLASSIFICATION, MESSAGE_ANSWER, MESSAGE_ANSWER_WITH_MOTIVATION, MESSAGE_NEW, MONEY_TRANSFER_ASK | Removed, no longer used |