4 Sample API Usage Application

A sample application, written in the C# language, is available to help you use the Import/Export Web Service. You can download the sample application from the Import/Export web site if you have valid Simphony credentials.

Resources Available for Download

The following table lists websites with sample applications available for downloading.

Table 4-1 Website Descriptions

Website Description

https://<home>/SimphonyApp/Help

Contains the link to download the sample application archive, in the Web API Downloads section.

http://<home>/ImportExportAPI/html/index.html

Contains the Data Contract specification for each API method of the Import/Export web service.

Summary of Sample Application

The main entry point to the sample application is the WebAPIExample.cs, which contains demo usages of different APIs of the Import/Export web service. In order to compile the sample app, you need to install the Newtonsoft JSON C# library (10.0.3 is the recommended version). Json.NET is a high-performance JSON framework for .NET. We refer the reader to download the same application to understand how to use the web service programmatically from a client.