Endpunkt: /json/load

Encoding: POST (application/json)

Endpunkt: /json/reinitialize

Encoding: GET/POST (application/x-www-form-urlencoded)

Endpunkt: /unload

Encoding: GET/POST (application/x-www-form-urlencoded)

Entlädt die Ebene aus dem Projekt, sofern vorhanden. Zurückgegeben wird ein Array von Zahlenwerten, die die Verwendung der Ebenen anzeigen (der Unload kann u.U. erst mit der letzten Referenz auf die Ebene erfolgen)

Argumente:

• layer: Name der Ebene

oder

• layers: Namen der Ebenen, kommagetrennt

Endpunkt: /json/layers

Encoding: GET

Ruft Informationen über geladene Ebenen ab, gibt Array oder ein Einzelobjekt (bei Verwendung von layer) zurück.

Argumente:

• embedDefaultCss (false): Css mit abrufen

• layer (null): Name der Ebene, ist diese nicht vorhanden wird eine LayerNotFound Exception geliefert

... oder ...

• layers (null): Komma getrennte Liste der Ebenen, nicht vorhandene Ebenen werden ignoriert

Wird weder layer oder layers angegeben, werden alle Ebenen zurückgegeben.

Beachte, dass bei layer ein Einzel-Objekt, bei den anderen Optionen immer ein Array zurückgeliefert wird.

[
  {
    "layerName": "STR",
    "primarySource": "D:\\TEMP\\STRAS.shp",
    "secondSource": "",
    "title": "",
    "description": "Shape-Datei",
    "featureCount": 13371,
    "subLayers": [],
    "primarySourceLastModified": "2015-02-15T15:11:42.331Z",
    "displayScaleRange": {
      "minimum": 0,
      "maximum": 0
    },
    "envelope": {
      "epsgCode": 31469,
      "minx": 5400673.414,
      "miny": 5649421.5315,
      "maxx": 5427367.4021,
      "maxy": 5671795.5065
    },
    "supportsCssStyling": true,
    "defaultCss": "",
    "supportedStyle": 1,
	"querySupport": 3,
    "type": "VectorLayer",
    "detailedType": "Shapefile",
    "attributs": [
      {
        "name": "ShapeRowId",
        "type": "Int32",
        "flags": "UniqueValues, HasIndex, IsNotNull, ComputedColumn, RowId",
        "length": -1,
        "ordinal": 0
      },
      {
        "name": "ShapeGeometry",
        "type": "Geom",
        "flags": "HasIndex",
        "length": -1,
        "ordinal": 1
      },
      {
        "name": "CLASS",
        "type": "Int32",
        "flags": "Default",
        "length": 8,
        "ordinal": 0
      }
    ],
    "loadedAt": "2017-06-03T07:49:38.137Z",
    "loadingDurationMs" : 80

  }
]

Endpunkt: /json/findlayers

Encoding: GET/POST (application/x-www-form-urlencoded)

Ermittelt die Ebenennamen, die als Datenquelle mind. eine mit filePattern übereinstimmende Datei verwenden.

Zurückgegeben wird ein Dictionary mit Projekt-Name als Schlüssel und der Liste der gefundenen Ebenennamen in diesem Projekt.

Argumente:

• lookInAllProjects (false): wenn true, dann wird in allen Projekten gesucht, sonst nur im aktuellen

• filePattern : Teil des gesuchten Dateinamen, kann * oder ? als Platzhalter enthalten. Intern sind die Dateinamen immer absolut. In dieser Methoden werden auch temp. erstellte Dateien mit gesucht (z.B. die Cache-Datenbank einer DXF Datei).

  Durch | können mehrere Muster übergeben werden.

Beispiel-Ausgabe:

{"REF":[
  "L1",
  "L2"
]}

Endpunkt: /json/layersreinitrequired

Encoding: GET/POST (application/x-www-form-urlencoded)

Ermittelt die Ebenennamen, deren Quelle sich seit dem Laden geändert hat und die neu geladen werden müssen.

Zurückgegeben wird ein Dictionary mit Projekt-Name als Schlüssel und der Liste der gefundenen Ebenennamen in diesem Projekt.

Argumente:

• lookInAllProjects (false): wenn true, dann wird in allen Projekten gesucht, sonst nur im aktuellen

Beispiel-Ausgabe:

{"REF":[
  "L1",
  "L2"
]}

Endpunkt: /json/layerExists

Encoding: GET/POST (application/x-www-form-urlencoded)

Gibt in einer Bitmaske für jeden angefragten Layer zurück, ob dieser aktuell im aktiven Projekt geladen ist (0=nicht vorhanden, 1 = vorhanden)

Argumente:

• layers : Komma-getrennte Liste, der zu prüfenden Ebenen

Bsp.:

/iwan/{project}/json/layerExits?layers=A,B,C

Ausgabe:

010

Endpunkt: /json/layerSourceFiles

Encoding: GET/POST (application/x-www-form-urlencoded)

Gibt ein String-Array aller Dateinamen der Quelle zurück (absoluter Pfad).

Argumente:

• layer : Name der Ebenen
• includeTempFiles (false): auch temp. Dateien mit zurückliefern.

Endpunkt: /json/renderstats

Encoding: GET/POST (application/x-www-form-urlencoded)

Gibt alle verfügbaren Ebenen Zeicheninformationen im aktuellen Projekt zurück, optional gefiltert auf die MapRenderId (siehe.

Antwort ist ein Array von Die Statistik pro Zeichenvorgang wird maximal nach 1 Minute lang vorgehalten.

Argumente:

• ids (): Kommagetrennte Liste der MapRenderIds aus dem aktivem Projekt (wenn leer, werden alle aktuellen Einträge geliefert)
• remove (false): die vom Abruf betroffenen Einträge löschen.

Rund um Snapshots

Endpunkt: /json/snapshot/create

Encoding: GET/POST (application/x-www-form-urlencoded)

Erstellt oder modifiziert die Daten eines Snapshots. Zurückgegeben wird die Beschreibung der erstellten, bzw. aktualisierten Snapshot-Ebene.

Argumente:

• layer: Name der Quell-Ebene

• snapshotid: Id des Snapshots, darf nicht mit dem Namen einer vorhandene Ebene kollidieren

• filter: Filter, optional, als Json

• mode: Einer der Werte Replace, Remove, Append

Endpunkt: /json/snapshot/snapshotDelete

Encoding: GET/POST (application/x-www-form-urlencoded)

Löscht einen Snapshot mitsamt der Daten. Die Methode hat keine Rückgabe.

Argumente:

• layer: Name der Quell-Ebene

• snapshotids: Ids der Snapshots, optional (Komma getrennte Liste)

• byCaller: Bool, schließt sich mit snapshotids aus, wenn übergeben, dann alle Snapshots mit der callerId

Endpunkt: /json/snapshot/getid

Encoding: GET

Gibt die Snapshot-Ids für die aktuelle callerId zurück.

Karten und Symbolik

Endpunkt: /render

Encoding: GET/POST (application/x-www-form-urlencoded)

Generiert ein Kartenbild durch Rendern der angegebenen Ebenen und sendet das Ergebnis als PNG Bild zurück. Im Antwort-Header werden zudem Informationen über den Zeichenvorgang zurückgegeben.

Argumente:

• targetEpsg (0) : Zieltransformation

• width: physische Breite in Pixeln

• height: physische Höhe in Pixeln

• scaleFactor (1.0): Auflösung

• layers: Komma getrennte Liste der zu zeichnenden Ebenennamen

• bbox: Komma getrennte in der Form "x,y,x,y,epsg", wenn nicht angegeben, dann wird die Ausdehnung der layers verwendet Die Bounding Box wird an das Höhen- und Breitenverhältnis der physischen Bildgröße angepasst.

• RenderEngine (Agee): Gdiplus|Direct2d|Agee

IDU Intern:

In .Net gibt es eine Hilfsfunktion mit deren Hilfe sich die Kachelparameter (Anzahl, Größe, Position, BoundingBox) berechnen lassen.

Datei: Rendering\RendererUtils.h

Namespace: IduIT.GeoLib.Net.Rendering.RendererUtils

Klasse: MapParameterCalculator

Funktion:

• ComputeTileSetParameter: Berechnet die Parameter aller Bildkacheln

Abruf rotierter Kartenbilder:

Endpunkt: /json/render

Encoding: POST (application/json)

Encoding: GET (mit Paramter json=..)

Generiert ein Kartenbild durch Rendern der angegebenen Ebenen und sendet das Ergebnis als PNG Bild zurück. Im Antwort-Header werden zudem Informationen über den Zeichenvorgang zurückgegeben.

Endpunkt: /legend

Encoding: GET/POST (application/x-www-form-urlencoded)

Erstellt ein Legenden-Symbol aus dem übergeben Css und liefert dieses als PNG Bild zurück

Im http-Header "IwanLegImageInfo" wird leerzeichengetrennt Breite und Höhe in Pixel ausgegenen.

Argumente:

Css-Quelle, eines der Argumente

• layer : Name der Ebene, dessen Default-Css verwendet werden soll

oder ...

• cssFile : css - Dateiname (aus Serversicht)

oder ...

• css: css als Text

• boxWidth (35): Breite des Ausgabebild in Pixeln

• boxHeight (25): Breite des Ausgabebild in Pixeln

• mapScale (3000): Angenommener Maßstab

• ignoreMapExcludeSetting (false): Ignoriere die Einstellung "exclude-from-map-legend" der betroffenen Blöcke.

• format (Image): Ausgabeformat Image, Html oder JSON

Nur für Format "Image"

• labelFontSize (14): Schriftgröße in Pixeln

• labelFontName (Arial): Schriftart

Rahmen und Abstände:

• verticalBorderInPixel (10)

• verticalSpacingInPixel (5)

• horizontalBorderInPixel (10)

• horizontalSpacingInPixel (5)

Ausgabeformate:

• Image: Ein Einzelbild mit allen Elementen und Labeln, immer im Format PNG

• Html: Ein Html dem Template pro Eintrag:

    <figure>
      <img height="n" width="n" src="data:image/png;base64,...">
      <figcaption>Label</figcaption>
    </figure>
  

• Json: Ein String-Array, 2 Array Einträge bilden jeweils einen Legendeneintrag, 1. Base64 Byte-Array mit dem PNG Bild, 2. Label

Endpunkt: /json/validatecss

Encoding: GET/POST (application/x-www-form-urlencoded)

Beispiel-Ausgabe:

{
  "layername":"STR",
  "success":false,
  "error":"Fehler im....",
  "isCssError":true
}

Argumente:

• css: Das Css, welches geprüft werden soll

• layer: Name der Ebene die für die Validierung verwendet wird (ist erforderlich, da im css Spalten verwendet werden können etc.)

Endpunkt: /json/installedFonts

Encoding: GET/POST (application/x-www-form-urlencoded)

Gibt die Namen der installierten True-Type-Fonts zurück als String-Array zurück.

Argumente:

• charset (default): Zeichensatz (default, symbol)

• family (""): Name der Schriftfamilie (bspw. Helvetica)

Endpunkt: /json/markerPreview

Encoding: GET/POST (application/x-www-form-urlencoded)

Generiert ein Bild oder ein HTML oder Json mit den Vorschaubildern für Punkte mit TrueType-Markern.

Argumente:

• fontName : Name der Schriftart

• startCharCode : Wert des Start-Zeichencode

• endCharCode : Wert des End-Zeichencode

Endpunkt: /bin/query

Encoding: POST (plain/text)

Ruft einen Data-Reader als Ergebnis einer GeoSQL Abfrage ab. Der Transport erfolgt über ein sehr effizientes proprietäres Binärformat.

Endpunkt: /bin/layerreader

Ruft einen Data-Reader ab. Der Transport erfolgt über ein sehr effizientes proprietäres Binärformat.

In der IduIT.GeoLib.Net steht über die Klasse DataSerializer eine Implementierung eines System.Data.IDataReader für Zugriff auf diese Abfragen zur Verfügung.

Argumente (Form/Get):

• layer: Der Name der Ebene

Argumente (Http-Header):

• x-iwan-timeout-ms (30000): Timeout in Millisekunden

Status/Konfiguration

Endpunkt: /stat

Encoding: GET

Gibt Informationen zur Aktivität zurück (Anzahl Requests gesamt und aktuell)

{
 "current":1,
 "total":42,
 "globalInfo":"Läuft seit %i Minuten.\r\n22ms avg...",
 "totalPerEndPoint":{
	"/layer/load":12,
	"/stat": 10
 }
}

Wobei ... current : Aktuelle Anzahl aktiver Aufrufe total : Requests gesamt totalPerEndPoint: Map mit der relativem Endpunkt-Url als Schlüssel und der Anzahl der jeweiligen Aufrufe

Argumente:

- Keine -

Endpunkt: /config

Encoding: GET/POST (application/x-www-form-urlencoded)

Gibt die Laufzeitkonfiguration zurück oder legt diese fest.

{
 "traceLevel":"TraceError",
 "renderMode":"NoParallel",
 "renderEngine":"GdiPlus"
}

Argumente:

• traceLevel: Einer der Werte: TraceNone, TraceWarning, TraceError, TraceInfo, TraceDebug, TraceDetail,TraceDetailEx

• renderMode: Eine Kombination der Werte: NoParallel, RenderLayersParallel, UseVectorQueue,DebugRenderSkipVRendering

• renderEngine: GdiPlus, Direct2d oder Agge

Bsp.:

meinServer:8287/iwan/config?traceLevel=TraceError

Endpunkt: /json/writeConfig

Encoding: POST (application/json)

Endpunkt: /trace

Encoding: GET

Ruft das Trace-File als HTML Tabelle ab.

Argumente:

• rows (100): Anzahl der Zeilen

Endpunkt: json/trace

Encoding: GET

Ruft das Trace-File als JSON Array ab. 0 = Timestamp 1 = Error-Level 2 = ThreadId 3 = Message

Argumente:

• rows (100): Anzahl der Zeilen

Endpunkt: /traceSize

Encoding: GET

Ruft die Dateigröße des Trace-File ab. Ist kein Tracefile vorhanden, wird ein leerer String zurückgegeben.

Argumente:

• raw (false): Als Zahlenwert ausgeben, sonst als Dateigröße formatiert (1MB)

Endpunkt: /traceTruncate

Encoding: GET

Gibt true oder eine Exception zurück. Ist kein Tracefile vorhanden, wird ein leerer String zurückgegeben.

Endpunkt: json/tracemodify

Encoding: GET

Gibt ein JSON Objekt mit ...

{
    traceFileSize:number;
    traceLevel:TraceNone|TraceWarning|TraceError|TraceInfo| TraceDebug|TraceDetail|TraceDetailEx;
}

zurück. Optional kann übergeben werden truncate=true|false und TraceLevel=neuerLevel

Endpunkt: /activities/cancel

Encoding: GET/POST (application/x-www-form-urlencoded)

Sendet ein Abbruch-Signal an die Aktivität mit der angegebenen cancelId (muss ein INT64 sein). Gibt true oder false als Text zurück.

Argumente:

• cancelId: Id-der Aktivität

Endpunkt: /activities/cancelgroup

Encoding: GET/POST (application/x-www-form-urlencoded)

Sendet ein Abbruch-Signal an alle Aktivitäten-Gruppen mit der angegebenen cancelGroupToken. Gibt die Anzahl der abgebrochenen Vorgänge zurück.

Argumente:

• cancelGroupToken: Id der Aktivitätengruppe (entsprechend den im Http-Header x-iwan-activitygrouptoken übergebenem Wert bei der Anforderung)

Endpunkt: /json/parseSQL

Encoding: POST

Parst das im Body übergebene SQL und gibt als JSON Array die Struktur der Abfrage zurück.

In .Net gibt es im IduIT.Core.Mapping.MapServer.Iwan7Connector die Methode ...

 Iwan7.ParsedSQL.IParsedSQLStatement[] ParseSQLQueryUsingDuckDBsParser(string sql);
 

... mit welcher die Information strukturiert ausgewertet werden kann.

Für Debug-Zwecke stehen einige einfache HTML Formulare zur Verfügung: