OrfService.asmx - Modul ORF

Webservice für das Modul Orf - ObjectReferences. Alle Aufrufe setzen das Recht SU voraus.

Der Dienst kann direkt aufgerufen werden über die Adresse:

http://ihrServer/net3/services/orfservice.asmx


Folgende Vorgänge werden unterstützt. Eine ausführliche Definition finden Sie in der Dienstbeschreibung.

AttachDocumentToRecord

Erstellt oder aktualisiert eine Georeferenz und weist ein Dokument zu.
Ist das Dokument bereits vorhanden, wird es aktualisiert.

  • documentTypeUniqueId: die ID des Dokument-Type (siehe UniqueId in GetAllDocumentTypes)
  • documentContent: der für den Dokumenttype gültige Inhalt (bei Pzl. z. B. die Node-Id)
  • storeUniqueId: die id des Datenspeichers (siehe UniqueId in GetRegisteredOrfStores)
  • sourceIdInStore: die Id des zu referenzierenden Datensatzes im Speicher storeUniqueId
  • makePrivate: der Datensatz wird exklusiv dem Dokument zugewiesen

 

AttachDocumentToRecordByFilter
Erstellt oder aktualisiert Georeferenzen und weist diese dem Dokument zu.
Ist das Dokument bereits vorhanden, wird es aktualisiert.

  • documentTypeUniqueId: die Id des Dokument-Type (siehe UniqueId in GetAllDocumentTypes)
  • documentContent: der für den Dokumenttype gültige Inhalt (bei Pzl. z.B. die Node-Id)
  • storeUniqueId: die id des Datenspeichers (siehe UniqueId in GetRegisteredOrfStores)
  • filterXml: ein Filter der in der Datenquelle ausgeführt wird, für das Beschaffen der Datensätze. Der Filter muss ein Element ButtonComparision aus dem Namespace http://schemas.webs.idu.de/cardo3/Button sein.
  • makePrivate: der Datensatz wird exklusiv dem Dokument zugewiesen

 

DetachDocumentFromAllRecord: Löscht alle Instanzen des angegebenen Dokumentes. Zurückgegeben werden die IDs der gelöschten Dokumente

  • documentTypeUniqueId: die ID des Dokument-Type (siehe UniqueId in GetAllDocumentTypes)
  • documentContent: der für den Dokument-Type gültige Inhalt (bei Pzl. z. B. die Node-Id)
  • deleteRefRecordIfEmpty Wenn der Record danach keine Dokumente mehr hat, diesen auch löschen

 

DetachDocumentFromRecord: Löscht ein Dokument für die angegebene Georeferenz. Zurückgegeben wird die Id des gelöschten Dokumentes.

  • documentTypeUniqueId: die Id des Dokument-Type (siehe UniqueId in GetAllDocumentTypes)
  • documentContent: der für den Dokumenttype gültige Inhalt (bei Pzl. z. B. die "ikxStoreId:Node-Id")
  • storeUniqueId: die id des Datenspeichers (siehe UniqueId in GetRegisteredOrfStores)
  • sourceIdInStore: die Id des zu referenzierenden Datensatzes im Speicher storeUniqueId
  • deleteRefRecordIfEmpty Wenn der Record danach keine Dokumente mehr hat, diesen auch löschen

ExistsRecord: Überprüfen ob ein Record für eine SourceId existiert.

GetAllDocumentTypes: Ruft alle aktuell registrierten Dokumenttypen ab.

GetDocumentsForRecord: Ruft alle Dokumente ab, denen der angegebene Record zugeordnet ist.

GetRecordsAndDocuments: Ruft alle Records und Dokumente gefiltert mit der angegebenen Geometrie ab.

GetRecordsForDocument: Ruft alle Records ab, denen das angegebene Dokument zugeordnet ist.

GetRegisteredOrfStores: Ruft alle definierten Datenspeicher für externe Dokumente ab.

RegisterOrUpdateBuildinDocumentTyp: Registriert den GenericContentDocumentType.

RegisterOrUpdatePuzzleDocumentTyp: Registriert oder aktualisiert einen Dokument-Type Handler für cardo Puzzle.

RegisterOrUpdateVISDocumentTyp: Registriert oder aktualisiert einen Dokument-Type Handler für VIS Kompakt.
Der Host+Port Teil der Url wird zum Bestandteil des Key des Dokumententyps.

UseDefaultProxy: Für den Zugriff auf VisKompakt kann der cardo Standardproxy verwendet werden. Diese Eigenschaft ist hier zu aktivieren.

ResyncStoreRecords 

Aktualisiert alle Orf-Records. Generiert unter anderem den Titel neu.

RegisterOrfLayerStore

Registriert eine Ebene für die Verwendung als Datenspeicher für externe Dokumente. Eine Lizenz für das Modul cardo.Orf wird benötigt.

  • sourceId - SourceID der Ebene
    Bsp.: Ebene L663 -> 663
  • idColumnName - Name der Spalte mit dem eindeutigen, dauerhaften Identifikator
    Bsp.: OBJECTID
  • displayColumnName - optionale, kommagetrennte Spaltennamen für die Generierung des Datensatz-Titels
    Bsp.: NAME
  • displayColumnFormat - optional, ein Formatstring (C# String.Format), welche für die Titelgenerierung verwendet werden soll; kann die in displayColumnName angegebenen Spalten referenzieren in der Form {0},{1},... wobei die Zahl der Index aus displayColumnName ist
    Bsp.:
    displayColumnName: gewaesser_name,abschnitt
    displayColumnFormat: Gewässername "{0}" Abschnitt "{1}"
  • searchRadius: Standard-Suchradius für diese Ebene in Metern