Accessing the WSDL

Once web services have been enabled and configured, the next implementation step is to access the WSDL, which describes both the data schema as well as the full set of available operations. The WSDL is primarily intended for use by client applications that use the metadata to automatically generate interfaces to the web services. Since the WSDL is simply an XML document, it can also be viewed in a browser for verification purposes.

Each site has its own WSDL. You can access the WSDL for your site by following these steps:

  1. Look at the URL where normally log in to Luminate Online as a site administrator.
  2. Identify your cluster by looking at the hostname in the admin URL. If you log in to secure2.convio.net, you are on cluster 2; if you log in to secure3.convio.net, you are on cluster 3.
  3. Identify your site short name by looking at the first part of the URL path after the hostname. For example, if you normally log in to https://secure3.convio.net/myorg/admin/AdminLogin , then your site short name is myorg .
  4. Open a new browser window and enter the URL of your site WSDL as https://webservices.cluster[2 or 3].convio.net/1.0/[site short code]/wsdl
  5. Your browser should display a long XML document.

The WSDL for a particular site is unique in at least three ways:

  1. The Constituent element in the WSDL schema reflects the current database configuration for a site. The WSDL only includes constituent fields that are enabled and visible to admins. This includes all custom fields.
  2. The Donation element in the WSDL schema has any custom fields that have been added to donation forms.
  3. The WSDL defines an "endpoint" URL for accessing the actual web services. Each site has its own endpoint URL.

Leave a Comment

Nickname
Comment
Enter this word: