Documentation for PBXMessagesInfo

Table of Contents

top

Schema Document Properties

Target Namespace http://4psa.com/PBXMessagesInfo.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):

Declared Namespaces

Prefix Namespace
Default namespace http://4psa.com/PBXMessagesInfo.xsd/2.0.0
PBXData http://4psa.com/PBXData.xsd/2.0.0
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://4psa.com/Common.xsd/2.0.0
Schema Component Representation
<xs:schema targetNamespace="http://4psa.com/PBXMessagesInfo.xsd/2.0.0" elementFormDefault="qualified" id="PBXMessagesInfo">
<xs:import namespace="http://4psa.com/PBXData.xsd/2.0.0" schemaLocation="PBXData.xsd"/>
<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: EnrollmentResponseType

Super-types: None
Sub-types: None
Name EnrollmentResponseType
Abstract no
Documentation Enroll 4PSA VoipNow in third-party applications: response type
XML Instance Representation
<...>
<enrollmentID> common:string </enrollmentID> [0..1]

'Enrollment unique identifier'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="EnrollmentResponseType">
<xs:sequence>
<xs:element name="enrollmentID" type=" common:string " minOccurs="0"/>
<xs:element name="result" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="success"/>
<xs:enumeration value="partial"/>
<xs:enumeration value="failure"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetCustomAlertsResponseType

Super-types: None
Sub-types: None
Name GetCustomAlertsResponseType
Abstract no
Documentation Get custom alerts list: response type
XML Instance Representation
<...>
<button> [0..*]

'Available custom buttons'


<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'

<status> common:boolean </status> [0..1]
</button>
<userID> common:positiveInteger </userID> [0..1]

'Custom alert owner ID'

<userIdentifier> common:string </userIdentifier> [0..1]

'Custom alert owner identifier'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetCustomAlertsResponseType">
<xs:sequence>
<xs:element name="button" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" PBXData:CustomAlert ">
<xs:sequence>
<xs:element name="status" type=" common:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetCustomButtonsResponseType

Super-types: None
Sub-types: None
Name GetCustomButtonsResponseType
Abstract no
Documentation Get custom buttons list: response type
XML Instance Representation
<...>
<button> [0..*]

'Available custom buttons'


<!-- ' CustomAlert ' super type was not found in this schema. Some elements and attributes may be missing. -->
<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'

<status> common:boolean </status> [0..1]
</button>
<userID> common:positiveInteger </userID> [0..1]

'Custom alert owner ID'

<userIdentifier> common:string </userIdentifier> [0..1]

'Custom alert owner identifier'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetCustomButtonsResponseType">
<xs:sequence>
<xs:element name="button" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" PBXData:CustomButton ">
<xs:sequence>
<xs:element name="status" type=" common:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetFileLanguagesResponseType

Super-types: None
Sub-types: None
Name GetFileLanguagesResponseType
Abstract no
Documentation Get sound file languages: response type
XML Instance Representation
<...>
<languages> [0..*]

'Available languages for sound file'


<code> common:code </code> [1]

'Language code'

<name> common:string </name> [1]

'Language name'

</languages>
<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetFileLanguagesResponseType">
<xs:sequence>
<xs:element name="languages" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:code "/>
<xs:element name="name" type=" common:string "/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetFoldersResponseType

Super-types: None
Sub-types: None
Name GetFoldersResponseType
Abstract no
Documentation Get client list of folders: response type
XML Instance Representation
<...>
<folders> PBXData:Folders </folders> [0..*]

'Available client folders'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetFoldersResponseType">
<xs:sequence>
<xs:element name="folders" type=" PBXData:Folders " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetInterfaceLangResponseType

Super-types: None
Sub-types: None
Name GetInterfaceLangResponseType
Abstract no
Documentation Get available interface language packs: response type
XML Instance Representation
<...>
<interfaceLang> PBXData:Language </interfaceLang> [0..*]

'Available interface languages on success'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetInterfaceLangResponseType">
<xs:sequence>
<xs:element name="interfaceLang" type=" PBXData:Language " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetPhoneLangResponseType

Super-types: None
Sub-types: None
Name GetPhoneLangResponseType
Abstract no
Documentation Get available phone languages: response type
XML Instance Representation
<...>
<phoneLang> PBXData:Language </phoneLang> [0..*]

'A list with available phone languages on success'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetPhoneLangResponseType">
<xs:sequence>
<xs:element name="phoneLang" type=" PBXData:Language " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetSchemaVersionsResponseType

Super-types: None
Sub-types: None
Name GetSchemaVersionsResponseType
Abstract no
Documentation Get SOAP schema version: response type
XML Instance Representation
<...>
<versions> common:string </versions> [0..*]

'A list with available SOAP schema versions on the 4PSA VoipNow server'

</...>
Schema Component Representation
<xs:complexType name="GetSchemaVersionsResponseType">
<xs:sequence>
<xs:element name="versions" type=" common:string " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetSoundsResponseType

Super-types: None
Sub-types: None
Name GetSoundsResponseType
Abstract no
Documentation Get owned/shared sounds: response type
XML Instance Representation
<...>
<sounds> PBXData:Sounds </sounds> [0..*]

'Sounds'

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

'User ID'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetSoundsResponseType">
<xs:sequence>
<xs:element name="sounds" type=" PBXData:Sounds " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetTemplatesResponseType

Super-types: None
Sub-types: None
Name GetTemplatesResponseType
Abstract no
Documentation Get user templates: response type
XML Instance Representation
<...>
<template> PBXData:Template </template> [0..*]

'Template data'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetTemplatesResponseType">
<xs:sequence>
<xs:element name="template" type=" PBXData:Template " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetTimeIntervalBlocksResponseType

Super-types: None
Sub-types: None
Name GetTimeIntervalBlocksResponseType
Abstract no
Documentation Get time interval blocks: response type
XML Instance Representation
<...>
<timeIntervalBlock> PBXData:TimeIntervalBlock </timeIntervalBlock> [0..*]

'Available time interval blocks'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetTimeIntervalBlocksResponseType">
<xs:sequence>
<xs:element name="timeIntervalBlock" type=" PBXData:TimeIntervalBlock " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetTimeIntervalsResponseType

Super-types: None
Sub-types: None
Name GetTimeIntervalsResponseType
Abstract no
Documentation Get time intervals: response type
XML Instance Representation
<...>
<timeInterval> [0..*]

'Available time intervals'


<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'

<intervalID> common:positiveInteger </intervalID> [0..1]

'Time interval ID'

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

'Time interval block ID'

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

'Time interval block name'

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

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

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

'Time interval owner ID'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetTimeIntervalsResponseType">
<xs:sequence>
<xs:element name="timeInterval" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" PBXData:TimeInterval ">
<xs:sequence>
<xs:element name="intervalID" type=" common:positiveInteger " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<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="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: PingResponseType

Super-types: None
Sub-types: None
Name PingResponseType
Abstract no
Documentation Ping 4PSA VoipNow server: response type
XML Instance Representation
<...>
<title> common:string </title> [0..1]

'Default application title'

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

'4PSA VoipNow version'

<buildNo> common:string </buildNo> [0..1]

'4PSA VoipNow build number'

<resellers> common:integer </resellers> [0..1]

'The number of resellers on the 4PSA VoipNow server'

<clients> common:integer </clients> [0..1]

'The number of clients on the 4PSA VoipNow server'

<extensions> common:integer </extensions> [0..1]

'The number of extension accounts on the 4PSA VoipNow server'

<activSSO> common:boolean </activSSO> [0..1]

'SSO enabled'

<availableUpdate> xs:string (value comes from list: {'in progress'|'YES'|'NO'}) </availableUpdate> [0..1]

'Available updates to VoipNow'

<api> [0..5]

'Third party API'


<protocol> ... </protocol> [1]
<version> ... </version> [1]
</api>
<infrastructureID> common:string </infrastructureID> [0..1]
<currency> common:string </currency> [0..1]

'Default system currency'

<charging> common:boolean </charging> [0..1]

'Charging enabled'

</...>
Schema Component Representation
<xs:complexType name="PingResponseType">
<xs:sequence>
<xs:element name="title" type=" common:string " minOccurs="0"/>
<xs:element name="version" type=" common:string " minOccurs="0"/>
<xs:element name="buildNo" type=" common:string " minOccurs="0"/>
<xs:element name="resellers" type=" common:integer " minOccurs="0"/>
<xs:element name="clients" type=" common:integer " minOccurs="0"/>
<xs:element name="extensions" type=" common:integer " minOccurs="0"/>
<xs:element name="activSSO" type=" common:boolean " minOccurs="0"/>
<xs:element name="availableUpdate" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="in progress"/>
<xs:enumeration value="YES"/>
<xs:enumeration value="NO"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="api" minOccurs="0" maxOccurs="5">
<xs:complexType>
<xs:sequence>
<xs:element name="protocol"/>
<xs:element name="version"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="infrastructureID" type=" common:string " minOccurs="0"/>
<xs:element name="currency" type=" common:string " minOccurs="0"/>
<xs:element name="charging" type=" common:boolean " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: UpdateObjectResponseType

Super-types: common:updateObject < UpdateObjectResponseType (by extension)
Sub-types: None
Name UpdateObjectResponseType
Abstract no
Documentation Update object: reponse type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UpdateObjectResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UpgradeHistoryResponseType

Super-types: None
Sub-types: None
Name UpgradeHistoryResponseType
Abstract no
Documentation Upgrade 4PSA VoipNow history report: response type
XML Instance Representation
<...>
<notice> common:notice </notice> [0..*]
<upgrade> [0..*]
<started> xs:dateTime </started> [0..1]
<completed> xs:dateTime </completed> [0..1]
<components> common:integer </components> [0..1]
<status> common:string </status> [0..1]
</upgrade>
</...>
Schema Component Representation
<xs:complexType name="UpgradeHistoryResponseType">
<xs:sequence>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="upgrade" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="started" type=" xs:dateTime " minOccurs="0"/>
<xs:element name="completed" type=" xs:dateTime " minOccurs="0"/>
<xs:element name="components" type=" common:integer " minOccurs="0"/>
<xs:element name="status" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
top

Complex Type: UpgradeVoipNowResponseType

Super-types: None
Sub-types: None
Name UpgradeVoipNowResponseType
Abstract no
Documentation Upgrade 4PSA VoipNow to latest release: response type
XML Instance Representation
<...>
<result> xs:string (value comes from list: {'in progress'|'failure'}) </result> [0..1]

'Operation result: started/failure'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UpgradeVoipNowResponseType">
<xs:sequence>
<xs:element name="result" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="in progress"/>
<xs:enumeration value="failure"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

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