Click or drag to resize

RaptorXML .NET API v2.8.3 documentation

Supported specifications

The RaptorXML+XBRL Server .NET API has support for the following specifications:

  • AVRO
  • JSON
  • JSON Schema
  • OASIS XML Catalogs 1.1
  • XML 1.0 and XML 1.1
  • XMLSchema 1.0 and XMLSchema 1.1
  • XBRL 2.1
  • XBRL Dimensions 1.0
  • XBRL Formula 1.0
  • XBRL Table 1.0
  • XBRL Extensible Enumerations 1.0 and 2.0
  • XBRL Generic Links 1.0
  • XBRL Generic Labels 1.0
  • XBRL Generic References 1.0
  • XBRL Generic Preferred Label 1.0
  • XBRL Units Registry 1.0
  • Inline XBRL 1.0 and 1.1
  • Taxonomy Packages 1.0
  • XPath 1.0, XPath 2.0 and XPath 3.1
  • XQuery 1.0 and XQuery 3.1
  • XSLT 1.0, XSLT 2.0 and XSLT 3.0

Getting Started

The RaptorXML+XBRL .NET API is provided as a .NET assembly that exposes the functionality of the installed RaptorXML+XBRL binaries. The RaptorXML+XBRL Server .NET API provides access the internal data model of Altova RaptorXML+XBRL Server for DTD, XML, XML Schema, XBRL and documents. To start using the RaptorXML+XBRL .NET API in a Visual Studio project, first add a reference to the Altova RaptorXML+XBRL .NET API assembly. This can be done using the Project | Add Reference... command. In the Reference Manager dialog select Extensions and then locate the Altova RaptorXML+XBRL .NET API entry.

The RaptorXML+XBRL .NET API requires the .NET Framework 4 or later. All classes and types provided by the RaptorXML+XBRL .NET API are located in the Altova.RaptorXml namespace and it's sub namespaces.

Examples
Use namespace aliases to avoid writing out the full namespace paths, e.g.:
C#
using Xml = Altova.RaptorXml.Xml;
using Xsd = Altova.RaptorXml.Xsd;
using Xbrl = Altova.RaptorXml.Xbrl;

To load XML, DTD, XSD or XBRL files use one of the following CreateFromUrl or CreateFromBuffer methods:

Examples
The following example illustrates the simplest method to load an XBRL instance:
C#
Altova.RaptorXml.ErrorLog errorLog;
var instance = Altova.RaptorXml.Xbrl.Instance.CreateFromUrl(@"C:\Data\instance.xbrl", out errorLog);
if (instance != null && !errorLog.HasErrors)
{
// Access the XBRL data model or XML Infoset
}
Examples
Example Visual Studio solutions for are installed within the examples folder of the RaptorXML+XBRL installation directory. Further examples are hosted on Altova's GitHub page.
Namespaces
NamespaceDescription
Altova.RaptorXml
The Altova.RaptorXml namespace contains core utility objects.
Altova.RaptorXml.Avro

The Altova.RaptorXml.Avro namespace provides a .NET API for the AVRO specification.

This .NET interface enables the user to navigate the AVRO instance document.

Altova.RaptorXml.Avro.Schema

The Altova.RaptorXml.Avro.Schema namespace provides a .NET API for the AVRO Schema specification.

This .NET interface enables the user to validate AVRO Schemas.

Altova.RaptorXml.Beta.XPath
The XPath namespace provides a C# API for the XPath 3.1 specification. This C# interface enables the user to compile an xpath expression and to execute it with different input data. The typical starting point would be the functions Compile(String, CompileOptions, ErrorLog) and Execute(RuntimeOptions, ErrorLog).
Altova.RaptorXml.Beta.XQuery
The XQuery namespace provides a C# API for the XQuery 3.1 specification. This C# interface enables the user to compile an xquery expression and to execute it with different input data. The typical starting point would be the functions Compile(ExpressionProvider, CompileOptions, ErrorLog) and Execute(RuntimeOptions, ErrorLog).
Altova.RaptorXml.Beta.Xslt
The Xslt namespace provides a C# API for the XSLT 3.0 specification. This C# interface enables the user to compile an xslt stylesheet and to execute it with different input data. The typical starting point would be the functions Compile(StylesheetProvider, CompileOptions, ErrorLog) and Execute(RuntimeOptions, ErrorLog).
Altova.RaptorXml.Json

The Altova.RaptorXml.Json namespace provides a .NET API for the JSON specification.

This .NET interface enables the user to navigate the JSON instance document.

Altova.RaptorXml.Json.Schema

The Altova.RaptorXml.Json.Schema namespace provides a .NET API for the JSON Schema specification.

This .NET interface enables the user to validate JSON Schemas.

Altova.RaptorXml.Pkg
 
Altova.RaptorXml.Xbrl

The Altova.RaptorXml.Xbrl namespace provides a .NET API for the XBRL 2.1 specification.

This .NET interface enables the user to navigate the XBRL instance document and access information from any fact item or tuple.

Altova.RaptorXml.Xbrl.Formula

The Altova.RaptorXml.Xbrl.Formula namespace provides a .NET API for the Formula 1.0 specifications.

This .NET interface enables the user to navigate the formula linkbase and access information from the formula-related resources.

Altova.RaptorXml.Xbrl.Table

The Altova.RaptorXml.Xbrl.Table namespace provides a .NET API for the Table Linkbase 1.0 specification.

This .NET interface enables the user to navigate the table linkbase and access information from the table-related resources.

Altova.RaptorXml.Xbrl.Table.Layout

The Altova.RaptorXml.Xbrl.Table.Layout namespace provides a .NET API for the Table Linkbase 1.0 specification.

This .NET interface enables the user to acccess the layout model.

Altova.RaptorXml.Xbrl.Table.Structural

The Altova.RaptorXml.Xbrl.Table.Structural namespace provides a .NET API for the Table Linkbase 1.0 specification.

This .NET interface enables the user to access the structural model.

Altova.RaptorXml.Xbrl.Taxonomy

The Altova.RaptorXml.Xbrl.Taxonomy namespace provides a .NET API for the XBRL 2.1 specification.

This .NET interface enables the user to navigate the DTS and its linkbases and taxonomy schemas and access information from concepts and the standard linkbases.

Altova.RaptorXml.Xbrl.Xdt

The Altova.RaptorXml.Xbrl.Xdt namespace provides a .NET API for the Dimensions 1.0 specification.

Altova.RaptorXml.Xml

The Altova.RaptorXml.Xml namespace provides a .NET interface for the XML 1.1 and XML Information Set specifications.

This .NET interface enables the user to navigate the XML document tree and access information from any XML node including

post-schema-validation infoset properties as described in the XML Schema specification.

Altova.RaptorXml.Xml.Dtd

The Altova.RaptorXml.Xml.Dtd namespace provides a .NET interface for the Document Type Declaration (DTD) in the XML 1.1 specification.

This .NET interface enables the user to navigate and access information from a DTD.

Altova.RaptorXml.Xsd

The Altova.RaptorXml.Xsd namespace provides a .NET interface for the XML Schema 1.1 Structure and XML Schema 1.1 Datatypes specifications.

This .NET interface enables the user to navigate and access the XML Schema document and its components.