| Openscape Voice V10 - SOAP Interface Documentation

Document Conventions

This page describes the conventions used throughout this document.

# Conventions

Conventions used throughout this document.

## Field Data Type

- Numeric / Number: A numeric field
- Enumeration: A field that accepts a value from an enumerated list. Although XML allows the client to specify the corresponding numeric value to be passed instead of the enumerated text, passing of the numeric is discouraged.
- Character String: A string of any characters. Some fields have restrictions on the character set allowed. A validity check that compares any entered string parameters against the RTP parameter Srx/Main/InvalidStringChars is performed. If a parameter contains any characters that are in this string, the input request will be rejected with an appropriate error response. There is a general restriction that the comma (,) may not be included as a part of any string field due to the current implementation of Subscriber Mass Provisioning (soapMassProv), which uses commas as delimiters. The same applies to quote marks ("). Some fields do allow commas and/or quote marks, those fields indicate so in their descriptions.
- Numeric Character String: A character strings that accepts only numerics. This field type allows leading Zeros.
- Note that for each field the following definitions apply:
- * NA (Not Applicable): This means that the concept of a default value does not apply in this context. For example, if the field is not entered and is not required, it simply doesn't apply for the request, and thus there is no default. Also, where output fields are listed, this means that there is no default.
- * Required: This means that the field is mandatory in this context. Since some value must be provided in the request, there is no default.
- * "": The empty string, used for character string fields.
- * Any other entry in the Default Value represents the actual default value that is used.

## 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.