Documentation for PBXMessagesInfo

Target Namespace	http://4psa.com/PBXData.xsd/2.0.0
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations have no namespace.
Schema Composition	This schema imports schema(s) from the following namespace(s): http://4psa.com/Common.xsd/2.0.0 (at ../Common.xsd)

Prefix	Namespace
Default namespace	http://4psa.com/PBXData.xsd/2.0.0
xml	http://www.w3.org/XML/1998/namespace
mstns	http://4psa.com/PBXData.xsd/2.0.0
xs	http://www.w3.org/2001/XMLSchema
common	http://4psa.com/Common.xsd/2.0.0

Super-types:	None
Sub-types:	CustomButton (by extension)

Name	CustomAlert
Abstract	no
Documentation	Custom alert data

XML Instance Representation

<...>

<mstns:code> common:string </mstns:code> [0..1]

<mstns:text> common:string </mstns:text> [0..1]

<mstns:priority> common:integer </mstns:priority> [0..1]

<mstns:displayMethod> xs:string (value comes from list: {'inherit'|'select'}) </mstns:displayMethod> [0..1]

'Possible values: inherit, select. Display method'

<mstns:displayLevel> xs:string (value comes from list: {'0'|'1'|'2'|'3'|'10'|'50'|'100'}) </mstns:displayLevel> [0..1]

'Inheritance level /Display to level. Possible values: 10-reseller, 50-client, 100-endpoint for displayMethod:select, 0-3 for displayMethod:inherit.'

<mstns:displayToOwner> common:boolean </mstns:displayToOwner> [0..1]

'Display on owner account'

<mstns:expiration> common:unlimitedDate </mstns:expiration> [0..1]

'Custom button expiration date'

</...>

Schema Component Representation

<xs:complexType name="CustomAlert">

<xs:sequence>

<xs:element name="code" type=" common:string " minOccurs="0"/>

<xs:element name="text" type=" common:string " minOccurs="0"/>

<xs:element name="priority" type=" common:integer " minOccurs="0"/>

<xs:element name="displayMethod" default="inherit" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="inherit"/>

<xs:enumeration value="select"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="displayLevel" default="0" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="0"/>

<xs:enumeration value="1"/>

<xs:enumeration value="2"/>

<xs:enumeration value="3"/>

<xs:enumeration value="10"/>

<xs:enumeration value="50"/>

<xs:enumeration value="100"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="displayToOwner" type=" common:boolean " default="true" minOccurs="0"/>

<xs:element name="expiration" type=" common:unlimitedDate " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: CustomButton

Super-types:	CustomAlert < CustomButton (by extension)
Sub-types:	None

Name	CustomButton
Abstract	no
Documentation	Custom button data

XML Instance Representation

<...>

<mstns:code> common:string </mstns:code> [0..1]

<mstns:text> common:string </mstns:text> [0..1]

<mstns:priority> common:integer </mstns:priority> [0..1]

<mstns:displayMethod> xs:string (value comes from list: {'inherit'|'select'}) </mstns:displayMethod> [0..1]

'Possible values: inherit, select. Display method'

<mstns:displayLevel> xs:string (value comes from list: {'0'|'1'|'2'|'3'|'10'|'50'|'100'}) </mstns:displayLevel> [0..1]

'Inheritance level /Display to level. Possible values: 10-reseller, 50-client, 100-endpoint for displayMethod:select, 0-3 for displayMethod:inherit.'

<mstns:displayToOwner> common:boolean </mstns:displayToOwner> [0..1]

'Display on owner account'

<mstns:expiration> common:unlimitedDate </mstns:expiration> [0..1]

'Custom button expiration date'

<mstns:URL> common:domain </mstns:URL> [0..1]

<mstns:location> xs:string (value comes from list: {'navigation'|'content'}) </mstns:location> [0..1]

'Possible values: navigation, content.'

<mstns:action> xs:string (value comes from list: {'newWindow'|'currentWindow'}) </mstns:action> [0..1]

'Possible values: newWindow, currentWindow.'

<mstns:includeResellerID> common:boolean </mstns:includeResellerID> [0..1]

'Include reseller ID: reseller_id'

<mstns:includeClientID> common:boolean </mstns:includeClientID> [0..1]

'Include client ID: client_id'

<mstns:includeEndpointID> common:boolean </mstns:includeEndpointID> [0..1]

'Include endpoint ID: extension_id'

<mstns:includeEndpointNo> common:boolean </mstns:includeEndpointNo> [0..1]

'Include endpoint internal number: extension_inumber'

<mstns:includeEndpointPublicNo> common:boolean </mstns:includeEndpointPublicNo> [0..1]

'Include endpoint public numbe: extension_pnumber'

<mstns:includeChargingPlanID> common:boolean </mstns:includeChargingPlanID> [0..1]

'Include charging plan: billing_plan'

</...>

Schema Component Representation

<xs:complexType name="CustomButton">

<xs:complexContent>

<xs:extension base=" CustomAlert ">

<xs:sequence>

<xs:element name="URL" type=" common:domain " minOccurs="0"/>

<xs:element name="location" default="navigation" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="navigation"/>

<xs:enumeration value="content"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="action" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="newWindow"/>

<xs:enumeration value="currentWindow"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="includeResellerID" type=" common:boolean " minOccurs="0"/>

<xs:element name="includeClientID" type=" common:boolean " minOccurs="0"/>

<xs:element name="includeEndpointID" type=" common:boolean " minOccurs="0"/>

<xs:element name="includeEndpointNo" type=" common:boolean " minOccurs="0"/>

<xs:element name="includeEndpointPublicNo" type=" common:boolean " minOccurs="0"/>

<xs:element name="includeChargingPlanID" type=" common:boolean " minOccurs="0"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Complex Type: Folders

Super-types:	None
Sub-types:	None

Name	Folders
Abstract	no
Documentation	Folders data

XML Instance Representation

<...>

<mstns:ID> common:positiveInteger </mstns:ID> [0..1]

'Folder ID'

<mstns:name> common:string </mstns:name> [0..1]

'Folder name'

<mstns:userID> common:positiveInteger </mstns:userID> [0..1]

'User ID'

<mstns:userName> common:string </mstns:userName> [0..1]

'User name'

<mstns:crDate> xs:dateTime </mstns:crDate> [0..1]

'Creation date'

</...>

Schema Component Representation

<xs:complexType name="Folders">

<xs:sequence>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="name" type=" common:string " minOccurs="0"/>

<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="userName" type=" common:string " minOccurs="0"/>

<xs:element name="crDate" type=" xs:dateTime " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: Language

Super-types:	None
Sub-types:	None

Name	Language
Abstract	no
Documentation	Interface language packs data

XML Instance Representation

<...>

<mstns:name> common:string </mstns:name> [0..1]

'Language name'

<mstns:code> common:code </mstns:code> [0..1]

'Language code'

<mstns:version> common:string </mstns:version> [0..1]

'Language pack version'

</...>

Schema Component Representation

<xs:complexType name="Language">

<xs:sequence>

<xs:element name="name" type=" common:string " minOccurs="0"/>

<xs:element name="code" type=" common:code " minOccurs="0"/>

<xs:element name="version" type=" common:string " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: Sounds

Super-types:	None
Sub-types:	None

Name	Sounds
Abstract	no
Documentation	Sound data

XML Instance Representation

<...>

<mstns:ID> common:positiveInteger </mstns:ID> [0..1]

'Sound ID'

<mstns:name> common:string </mstns:name> [0..1]

'Sound name'

<mstns:system> common:integer </mstns:system> [0..1]

'0: non system sounds, 1: system, -1: all files. Default -1.'

<mstns:status> common:integer </mstns:status> [0..1]

<mstns:folderID> common:positiveInteger </mstns:folderID> [0..1]

'Sound folder ID'

<mstns:folder> common:string </mstns:folder> [0..1]

'Sound folder'

<mstns:crDate> xs:dateTime </mstns:crDate> [0..1]

'Creation date'

</...>

Schema Component Representation

<xs:complexType name="Sounds">

<xs:sequence>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="name" type=" common:string " minOccurs="0"/>

<xs:element name="system" type=" common:integer " minOccurs="0"/>

<xs:element name="status" type=" common:integer " minOccurs="0"/>

<xs:element name="folderID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="folder" type=" common:string " minOccurs="0"/>

<xs:element name="crDate" type=" xs:dateTime " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: Template

Super-types:	None
Sub-types:	None

Name	Template
Abstract	no
Documentation	User template data

XML Instance Representation

<...>

<mstns:ID> common:positiveInteger </mstns:ID> [1]

'User template ID'

<mstns:name> common:string </mstns:name> [0..1]

'Template name'

<mstns:userID> common:positiveInteger </mstns:userID> [1]

'Template owner ID'

<mstns:userName> common:string </mstns:userName> [0..1]

'Template owner name'

<mstns:userLevel> common:integer </mstns:userLevel> [1]

'Possible values: 10 (reseller), 50 (client), 100 (extension).'

<mstns:chargingPlanID> common:positiveInteger </mstns:chargingPlanID> [0..1]

'Charging plan ID'

<mstns:chargingPlan> common:string </mstns:chargingPlan> [0..1]

'Charging plan name'

<mstns:users> common:integer </mstns:users> [0..1]

'Number of users created with template'

<mstns:extensionType> common:string </mstns:extensionType> [0..1]

'Extension type'

</...>

Schema Component Representation

<xs:complexType name="Template">

<xs:sequence>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="name" type=" common:string " minOccurs="0"/>

<xs:element name="userID" type=" common:positiveInteger "/>

<xs:element name="userName" type=" common:string " minOccurs="0"/>

<xs:element name="userLevel" type=" common:integer "/>

<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="chargingPlan" type=" common:string " minOccurs="0"/>

<xs:element name="users" type=" common:integer " minOccurs="0"/>

<xs:element name="extensionType" type=" common:string " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: TimeInterval

Super-types:	None
Sub-types:	None

Name	TimeInterval
Abstract	no
Documentation	Time interval data

XML Instance Representation

<...>

<mstns:startTime> xs:time </mstns:startTime> [0..1]

'Start time in format: 00:00.'

<mstns:endTime> xs:time </mstns:endTime> [0..1]

'End time in format: 00:00.'

<mstns:startDay> xs:unsignedInt </mstns:startDay> [0..1]

'Start date: day of month. Default value 1.'

<mstns:endDay> xs:unsignedInt </mstns:endDay> [0..1]

'End date: day of month. Default value 31.'

<mstns:startWkday> xs:unsignedInt </mstns:startWkday> [0..1]

'Start weekday. Default value: 2 (Monday).'

<mstns:endWkday> xs:unsignedInt </mstns:endWkday> [0..1]

'End weekday. Default value: 1 (Sunday)'

<mstns:month> common:integer </mstns:month> [0..1]

'Month'

</...>

Schema Component Representation

<xs:complexType name="TimeInterval">

<xs:sequence>

<xs:element name="startTime" type=" xs:time " minOccurs="0"/>

<xs:element name="endTime" type=" xs:time " minOccurs="0"/>

<xs:element name="startDay" type=" xs:unsignedInt " default="1" minOccurs="0"/>

<xs:element name="endDay" type=" xs:unsignedInt " default="31" minOccurs="0"/>

<xs:element name="startWkday" type=" xs:unsignedInt " default="2" minOccurs="0"/>

<xs:element name="endWkday" type=" xs:unsignedInt " default="1" minOccurs="0"/>

<xs:element name="month" type=" common:integer " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: TimeIntervalBlock

Super-types:	None
Sub-types:	None

Name	TimeIntervalBlock
Abstract	no
Documentation	Time interval block data

XML Instance Representation

<...>

<mstns:ID> common:positiveInteger </mstns:ID> [0..1]

'Time interval ID'

<mstns:name> common:string </mstns:name> [0..1]

'Time interval block name'

<mstns:type> xs:string (value comes from list: {'interval'|'day'}) </mstns:type> [0..1]

'The available values for the matching algorithm values are: \'day\', \'interval\'. Default value: interval.'

<mstns:timezone> common:positiveInteger </mstns:timezone> [0..1]

'Timezone ID. Use PBX:GetTimezone method fot the list of all available timezones'

<mstns:userID> common:positiveInteger </mstns:userID> [0..1]

'Time interval owner ID'

<mstns:crDate> xs:dateTime </mstns:crDate> [0..1]

'Creation date'

<mstns:intervals> common:integer </mstns:intervals> [0..1]

'Maching time intervals number in time interval block'

</...>

Schema Component Representation

<xs:complexType name="TimeIntervalBlock">

<xs:sequence>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="name" type=" common:string " minOccurs="0"/>

<xs:element name="type" default="interval" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="interval"/>

<xs:enumeration value="day"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="timezone" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="crDate" type=" xs:dateTime " minOccurs="0"/>

<xs:element name="intervals" type=" common:integer " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Generated by <oXygen/> XML Editor using a modified version of xs3p that adds schema diagrams and chunking support. Last modified:

Documentation for PBXMessagesInfo

Table of Contents

Master schema documentation file: PBXMessagesInfo.xsd.html

Schema Document Properties

Declared Namespaces

Global Definitions

Complex Type: CustomAlert

Complex Type: CustomButton

Complex Type: Folders

Complex Type: Language

Complex Type: Sounds

Complex Type: Template

Complex Type: TimeInterval

Complex Type: TimeIntervalBlock