Cloud Fax and Notifications API 2.5 Documentation
Introduction
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  Introduction  
These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.
 

1.3 Schemas and Tables

These pages include tables that describe the elements of the XML documents that are used in Cloud Fax and Notifications API requests and responses. The schema is the actual authority, but it can be difficult to read, and these tables attempt to show the structure of the final documents, skipping some of the intermediate type definitions.

Special attention should be paid to the "#" column of these tables, which indicates the number of the particular element that may occur. The values in this column should be interpreted as follows:

#Description
1required element, and only one is allowed
1-required element, there must be at least one, but there may be more
0-1optional element, but no more than one allowed
0-optional element, any number may appear

The elements are arranged in indented columns to indicate the hierarchy within the XML document - child elements appear indented under the parent element. The tooltip associated with the empty columns shows the full path of the parent element.

Choices in the XML are indicated by a blue-shaded column to the immediate left of the elements which may be selected. Only one of the choice elements may be used.

In some cases the entire "Choice" structure is optional, which is indicated by a dotted line on the diagram and a violet-shaded column to the immediate left of the elements which may be selected. This means that none of the choice elements may be present, but if one of them is present, it may have required child elements which will be marked "1" or "1-" in the table.

 
    prev  next        Table of Contents  Introduction  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020