C# Example for REST API
Your RaptorXML+XBRL Server installation contains a C# project that accesses RaptorXML+XBRL Server's REST client interface to execute a set of jobs. The example project consists of two parts:
•RaptorXMLREST.cs: A wrapper class in C# that implements the REST mechanism to communicate with RaptorXML+XBRL Server via HTTP.
•Program.cs: The C# program code that defines the jobs to be sent to RaptorXML+XBRL Server via the REST wrapper.
These two parts are described in the subsections of this section: C# Wrapper for REST API and Program Code for REST Requests.
Note that you can use any suitable REST wrapper for C# code. The main reason that we have created our own wrapper is so that the C# program code can be more tightly integrated with the wrapper class, thereby making an understanding of RaptorXML+XBRL Server's REST interface easier.
Location and use of the C# example
The example project is located in the folder C:\Program Files (x86)\Altova\RaptorXML+XBRL Server2024\examples\REST_API\C#_RaptorREST_API.
The example project was created using Visual Studio 2019, so you should use this version or later to build and run the project. Note that the C# example files are located in the Program Files folder, so you will need to open Visual Studio with administrator rights in order to access the files. Alternatively, you can copy the example project to another location and make relevant amendments to the project.