Usage Examples

This section of the website is to provide support for developers building solutions with XML-3. Below you will find example code predominantly for VB.Net, C#. This page will grow as we gain more knowledge of what techinques other developers are using to implement XML-3. The examples below are designed just to show you basic methods for successful connection and download of the XML responses and should not be treated as the only way to use our services. Each system requirement is different and will require different business logic applied to method calls. If you have any suggestions as to content that would be usefull on this page please dont hesitate to contact the EDI Implementation team with your ideas.


Authentication Usage

The authentication Login method is used to return a session ticket in its response. The session ticket is then used as part of the information included in the SOAP header for other methods within XML-3. The Login method does not require a SOAP header for its request. Below are some code examples of calls to the login method. Before making the calls you will need to add a reference to the Security web service.


The examples above show the Login method being used to get a session key. The session key that is returned is then stored into a global variable for use in later method calls. As another option, once the XML response is returned the ticket could be saved along with the expiry date into a database. You could also save the XML to a network share and load it when required. If you choose to save the session key it is advisable to also save and check the expiry date of the key before using it in other method calls.

Products Usage


The GetProducts method is used to return the product catalogue in its response. The catalogue it's self is a relational dataset containing two tables. Table 'Products' is the primary table containing basic product information for each item in the catalogue. The ProdID field is used to create a relationship between the second table 'Attributes'. The Attributes table contains the same ProdID field for each attribute contained within it to create referential integrity. Below are some code examples of how to make calls to the method. Before making the calls you will need to add a reference to the Products web service


XML-3 API Extension Dll


As part of the new XML-3 API, VIP have created a .Net extension DLL that implements our XML API directly. The DLL cuts out the need for the developer to use SOAP authentication or have to access the Web Methods directly. The DLL has been designed for use with ASP.net, PHP, WPF and Windows forms and it is free to download. All you need to start using it is a valid logon for the XML-3 API. For more information about the DLL please review the documentation from the links below.

Download Development Guide
Browse Technical Documentation
Download API Extension DLL