ReadObject Method

The CreateObject, ReadObject, UpdateObject and DeleteObject API methods provide access to the same resource-based programming model as used in the GeognoSIS HTTP API with a REST client.

Description

Reads data describing an object in the current SWD.

This is the GisLink and ActiveX equivalent of the HTTP API GET method.

Syntax

Visual Basic
Public Function ReadObject( _ ByVal url As String, _ ) As Integer

Parameters

url: The url of the object to be read.

Remarks

Available: D OD OM SISPy PySIS

Group:

HTTP API Methods

Examples

Dim props As String = mapobject.ReadObject (“sis://api/Map/Properties.json”)(1).ToString

Returns in props a JSON string describing the overlays in the current swd.

Further examples of responses from a url:

VB.Net

      Dim result As String = sis.ReadObject(url)(1).ToString

      object sisResult = _sis.ReadObject(url);
      string[] output = Array.ConvertAll((object[])sisResult, s => (string)s);
      string result = output[1];

Overlay 2 is AddressbasePlus in PostGIS

url	Response
sis://api.json	{"Data":{"Libraries":"api/Libraries.json", "Map":"api/Map.json"}, "Representations":"api", "Operations":"api.json?"}
sis://api/Map.json	{"Data":{"Overlays":"Map/Overlays.json", "Properties":"Map/Properties.json", "View":"Map/View.json"}, "Up":"../api.json", "Representations":"Map", "Operations":"Map.json?"}
sis://api/Map/Overlays.json	{"Data":["Overlays/0.json", "Overlays/1.json", "Overlays/2.json", "Overlays/3.json"], "Up":"../Map.json", "Representations":"Overlays",
sis://api/Map/Properties.json	{"Data":{"PropertyMap":{"_report$":{"SWD":{"PropertyMap":{"_crs$":"OSGB 1936.British National Grid","_epsg&":27700,"_loadTime#":6.36232323693094},"Overlays":[{"PropertyMap":{"_name$":"250k-mos.ecw","_scalemin#":5001,"_bBasemap&":true},"Dataset":{"PropertyMap":{"_name$":"C:\\SampleData\\ERMapper\\250k-mos.ecw","_DESC$":"DtsDll","_crs$":"OSGB 1936.British National Grid","_epsg&":27700,"_loadTime#":0.186008347778487}}},{"PropertyMap":{"_name$":"Ordnance Survey (GB) MasterMap Topography Layer","_scalemax#":5001,"_nTheme&":1},"Dataset":{"PropertyMap":{"_host$":"localhost","_port$":"5432","_database$":"postgis","_user$":"postgres","_table$":"mm8","_geometryColumn$":"geometry","_loadTime#":4.67621529361676}}},{"PropertyMap":{"_name$":"POSTGIS.POSTGRES.ADDRESSBASEPLUS.GEOMETRY","_scalemax#":5001},"Dataset":{"PropertyMap":{"_host$":"localhost","_port$":"5432","_database$":"postgis","_user$":"postgres","_table$":"addressbaseplus","_geometryColumn$":"geometry","_loadTime#":1.49525590730773}}},{"PropertyMap":{"_name$":"Internal"},"Dataset":{"PropertyMap":{"_loadTime#":0.00101496213849101}}}]}},"_bModified&":true,"_size@":{"ui8":"18874"},"_nOverlay&":4,"_crs$":"OSGB 1936.British National Grid","_projection$":"PROJCS[\"OSGB 1936.British National Grid\",GEOGCS[\"Latitude/Longitude.OGC.OSGB_1936\",DATUM[\"OSGB_1936\",SPHEROID[\"Airy 1830\",6377563.396,299.32496460007]],PRIMEM[\"Greenwich\",0],UNIT[\"degrees\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"Central_Meridian\",-2],PARAMETER[\"False_Easting\",400000],PARAMETER[\"False_Northing\",-100000],PARAMETER[\"Latitude_of_Origin\",49],PARAMETER[\"Scale_Factor\",0.9996012717],UNIT[\"m\",1]]","_epsg&":27700}}, "Up":"../Map.json", "Representations":"Properties", "Operations":"Properties.json?"}
sis://api/Map/View/Extent.json	{"Data":{"Min":[544022.194978778,280792.601148326,0],"Max":[544227.494023613,280979.785571558,0]}, "Up":"../View.json", "Representations":"Extent", "Operations":"Extent.json?"}
sis://api/Map/Overlays/2/Filter.txt	address$ Like "%WISTERIA%"