Openscape Voice V10 - SOAP Interface Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Document Conventions

This page describes the conventions used throughout this document.

Conventions

Conventions used throughout this document.

Field Data Type

Notation Conventions

The following table summarizes the notation conventions used:

Notation Description
unsp__XXX Indicates that the class/structure member, enumeration, type definition or method is defined in the unsp web service namespace
XXX(YYY,ZZZ) XXX indicates a Web Service method. YYY indicates the request SOAP envelope, while ZZZ indicates the method's response
* Indicates a nillable class/structure member i.e. a structure or member that can be omitted from the SOAP envelope
XXX * __ptrYYY Indicates a list of XXX objects
XXX ** __ptrYYY Same as above
required When true indicates a field that must be provided, otherwise it may be empty or nill
default value [range] For integers and other numeric types, it describes the default value and valid range of the field. For strings it describes the default value and valid length.
int Numeric / Number
short Short Numeric / Number
long Long Numeric / Number
unsigned Unsigned Numeric / Number
bool Boolean (false/true)
enum Enumeration
char * Character String
class / struct XML Complex Type
Note
_ symbols in field definitions are replaced with - symbols in the Web Service interface. Please use - symbols instead.