OpenAir API

Overview

These public interfaces are used in OpenAir components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll and CozyRoc.NetSuite.dll libraries. Also include CozyRoc.SqlServer.SSIS, CozyRoc.NetSuite.OpenAir and CozyRoc.NetSuite.OpenAir.Service namespaces.

IConnection / IOpenAirConnection

When you call OpenAir Connection Manager AcquireConnection method, it returns object implementing IConnection interface. This is the interface used for interaction with OpenAir service.

Connect method

Connects to OpenAir service. The method result is object implementing OpenAir SOAP web services.

Close method

Closes the connection to OpenAir service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

GetTypeList method

Returns list of available OpenAir types.

GetCustomFields method (1.6 SR-2)

Get OpenAir type custom fields. The result is array of oaCustField objects. These are the method parameters:

  • type (string) – OpenAir type.

ConnectionType property (int)

Specify connection type. This property has the options listed in the following table.

Value Description
0 Connects to production instance of OpenAir service.
1 Connects to sandbox (testing) instance of OpenAir service.

ServerUser property (string)

Specify user name to access the OpenAir service.

ServerPassword property (string)

Specify user password to access the OpenAir service.

APINamespace property (string)

Specify API namespace to access the OpenAir service.

APIKey property (string)

Specify API key to access the OpenAir service.

Company property (string)

Specify company to access the OpenAir service.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.

RetainSameConnection property (bool)

Specify if all clients should use the same connection. This property has the options listed in the following table.

Value Description
True All clients use same connection (default).
False Every client uses different connection.

ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.