Skip to content
complex data types

PBX - Complex Types

This section documents the complex data types for PBX service.

UserSounds

Description: Get owned/shared sounds: response type

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Used by
Element: sounds

Type: Sounds

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Sounds

Properties

PropertyValue
contentsimple
minOccurs0
maxOccursunbounded

XSD Source

xml
<xs:element name="sounds" type="Sounds" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>Sounds</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: User ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="userID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>User ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: common:notice

Type: common:notice

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0
maxOccursunbounded

XSD Source

xml
<xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>

DeviceInfo

Description: Phone provisioning data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Used by
Element: IP

Type: common:ip

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Provisioning system IP or hostname

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="IP" type="common:ip" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Provisioning system IP or hostname</xs:documentation>
  </xs:annotation>
</xs:element>
Element: MACBased

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Use MAC based provisioning

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="MACBased" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Use MAC based provisioning</xs:documentation>
  </xs:annotation>
</xs:element>
Element: connectionType

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Equipment connection type

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="connectionType" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Equipment connection type</xs:documentation>
  </xs:annotation>
</xs:element>
Element: connectionIP

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Connection IP

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="connectionIP" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Connection IP</xs:documentation>
  </xs:annotation>
</xs:element>
Element: mask

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Netmask

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="mask" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Netmask</xs:documentation>
  </xs:annotation>
</xs:element>
Element: gateway

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Gateway

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="gateway" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Gateway</xs:documentation>
  </xs:annotation>
</xs:element>

DeviceExtension

Description: Phone provisioning data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Element: common:extendedNumber

Type: common:extendedNumber

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Extended number of the extension

Properties

PropertyValue
contentsimple

XSD Source

xml
<xs:element name="common:extendedNumber" type="common:extendedNumber">
  <xs:annotation>
    <xs:documentation>Extended number of the extension</xs:documentation>
  </xs:annotation>
</xs:element>
Element: line

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Line on which the extension is assigned

Properties

PropertyValue
contentsimple

XSD Source

xml
<xs:element name="line" type="common:integer">
  <xs:annotation>
    <xs:documentation>Line on which the extension is assigned</xs:documentation>
  </xs:annotation>
</xs:element>

Language

Description: Interface language packs data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Element: name

Type: name

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Language name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="name" type="name" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Language name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: code

Type: common:code

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Language code

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="code" type="common:code" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Language code</xs:documentation>
  </xs:annotation>
</xs:element>
Element: version

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Language pack version

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="version" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Language pack version</xs:documentation>
  </xs:annotation>
</xs:element>

TimeInterval

Description: Time interval data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Used by
Element: startTime

Type: xs:time

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Start time in format: 00:00.

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="startTime" type="xs:time" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Start time in format: 00:00.</xs:documentation>
  </xs:annotation>
</xs:element>
Element: endTime

Type: xs:time

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: End time in format: 00:00.

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="endTime" type="xs:time" minOccurs="0">
  <xs:annotation>
    <xs:documentation>End time in format: 00:00.</xs:documentation>
  </xs:annotation>
</xs:element>
Element: startDay

Type: xs:unsignedInt

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentsimple
minOccurs0
default1

XSD Source

xml
<xs:element name="startDay" type="xs:unsignedInt" minOccurs="0" default="1">
  <xs:annotation>
    <xs:documentation>Start date: day of month. Default value 1.</xs:documentation>
  </xs:annotation>
</xs:element>
Element: endDay

Type: xs:unsignedInt

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentsimple
minOccurs0
default31

XSD Source

xml
<xs:element name="endDay" type="xs:unsignedInt" minOccurs="0" default="31">
  <xs:annotation>
    <xs:documentation>End date: day of month. Default value 31.</xs:documentation>
  </xs:annotation>
</xs:element>
Element: startWkday

Type: xs:unsignedInt

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentsimple
minOccurs0
default2

XSD Source

xml
<xs:element name="startWkday" type="xs:unsignedInt" minOccurs="0" default="2">
  <xs:annotation>
    <xs:documentation>Start weekday. Default value: 2 (Monday).</xs:documentation>
  </xs:annotation>
</xs:element>
Element: endWkday

Type: xs:unsignedInt

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentsimple
minOccurs0
default1

XSD Source

xml
<xs:element name="endWkday" type="xs:unsignedInt" minOccurs="0" default="1">
  <xs:annotation>
    <xs:documentation>End weekday. Default value: 1 (Sunday)</xs:documentation>
  </xs:annotation>
</xs:element>
Element: month

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Month

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="month" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Month</xs:documentation>
  </xs:annotation>
</xs:element>

Template

Description: User template data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Element: ID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: User template ID

Properties

PropertyValue
contentsimple

XSD Source

xml
<xs:element name="ID" type="common:positiveInteger">
  <xs:annotation>
    <xs:documentation>User template ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: name

Type: name

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Template name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="name" type="name" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Template name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Template owner ID

Properties

PropertyValue
contentsimple

XSD Source

xml
<xs:element name="userID" type="common:positiveInteger">
  <xs:annotation>
    <xs:documentation>Template owner ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userName

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Template owner name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="userName" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Template owner name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userLevel

Type: restriction of xs:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Possible values: serviceProvider, organization, user, extension.

Properties

PropertyValue
contentcomplex

Allowed Values

ValueDescription
serviceProvider
organization
user
extension

XSD Source

xml
<xs:element name="userLevel">
  <xs:annotation>
    <xs:documentation>Possible values: serviceProvider, organization, user,
						extension.</xs:documentation>
  </xs:annotation>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="serviceProvider"/>
        <xs:enumeration value="organization"/>
        <xs:enumeration value="user"/>
        <xs:enumeration value="extension"/>
      </xs:restriction>
    </xs:simpleType>
</xs:element>
Element: chargingPlanID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Charging plan ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="chargingPlanID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Charging plan ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: chargingPlan

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Charging plan name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="chargingPlan" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Charging plan name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: users

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Number of users created with template

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="users" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Number of users created with template</xs:documentation>
  </xs:annotation>
</xs:element>
Element: extensionType

Type: extensionType

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Extension type

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="extensionType" type="extensionType" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Extension type</xs:documentation>
  </xs:annotation>
</xs:element>
Element: subscription

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Set to true of the template is a subscription

Properties

PropertyValue
contentsimple
minOccurs0
defaulttrue

XSD Source

xml
<xs:element name="subscription" type="common:boolean" minOccurs="0" default="true">
  <xs:annotation>
    <xs:documentation>Set to true of the template is a subscription</xs:documentation>
  </xs:annotation>
</xs:element>

TimeIntervalBlock

Description: Time interval block data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Element: ID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Time interval ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="ID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Time interval ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: name

Type: name

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Time interval block name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="name" type="name" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Time interval block name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: type

Type: restriction of xs:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentcomplex
minOccurs0
defaultinterval

Allowed Values

ValueDescription
interval
day

XSD Source

xml
<xs:element name="type" minOccurs="0" default="interval">
  <xs:annotation>
    <xs:documentation>The available values for the matching algorithm values are:
						'day', 'interval'. Default value: interval.</xs:documentation>
  </xs:annotation>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="interval"/>
        <xs:enumeration value="day"/>
      </xs:restriction>
    </xs:simpleType>
</xs:element>
Element: timezone

Type: xs:nonNegativeInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="timezone" type="xs:nonNegativeInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Timezone ID. Use PBX:GetTimezone method fot the list of all
						available timezones</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Time interval owner ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="userID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Time interval owner ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: common:crDate

Type: common:crDate

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="common:crDate" type="common:crDate" minOccurs="0"/>
Element: intervals

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Maching time intervals number in time interval block

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="intervals" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Maching time intervals number in time interval
						block</xs:documentation>
  </xs:annotation>
</xs:element>

Sounds

Description: Sound data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Used by
Element: ID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Sound ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="ID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Sound ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: name

Type: name

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Sound name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="name" type="name" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Sound name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: system

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="system" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>0: non system sounds, 1: system, -1: all files. Default
						-1.</xs:documentation>
  </xs:annotation>
</xs:element>
Element: status

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Sound folder ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="folderID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Sound folder ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: folder

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Sound folder

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="folder" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Sound folder</xs:documentation>
  </xs:annotation>
</xs:element>
Element: musicOnHold

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: 0: non music on hold sounds, 1: music on hold files, -1: all files. Default -1.

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="musicOnHold" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>0: non music on hold sounds, 1: music on hold files, -1: all
						files. Default -1.</xs:documentation>
  </xs:annotation>
</xs:element>
Element: common:crDate

Type: common:crDate

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

Folders

Description: Folders data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Element: ID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Folder ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="ID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Folder ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: name

Type: name

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Folder name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="name" type="name" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Folder name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userID

Type: common:positiveInteger

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: User ID

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="userID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>User ID</xs:documentation>
  </xs:annotation>
</xs:element>
Element: userName

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: User name

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="userName" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>User name</xs:documentation>
  </xs:annotation>
</xs:element>
Element: musicOnHoldSoundsNo

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Number of music on hold sounds

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="musicOnHoldSoundsNo" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Number of music on hold sounds</xs:documentation>
  </xs:annotation>
</xs:element>
Element: nonMusicOnHoldSoundsNo

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Number of non music on hold sounds

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="nonMusicOnHoldSoundsNo" type="common:integer" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Number of non music on hold sounds</xs:documentation>
  </xs:annotation>
</xs:element>
Element: common:crDate

Type: common:crDate

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

CustomAlert

Description: Custom alert data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Used by
Element: code

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

Type: common:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

Type: common:integer

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

Type: restriction of xs:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Possible values: inherit, select. Display method

Properties

PropertyValue
contentcomplex
minOccurs0
defaultinherit

Allowed Values

ValueDescription
inherit
select

XSD Source

xml
<xs:element name="displayMethod" minOccurs="0" default="inherit">
  <xs:annotation>
    <xs:documentation>Possible values: inherit, select. Display
						method</xs:documentation>
  </xs:annotation>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="inherit"/>
        <xs:enumeration value="select"/>
      </xs:restriction>
    </xs:simpleType>
</xs:element>
Element: displayLevel

Type: restriction of xs:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

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

Properties

PropertyValue
contentcomplex
minOccurs0
default0

Allowed Values

ValueDescription
0
1
2
3
10
50
100

XSD Source

xml
<xs:element name="displayLevel" minOccurs="0" default="0">
  <xs:annotation>
    <xs:documentation>Inheritance level /Display to level. Possible values:
						10-reseller, 50-client, 100-extension for displayMethod:select, 0-3 for
						displayMethod:inherit.</xs:documentation>
  </xs:annotation>
    <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>
Element: displayToOwner

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Display on owner account

Properties

PropertyValue
contentsimple
minOccurs0
defaulttrue

XSD Source

xml
<xs:element name="displayToOwner" type="common:boolean" minOccurs="0" default="true">
  <xs:annotation>
    <xs:documentation>Display on owner account</xs:documentation>
  </xs:annotation>
</xs:element>
Element: expiration

Type: common:unlimitedDate

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Custom button expiration date

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="expiration" type="common:unlimitedDate" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Custom button expiration date</xs:documentation>
  </xs:annotation>
</xs:element>

CustomButton

Description: Custom button data

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Used by

Extends: CustomAlert

Element: URL

Type: common:domain

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

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

Type: restriction of xs:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Possible values: navigation, content.

Properties

PropertyValue
contentcomplex
minOccurs0
defaultnavigation

Allowed Values

ValueDescription
navigation
content

XSD Source

xml
<xs:element name="location" minOccurs="0" default="navigation">
  <xs:annotation>
    <xs:documentation>Possible values: navigation,
								content.</xs:documentation>
  </xs:annotation>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="navigation"/>
        <xs:enumeration value="content"/>
      </xs:restriction>
    </xs:simpleType>
</xs:element>
Element: action

Type: restriction of xs:string

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Possible values: newWindow, currentWindow.

Properties

PropertyValue
contentcomplex
minOccurs0

Allowed Values

ValueDescription
newWindow
currentWindow

XSD Source

xml
<xs:element name="action" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Possible values: newWindow,
								currentWindow.</xs:documentation>
  </xs:annotation>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="newWindow"/>
        <xs:enumeration value="currentWindow"/>
      </xs:restriction>
    </xs:simpleType>
</xs:element>
Element: includeServiceProviderID

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Include reseller ID: reseller_id

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="includeServiceProviderID" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Include reseller ID: reseller_id</xs:documentation>
  </xs:annotation>
</xs:element>
Element: includeClientID

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Include client ID: client_id

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="includeClientID" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Include client ID: client_id</xs:documentation>
  </xs:annotation>
</xs:element>
Element: includeExtensionID

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Include extension ID: extension_id

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="includeExtensionID" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Include extension ID: extension_id</xs:documentation>
  </xs:annotation>
</xs:element>
Element: includeExtensionNo

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Include extension internal number: extension_inumber

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="includeExtensionNo" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Include extension internal number:
								extension_inumber</xs:documentation>
  </xs:annotation>
</xs:element>
Element: includeExtensionPublicNo

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Include extension public numbe: extension_pnumber

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="includeExtensionPublicNo" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Include extension public numbe:
								extension_pnumber</xs:documentation>
  </xs:annotation>
</xs:element>
Element: includeChargingPlanID

Type: common:boolean

Namespace: http://4psa.com/PBXData.xsd/5.2.5

Description: Include charging plan: billing_plan

Properties

PropertyValue
contentsimple
minOccurs0

XSD Source

xml
<xs:element name="includeChargingPlanID" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Include charging plan: billing_plan</xs:documentation>
  </xs:annotation>
</xs:element>

Last updated: Dec 9, 2025