XML Schema and WSDL Definition Documents

This topic provides steps to generate and download the following reference documents:

• XML Schema Definitions

• Generic OpenAir WSDL Definition

• Account-Specific OpenAir WSDL Definition

Note:

The OpenAir WSDL definition is available with the following binding styles:

• rpc-encoded – Remote procedure call (rpc) style, encoded use.

• wrapped document-literal – Document style, literal use, wrapped. One advantage of the wrapped document-literal binding style is that everything in the SOAP body is described by the XML schema and can therefore be validated against XML schema definitions.

The wrapped document-literal WSDL supports the login(), read(), add(), createUser(), modify(), and delete() methods only.

XML Schema Definitions

OpenAir provides an XML schema for each business object type supported by the XML API.

Account administrators and users with the Export data role permission can use the following steps to download the account-specific OpenAir WSDL.

To download the XML schema definitions:

1. Go to Administration Global Settings > Account > Integration: Import/Export.

   You must be an account administrator or have the Export data role permission to access this page.

2. Click XSD schema files.

   OpenAir generates a ZIP archive containing XML schema definitions for each business object type supported by the XML API. A confirmation screen appears on completion.

3. Click the Click here link to download the ZIP archive to your computer

Generic OpenAir WSDL Definition

To view the generic OpenAir WSDL definition in your browser, enter one of the following URLs in the address bar. The URL you use depends on the OpenAir account type and the required WSDL binding style. You can then save the page to your computer to retain a local copy of the WSDL definition.

Account type	WSDL – rpc-encoded binding	WSDL – wrapped document-literal binding
Production	https://app.openair.com/wsdl.pl	https://app.openair.com/wsdl.pl?style=document
Sandbox	https://app.sandbox.openair.com/wsdl.pl	https://app.sandbox.openair.com/wsdl.pl?style=document

Account-Specific OpenAir WSDL Definition

The account-specific OpenAir WSDL definition includes custom fields defined for your account

Account administrators and users with the Export data role permission can use the following steps to generate the account-specific OpenAir WSDL.

To generate and save the account-specific OpenAir WSDL definition:

1. Go to Administration > Global Settings > Account > Integration: Import/Export.

2. Click Account specific WSDL.

   The rpc-encoded account-specific WSDL appears in a new browser tab.

3. (Optional) To generate the wrapped document-literal account-specific WSDL, append a semi-colon (;) and style=document to the URL in the address bar of your browser and press Enter.

4. Save the page to your computer to retain a local copy of the WSDL definition.