Openscape Voice V10 - SOAP Interface Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Classes | Typedefs | Enumerations
Common Definitions

Common Definitions. More...

Classes

struct  unsp__ResultCodeStruct
 Result Code structure. More...
 
class  unsp__ArrayOfString
 Array of Strings. More...
 
class  unsp__ArrayOfInt
 Array of Integers. More...
 
class  unsp__ArrayOfBoolean
 Array of Booleans. More...
 
struct  unsp__Paging
 Paging Request Structure. More...
 
struct  unsp__PaginatedInfo
 Paging Result Structure. More...
 

Typedefs

typedef char * unsp__EndpointProviderName
 Endpoint Provider Name. More...
 
typedef char * unsp__EndpointLocationName
 Endpoint Location Name. More...
 
typedef char * unsp__EndpointLocationCode
 Endpoint Location Code. More...
 
typedef char * unsp__RateAreaName
 Rate Area Name. More...
 
typedef char * unsp__LocalTollName
 Local Toll Name. More...
 
typedef char * unsp__COSName
 Class of Service Name. More...
 
typedef char * unsp__DestName
 Destination Name. More...
 
typedef char * unsp__EndpointName
 Endpoint Name. More...
 
typedef char * unsp__CFTarget
 Dialable Directory Number of Alphanumeric SIP URI. More...
 
typedef char * unsp__ScreenTarget
 A fully qualified national DN or Alphanumeric SIP URI. More...
 
typedef char * unsp__BOName
 Branch Office Name. More...
 
typedef char * unsp__CGName
 CAC Group Name. More...
 
typedef int xsd__int
 Integer. More...
 
typedef char * xsd__string
 String. More...
 
typedef bool xsd__boolean
 Boolean. More...
 
typedef char * xsd__dateTime
 DateTime in YYYY-MM-DDTHH:MM:SS format. More...
 
typedef char * xsd__time
 Time in HH:MM:SS format. More...
 
typedef short xsd__short
 Short Integer. More...
 
typedef long xsd__long
 Long Integer. More...
 
typedef double xsd__double
 Double. More...
 
typedef unsigned int xsd__unsignedInt
 Unsigned Integer. More...
 
typedef unsigned short xsd__unsignedShort
 Unsigned Short Integer. More...
 
typedef char * unsp__ServiceId
 Service Identity of a Subscriber. More...
 
typedef char * unsp__InterfaceWSDL
 The WSDL version supported be the client in order to support the desired backwards compatibility level. More...
 
typedef char * unsp__OperatorId
 Operator ID used for logging purposes. More...
 
typedef xsd__boolean unsp__Enabled
 A Boolean indicating if the feature's status is enabled (true) or not (false). More...
 
typedef char * unsp__BGName
 Business Group Name. More...
 
typedef char * unsp__DestCodeDigits
 Destination Code Digits. More...
 
typedef char * unsp__digits
 Digits. More...
 
typedef char * unsp__NumberPlanName
 Number Plan Name. More...
 
typedef char * unsp__locCode
 Location Code. More...
 
typedef char * unsp__DestServiceName
 Destination Service Name. More...
 
typedef char * unsp__FeatureProfileName
 Feature Profile Name. More...
 
typedef char * unsp__CodeIndexName
 Code Index Name. More...
 
typedef char * unsp__IPAddress
 IP Address. More...
 
typedef char * unsp__Language
 Language. More...
 
typedef char * unsp__LanguageCode
 Language Code. More...
 
typedef char * unsp__AuthCode
 Authorization Code. More...
 
typedef char * unsp__InterfaceName
 Link IP Address. More...
 
typedef char * unsp__LinkIPAddress
 CAC Interface Name. More...
 
typedef char * unsp__EAGroupName
 EA Group Name. More...
 
typedef char * unsp__DialedDigits
 Dialed Digits. More...
 
typedef char * unsp__CarrAccessCode
 Carrier Access Code. More...
 
typedef char * unsp__PatchSetName
 Patch Set Name. More...
 
typedef bool unsp__SubControl
 A boolean used to indicate if the feature is subscriber controlled (true) or not (false). More...
 
typedef char * unsp__TimeZone
 Timezone. More...
 
typedef wchar_t * unsp__BGDeptName
 Business Group Department Name. More...
 

Enumerations

enum  unsp__InterfaceRelease {
  Latest,
  Release6,
  Release8,
  Release9,
  Release10,
  Release10_1,
  Release10_2
}
 Allows supporting backwards compatibility according to the release indicated by the client. More...
 
enum  unsp__DOW {
  Sunday,
  Monday,
  Tuesday,
  Wednesday,
  Thursday,
  Friday,
  Saturday
}
 Day of Week. More...
 
enum  unsp__PrivacySupport {
  SipBasic,
  SipFull,
  SipFull_Send,
  SipFull_Receive
}
 Privacy Support Type. More...
 
enum  unsp__SIPSecSchemae {
  digest_authentication,
  no_security
}
 The Type of Security Scheme. More...
 
enum  unsp__SignalingType {
  SigIgnored = -3,
  SigUnused = -1,
  SigUnassigned = 1,
  SigIsup,
  SigPri,
  SigMgcp,
  SigH323,
  SigSip,
  SigSipt,
  SigCas,
  SigSipQ
}
 The Types of Signaling. More...
 
enum  unsp__BearerCaps {
  CapIgnored = -3,
  CapUnused = -1,
  CapUnassigned = 1,
  CapSpeech,
  CapAudio,
  CapData64KB,
  CapRateAdapted,
  Cap64KBPreffered
}
 The Types of Bearer Capability. More...
 
enum  unsp__Attributes {
  AtrUnused = -1,
  AtrNo,
  AtrYes
}
 Attribute. More...
 
enum  unsp__KeysetUse {
  KeysetUnassigned = -1,
  KeysetNone,
  KeysetPrimaryLine,
  KeysetPhantomLine
}
 Describes whether a DN is used for Keyset Operation, and if so, in what way. More...
 
enum  unsp__VIPType {
  VIPUnassigned = 0,
  VIPNo = 1,
  VIPYes = 2
}
 VIP Support Type. More...
 
enum  unsp__Anat {
  AnatUnassigned = -1,
  AnatAuto = 0,
  AnatOn = 1,
  AnatOff = 2
}
 ANAT Support Type. More...
 
enum  unsp__ImpactLevel {
  ImpactLevelZero = 0,
  ImpactLevelOne,
  ImpactLevelTwo,
  ImpactLevelThree,
  ImpactLevelFour,
  ImpactLevelFive,
  ImpactLevelSix,
  ImpactLevelSeven,
  ImpactLevelEight,
  ImpactLevelNine,
  ImpactLevelUnclassified
}
 Impact Level. More...
 
enum  unsp__ICESupport {
  ICEUnassigned = -1,
  ICEAutomatic,
  ICEEnabled,
  ICEDisabled
}
 ICE Support Type. More...
 
enum  unsp__AEISupport {
  AEIUnassigned = -1,
  AEIAuto,
  AEIOn,
  AEIOff
}
 AEI Support Type. More...
 
enum  unsp__DTLSSupport {
  DTLSUnassigned = -1,
  DTLSAuto,
  DTLSOn,
  DTLSOff
}
 DTLS Support Type. More...
 
enum  unsp__SipUAForkingSupport {
  SipUAForkingUnassigned = -1,
  SipUAForkingAuto,
  SipUAForkingFull,
  SipUAForkingNone,
  SipUAForkingDisabled
}
 Sip UA Forking Support Type. More...
 
enum  unsp__SrtpMode {
  SrtpModeUnassigned = -1,
  SrtpModeAuto,
  SrtpModeEnabled,
  SrtpMode1mLine,
  SrtpMode2mLine,
  SrtpModeSRTPOnly,
  SrtpModeDisabled
}
 SRTP Mode. More...
 
enum  unsp__TransportType {
  TtIgnored = -3,
  TtUnused = -2,
  TtUnassigned = -1,
  TtUndefined,
  TtUdp = 1,
  TtTcp = 2,
  TtTls = 4,
  TtMtls = 8
}
 Transport Type. More...
 
enum  unsp__UsageType {
  UndefinedUsageType,
  Subscriber,
  EndpointProfile
}
 Object Usage Type. More...
 
enum  unsp__Subscribed {
  Ignore,
  AddReplace,
  Inherited,
  Delete,
  Denied,
  SwitchWide,
  Modify
}
 Indicates the action to be taken for the service feature. More...
 
enum  unsp__SortOrder {
  SortOrderAscending,
  SortOrderDescending
}
 Indicates the desired Sort Order. More...
 
enum  unsp__SrtpSupport {
  SrtpUnassigned = -1,
  SrtpAutomatic,
  SrtpEnabled,
  SrtpDisabled
}
 SRTP Support Type. More...
 
enum  unsp__SortType {
  StUnassigned = -1,
  StReference,
  StDestnation
}
 Sort Type. More...
 
enum  unsp__DestCodeDt {
  DestCodeDtIgnored = -3,
  DestCodeDtUnused = -1,
  DestCodeDtNone = 1,
  DestCodeDtDest = 5,
  DestCodeDtSvc = 7,
  DestCodeDtHomeDn = 14,
  DestCodeDtEnum = 16,
  DestCodeDtIntcpt = 17,
  DestCodeDtTod = 19
}
 Destination Code Destination Type. More...
 
enum  unsp__E164NatureOfAddr {
  NoaIgnored = -3,
  NoaUnused = -2,
  NoaUnassigned = -1,
  NoaUndefined,
  NoaUnkown,
  NoaSubs,
  NoaNatl,
  NoaIntl,
  NoaLrn,
  NoaNw,
  NoaPrfxBased,
  NoaNoDn,
  NoaTest,
  NoaL0 = 22,
  NoaL1,
  NoaL2,
  NoaExt,
  NoaPrfxBasedNoTns,
  NoaCallingLoc
}
 Nature of Address. More...
 
enum  unsp__DestinationType {
  DtIgnored = -3,
  DtUnused = -1,
  DtUnassigned = 1,
  DtTrk,
  DtGw,
  DtGatekeeper,
  DtDest,
  DtEp,
  DtSvc,
  DtPri,
  DtSubsDn,
  DtLn,
  DtTrkCircuit,
  DtMediaGateway,
  DtVacant,
  DtHomeDn,
  DtDndIsConn,
  DtEnum,
  DtIntcpt,
  DtInvalidCode,
  DtTod,
  DtE164Dest,
  DtNumberPlan,
  DtHomeExt,
  DtHomeLoc,
  DtCallingLoc,
  DtOrigDestCarr,
  DtOrigDestMs,
  DtCarrierDest,
  DtProfileOnly = 33
}
 Destination Type. More...
 
enum  unsp__NodeVariant {
  NodeVariantUnassigned = -1,
  NodeVariantNone,
  NodeVariantA7,
  NodeVariantA7M3UA = 9
}
 Node Variant. More...
 
enum  unsp__YesNo {
  YnYes = 1,
  YnNo = 0,
  YnUndefined = -1
}
 Yes/No. More...
 
enum  unsp__AccountAuth {
  AccountAuthUnused = -1,
  AccountAuthUnassigned = 1,
  AccountAuthBasedOnSub,
  AccountAuthBasedOnEp,
  AccountAuthNoServices
}
 Account Authentication Type. More...
 
enum  unsp__DnModifyType {
  MtIgnored = -3,
  MtUnused = -1,
  MtUnassigned = 1,
  MtAssign = 2,
  MtUnassign,
  MtModify
}
 Modify Type. More...
 

Detailed Description

Common Definitions.

This sections includes common definitions used throughout this document.

Typedef Documentation

typedef char * unsp__AuthCode

Authorization Code.

typedef char * unsp__BGDeptName

Business Group Department Name.


default value[range]: NA [1..20]

typedef char * unsp__BGName

Business Group Name.


default value[range]: 1..30

typedef char * unsp__BOName

Branch Office Name.


default value[range]: NA [1..30]

typedef char * unsp__CarrAccessCode

Carrier Access Code.

typedef char * unsp__CFTarget

Dialable Directory Number of Alphanumeric SIP URI.


default value[range]: NA [1..30] for DNs, [1..127] for SIP URIs.

typedef char * unsp__CGName

CAC Group Name.


default value[range]: NA [1..30]

typedef char * unsp__CodeIndexName

Code Index Name.

typedef char * unsp__COSName

Class of Service Name.


default value[range]: NA [1..15]

typedef char * unsp__DestCodeDigits

Destination Code Digits.

typedef char * unsp__DestName

Destination Name.


default value[range]: NA [1..15]

typedef char * unsp__DestServiceName

Destination Service Name.

typedef char * unsp__DialedDigits

Dialed Digits.

typedef char * unsp__digits

Digits.

typedef char * unsp__EAGroupName

EA Group Name.


default value[range]: NA [1..254]

A Boolean indicating if the feature's status is enabled (true) or not (false).

Endpoint Location Code.


default value[range]: NA [1..6]

Endpoint Location Name.


default value[range]: NA [1..15]

typedef char * unsp__EndpointName

Endpoint Name.


default value[range]: NA [1..15]

Endpoint Provider Name.


default value[range]: NA [1..12]

typedef char * unsp__FeatureProfileName

Feature Profile Name.

typedef char * unsp__InterfaceName

Link IP Address.


default value[range]: NA [1..255]

typedef char * unsp__InterfaceWSDL

The WSDL version supported be the client in order to support the desired backwards compatibility level.

typedef char * unsp__IPAddress

IP Address.

typedef char * unsp__Language

Language.

typedef char * unsp__LanguageCode

Language Code.

typedef char * unsp__LinkIPAddress

CAC Interface Name.


default value[range]: NA [6..30]

typedef char * unsp__LocalTollName

Local Toll Name.


default value[range]: NA [1..30]

typedef char * unsp__locCode

Location Code.

typedef char * unsp__NumberPlanName

Number Plan Name.


default value[range]: 1..31

typedef char * unsp__OperatorId

Operator ID used for logging purposes.


required: true.
default value[range]: NA [1..39]

typedef char * unsp__PatchSetName

Patch Set Name.

typedef char * unsp__RateAreaName

Rate Area Name.


default value[range]: NA [1..15]

typedef char * unsp__ScreenTarget

A fully qualified national DN or Alphanumeric SIP URI.


default value[range]: NA [1..15] for DNs, [1..127] for SIP URIs.

typedef char * unsp__ServiceId

Service Identity of a Subscriber.

Only numbers are allowed.
default value[range]: NA [1..15]

typedef bool unsp__SubControl

A boolean used to indicate if the feature is subscriber controlled (true) or not (false).

typedef char * unsp__TimeZone

Timezone.

Specifies the time zone location and determines how the time-dependent services work. In general, most subscribers will be in the switch's local time zone, but SIP phones can be anywhere and the switch could border a time zone edge and serve multiple time zones.
default value[range]: "Local"

typedef bool xsd__boolean

Boolean.

typedef char * xsd__dateTime

DateTime in YYYY-MM-DDTHH:MM:SS format.

typedef double xsd__double

Double.

typedef int xsd__int

Integer.

typedef long xsd__long

Long Integer.

typedef short xsd__short

Short Integer.

typedef char * xsd__string

String.

typedef int xsd__time

Time in HH:MM:SS format.

typedef unsigned int xsd__unsignedInt

Unsigned Integer.

typedef unsigned short xsd__unsignedShort

Unsigned Short Integer.

Enumeration Type Documentation

Account Authentication Type.

Enumerator
AccountAuthUnused 

Unused.

AccountAuthUnassigned 

Unassigned.

AccountAuthBasedOnSub 

Based on Subscriber.

AccountAuthBasedOnEp 

Based on Endpoint.

AccountAuthNoServices 
Deprecated:
NA

AEI Support Type.

Enumerator
AEIUnassigned 

Unassigned.

AEIAuto 

Automatic.

AEIOn 

On.

AEIOff 

Off.

enum unsp__Anat

ANAT Support Type.

Enumerator
AnatUnassigned 

Unassigned.

AnatAuto 

Automatic.

AnatOn 

On.

AnatOff 

Off.

Attribute.

Enumerator
AtrUnused 

Unused.

AtrNo 

No.

AtrYes 

Yes.

The Types of Bearer Capability.

Enumerator
CapIgnored 

Ignored.

CapUnused 

Unused.

CapUnassigned 

Unassigned.

CapSpeech 
Deprecated:
NA
CapAudio 
Deprecated:
NA
CapData64KB 

Data 64 KB.

CapRateAdapted 
Deprecated:
NA
Cap64KBPreffered 
Deprecated:
NA

Destination Code Destination Type.

Enumerator
DestCodeDtIgnored 

Ignored.

DestCodeDtUnused 

Unused.

DestCodeDtNone 

None.

DestCodeDtDest 

Destination.

DestCodeDtSvc 

Service.

DestCodeDtHomeDn 

Home DN.

DestCodeDtEnum 

Enum.

DestCodeDtIntcpt 

Intercept.

DestCodeDtTod 

Tod.

Destination Type.

Enumerator
DtIgnored 

Ignored.

DtUnused 

Unused.

DtUnassigned 

Unassigned.

DtTrk 
Deprecated:
NA
DtGw 
Deprecated:
NA
DtGatekeeper 
Deprecated:
NA
DtDest 

Destination.

DtEp 

Endpoint.

DtSvc 

Service.

DtPri 

Pri.

DtSubsDn 

Subscriber Dn.

DtLn 

Ln.

DtTrkCircuit 

Trk Cicuit.

DtMediaGateway 

Media Gateway.

DtVacant 

Vacant.

DtHomeDn 

Home Dn.

DtDndIsConn 

Disconnected.

DtEnum 

Enum.

DtIntcpt 

Intercept.

DtInvalidCode 

Invalid Code.

DtTod 

Tod.

DtE164Dest 

E164 Destination.

DtNumberPlan 

Number Plan.

DtHomeExt 

Home Extension.

DtHomeLoc 

Home Location.

DtCallingLoc 

Calling Location.

DtOrigDestCarr 

Carrier Origin Destination.

DtOrigDestMs 

Media Server.

DtCarrierDest 

Carrier Destination.

DtProfileOnly 

Profile-Only Subscriber.

Modify Type.

Enumerator
MtIgnored 

Ignored.

MtUnused 

Unused.

MtUnassigned 

Unassigned.

MtAssign 

Assign.

MtUnassign 

Unassign.

MtModify 

Modify.

enum unsp__DOW

Day of Week.

Enumerator
Sunday 

Sunday.

Monday 

Monday.

Tuesday 

Tuesday.

Wednesday 

Wednesday.

Thursday 

Thursday.

Friday 

Friday.

Saturday 

Saturday.

DTLS Support Type.

Enumerator
DTLSUnassigned 

Unassigned.

DTLSAuto 

Automatic.

DTLSOn 

Enabled.

DTLSOff 

Disabled.

Nature of Address.

Enumerator
NoaIgnored 

Ignored.

NoaUnused 

Unused.

NoaUnassigned 

Unassigned.

NoaUndefined 

Undefined.

NoaUnkown 

Unknown.

NoaSubs 

Subscriber.

NoaNatl 

National.

NoaIntl 

International.

NoaLrn 

Lrm.

NoaNw 

Network.

NoaPrfxBased 

Prefix Based.

NoaNoDn 

No Dn.

NoaTest 

Test.

NoaL0 

L0.

NoaL1 

L1.

NoaL2 

L2.

NoaExt 

extension

NoaPrfxBasedNoTns 

Prefix Based No Tns.

NoaCallingLoc 

Calling Location.

ICE Support Type.

Enumerator
ICEUnassigned 

Unassigned.

ICEAutomatic 

Automatic.

ICEEnabled 

Enabled.

ICEDisabled 

Disabled.

Impact Level.

Enumerator
ImpactLevelZero 

0

ImpactLevelOne 

1

ImpactLevelTwo 

2

ImpactLevelThree 

3

ImpactLevelFour 

4

ImpactLevelFive 

5

ImpactLevelSix 

6

ImpactLevelSeven 

7

ImpactLevelEight 

8

ImpactLevelNine 

9

ImpactLevelUnclassified 

Unclassified.

Allows supporting backwards compatibility according to the release indicated by the client.

Enumerator
Latest 

Latest Release.

Release6 
Deprecated:
NA
Release8 
Deprecated:
NA
Release9 
Deprecated:
NA
Release10 
Deprecated:
NA
Release10_1 
Deprecated:
NA
Release10_2 
Deprecated:
NA

Describes whether a DN is used for Keyset Operation, and if so, in what way.

Enumerator
KeysetUnassigned 

Unassigned.

KeysetNone 

Indicates that the subscriber DN is not used for Keyset Operation and no additional keyset-related attributes will apply.

KeysetPrimaryLine 

Indicates that the subscriber DN is used as the Primary Line for a keyset, where primary line is defined as the first line to register from a given SIP endpoint and the line used by default when no secondary line key is pressed.

KeysetPhantomLine 

Indicates that the subscriber DN is used as a Phantom Line for one or more keyset where Phantom Line is defined as a line that does not appear as a Primary Line on any keyset, but may have an appearance as a Secondary Line on one or more keysets.

Node Variant.

Enumerator
NodeVariantUnassigned 

Unassigned.

NodeVariantNone 

None.

NodeVariantA7 

A7.

NodeVariantA7M3UA 

A7M3UA.

Privacy Support Type.

Enumerator
SipBasic 

SIP Basic.

SipFull 

SIP Full.

SipFull_Send 

SIP Full Send.

SipFull_Receive 

SIP Full Receive.

The Types of Signaling.

Enumerator
SigIgnored 

Ignored.

SigUnused 

Unused.

SigUnassigned 

Unassigned.

SigIsup 
Deprecated:
NA
SigPri 
Deprecated:
NA
SigMgcp 
Deprecated:
NA
SigH323 
Deprecated:
NA
SigSip 

SIP.

SigSipt 
Deprecated:
NA
SigCas 

SIP Q.

SigSipQ 
Deprecated:
NA

The Type of Security Scheme.

Enumerator
digest_authentication 

Digest Authentication.

no_security 

No Security.

Sip UA Forking Support Type.

Enumerator
SipUAForkingUnassigned 

Unassigned.

SipUAForkingAuto 

Automatic.

SipUAForkingFull 

Full.

SipUAForkingNone 

None.

SipUAForkingDisabled 

Disabled.

Indicates the desired Sort Order.

Enumerator
SortOrderAscending 

Ascending.

SortOrderDescending 

Descending.

Sort Type.

Enumerator
StUnassigned 

Unassigned.

StReference 

Reference.

StDestnation 

Destination.

SRTP Mode.

Enumerator
SrtpModeUnassigned 

Unassigned.

SrtpModeAuto 

Automatic.

SrtpModeEnabled 

Enabled.

SrtpMode1mLine 

1 m-line

SrtpMode2mLine 

2 m-line

SrtpModeSRTPOnly 

SRTP only.

SrtpModeDisabled 

Disabled.

SRTP Support Type.

Enumerator
SrtpUnassigned 

Unassigned.

SrtpAutomatic 

Automatic.

SrtpEnabled 

Enabled.

SrtpDisabled 

Disabled.

Indicates the action to be taken for the service feature.

Enumerator
Ignore 

Skip this feature/no action.

AddReplace 

Add this feature and/or replace any existing definition of the feature that the subscriber might have.

When a feature is AddReplace, the complete feature-specific data must be specified; missing fields will be assigned with their default values.

Inherited 

Indicates that the feature data are inherited by the Feature Profile assigned to the object.


Read Only

Delete 

Remove the feature from the subscriber.

Inherited features may not be removed, although they may be denied.

Denied 

Deny this feature to the subscriber.

Do not allow the subscriber to inherit the feature from a Feature Profile.

SwitchWide 

Indicates that the feature is set switch wide and thus all subscribers have access to it.


Read Only

Modify 

The feature must already exist from either being previously provisioned at the Feature Profile Level (and inherited) or provisioned directly.

Only the fields listed are modified. The local presence fields may be sent to reset overrides for fields.

Transport Type.

Enumerator
TtIgnored 

Ignored.

TtUnused 

Unused.

TtUnassigned 

Unassigned.

TtUndefined 

Undefined.

TtUdp 

UDP.

TtTcp 

TCP.

TtTls 

TLS.

TtMtls 

MTLS.

Object Usage Type.

Enumerator
UndefinedUsageType 

Undefined.

Subscriber 

Used by Subscriber(s)

EndpointProfile 

Used by Endpoint Profile(s)

VIP Support Type.

Enumerator
VIPUnassigned 

Unassigned.

VIPNo 

No.

VIPYes 

Yes.

Yes/No.

Enumerator
YnYes 

Yes.

YnNo 

No.

YnUndefined 

Undefined.