PBX Operations

This section documents the API operations for PBX service.

GetRegions

GetRegions

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

Description: Get all available regions for a country: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
code	common:string	Country code
region	common:string (optional)	Region name to filter result

XSD Source

<xs:element name="GetRegions">
  <xs:annotation>
    <xs:documentation>Get all available regions for a country: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="common:string">
          <xs:annotation>
            <xs:documentation>Country code</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="region" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Region name to filter result</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetRegionsResponse

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

Description: Get all available regions for a country: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
region	inline (0..*)
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetRegionsResponse">
  <xs:annotation>
    <xs:documentation>Get all available regions for a country: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="region" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetTimezone

GetTimezone

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

Description: Get all available timezones: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
code	common:string (optional)	Country code

XSD Source

<xs:element name="GetTimezone">
  <xs:annotation>
    <xs:documentation>Get all available timezones: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Country code</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetTimezoneResponse

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

Description: Get all available timezones: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
timezone	inline (0..*)
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetTimezoneResponse">
  <xs:annotation>
    <xs:documentation>Get all available timezones: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="timezone" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

Ping

Ping

Type: common:string

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

Description: Ping 4PSA VoipNow server: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="Ping" type="common:string">
  <xs:annotation>
    <xs:documentation>Ping 4PSA VoipNow server: request</xs:documentation>
  </xs:annotation>
</xs:element>

PingResponse

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

Description: Ping 4PSA VoipNow server: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
title	common:string (optional)	Default application title
PBXData:version	PBXData:version (optional)
buildNo	common:string (optional)	4PSA VoipNow build number
serviceProviders	common:integer (optional)	The number of service providers on the 4PSA VoipNow server
organizations	common:integer (optional)	The number of organizations on the 4PSA VoipNow server
users	common:integer (optional)	The number of users on the 4PSA VoipNow server
extensions	common:integer (optional)	The number of extension accounts on the 4PSA VoipNow server
activSSO	common:boolean (optional)	SSO enabled
availableUpdate	inline (optional)	Available updates to VoipNow
api	inline (0..5)	Third party API
infrastructureID	common:string (optional)
currency	common:string (optional)	Default system currency
charging	common:boolean (optional)	Charging enabled
automationAgent	common:boolean (optional)	VoipNow node can be enrolled by VoipNow Automation

XSD Source

<xs:element name="PingResponse">
  <xs:annotation>
    <xs:documentation>Ping 4PSA VoipNow server: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="title" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Default application title</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PBXData:version" type="PBXData:version" minOccurs="0"/>
        <xs:element name="buildNo" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>4PSA VoipNow build number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="serviceProviders" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The number of service providers on the 4PSA VoipNow server</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="organizations" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The number of organizations on the 4PSA VoipNow server</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="users" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The number of users on the 4PSA VoipNow server</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="extensions" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The number of extension accounts on the 4PSA VoipNow server</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="activSSO" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>SSO enabled</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="availableUpdate" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Available updates to VoipNow</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="api" minOccurs="0" maxOccurs="5">
          <xs:annotation>
            <xs:documentation>Third party API</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="infrastructureID" type="common:string" minOccurs="0"/>
        <xs:element name="currency" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Default system currency</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="charging" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Charging enabled</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="automationAgent" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>VoipNow node can be enrolled by VoipNow Automation</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

Enroll

Enroll

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

Description: Enroll 4PSA VoipNow in third-party applications: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:scope	common:scope
URL	common:domain	IP/URL of the infrastructure controller that enrolls

						(master host) |

| masterAuth | common:string | Authentication key of the master | | masterAuthType | common:string | Authentication type of the master | | param | inline (0..64) | Pairs of name/value parameters |

XSD Source

<xs:element name="Enroll">
  <xs:annotation>
    <xs:documentation>Enroll 4PSA VoipNow in third-party applications:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:scope" type="common:scope"/>
        <xs:element name="URL" type="common:domain">
          <xs:annotation>
            <xs:documentation>IP/URL of the infrastructure controller that enrolls
							(master host)</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="masterAuth" type="common:string">
          <xs:annotation>
            <xs:documentation>Authentication key of the master</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="masterAuthType" type="common:string">
          <xs:annotation>
            <xs:documentation>Authentication type of the master</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="param" minOccurs="0" maxOccurs="64">
          <xs:annotation>
            <xs:documentation>Pairs of name/value parameters</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

EnrollResponse

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

Description: Enroll 4PSA VoipNow in third-party applications: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:enrollmentID	PBXData:enrollmentID (optional)
common:result	common:result (optional)
common:notice	common:notice (0..*)

XSD Source

<xs:element name="EnrollResponse">
  <xs:annotation>
    <xs:documentation>Enroll 4PSA VoipNow in third-party applications:
				response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:enrollmentID" type="PBXData:enrollmentID" minOccurs="0"/>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

Withdraw

Withdraw

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

Description: Withdraw 4PSA VoipNow in third-party applications: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:enrollmentID	PBXData:enrollmentID

XSD Source

<xs:element name="Withdraw">
  <xs:annotation>
    <xs:documentation>Withdraw 4PSA VoipNow in third-party applications:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:enrollmentID" type="PBXData:enrollmentID" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

WithdrawResponse

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

Description: Withdraw 4PSA VoipNow in third-party applications: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:result	common:result (optional)

XSD Source

<xs:element name="WithdrawResponse">
  <xs:annotation>
    <xs:documentation>Withdraw 4PSA VoipNow in third-party applications:
				response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

UpgradeVoipNow

UpgradeVoipNow

Type: common:string

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

Description: Upgrade 4PSA VoipNow to latest release: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="UpgradeVoipNow" type="common:string">
  <xs:annotation>
    <xs:documentation>Upgrade 4PSA VoipNow to latest release: request</xs:documentation>
  </xs:annotation>
</xs:element>

UpgradeVoipNowResponse

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

Description: Upgrade 4PSA VoipNow to latest release: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:result	common:result (optional)
common:notice	common:notice (0..*)

XSD Source

<xs:element name="UpgradeVoipNowResponse">
  <xs:annotation>
    <xs:documentation>Upgrade 4PSA VoipNow to latest release: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

UpgradeHistory

UpgradeHistory

Type: common:string

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

Description: Upgrade 4PSA VoipNow history report: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="UpgradeHistory" type="common:string">
  <xs:annotation>
    <xs:documentation>Upgrade 4PSA VoipNow history report: request</xs:documentation>
  </xs:annotation>
</xs:element>

UpgradeHistoryResponse

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

Description: Upgrade 4PSA VoipNow history report: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:notice	common:notice (0..*)
upgrade	inline (0..*)

XSD Source

<xs:element name="UpgradeHistoryResponse">
  <xs:annotation>
    <xs:documentation>Upgrade 4PSA VoipNow history report: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="upgrade" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetSchemaVersions

GetSchemaVersions

Type: common:string

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

Description: Get all available schema versions: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetSchemaVersions" type="common:string">
  <xs:annotation>
    <xs:documentation>Get all available schema versions: request</xs:documentation>
  </xs:annotation>
</xs:element>

GetSchemaVersionsResponse

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

Description: Get all available schema versions: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
versions	common:string (0..*)	A list with available SOAP schema versions on the 4PSA VoipNow server

XSD Source

<xs:element name="GetSchemaVersionsResponse">
  <xs:annotation>
    <xs:documentation>Get all available schema versions: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="versions" type="common:string" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>A list with available SOAP schema versions on the 4PSA VoipNow server</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetInterfaceLang

GetInterfaceLang

Type: common:string

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

Description: Get available interface languages: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetInterfaceLang" type="common:string">
  <xs:annotation>
    <xs:documentation>Get available interface languages: request</xs:documentation>
  </xs:annotation>
</xs:element>

GetInterfaceLangResponse

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

Description: Get available interface languages: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
interfaceLang	PBXData:Language (0..*)	Available interface languages on success
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetInterfaceLangResponse">
  <xs:annotation>
    <xs:documentation>Get available interface languages: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="interfaceLang" type="PBXData:Language" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available interface  languages on success</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetPhoneLang

GetPhoneLang

Type: common:string

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

Description: Get the list with available phone languages: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetPhoneLang" type="common:string">
  <xs:annotation>
    <xs:documentation>Get the list with available phone languages:
				request</xs:documentation>
  </xs:annotation>
</xs:element>

GetPhoneLangResponse

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

Description: Get the list with available phone languages: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
phoneLang	PBXData:Language (0..*)	A list with available phone languages on success
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetPhoneLangResponse">
  <xs:annotation>
    <xs:documentation>Get the list with available phone languages:
				response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="phoneLang" type="PBXData:Language" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>A list with available phone languages on success</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetTemplates

GetTemplates

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

Description: Get user templates list: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		Either of
└ common:ID	common:ID	User template ID
└ PBXData:userLevel	PBXData:userLevel
└ PBXData:extensionType	PBXData:extensionType

XSD Source

<xs:element name="GetTemplates">
  <xs:annotation>
    <xs:documentation>Get user templates list: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
          <xs:element name="PBXData:userLevel" type="PBXData:userLevel" minOccurs="0"/>
          <xs:element name="PBXData:extensionType" type="PBXData:extensionType" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetTemplatesResponse

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

Description: Get user templates list: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
template	PBXData:Template (0..*)	Template data
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetTemplatesResponse">
  <xs:annotation>
    <xs:documentation>Get user templates list: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="template" type="PBXData:Template" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Template data</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

AddTimeInterval

AddTimeInterval

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

Description: Add time interval: request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:ID	common:ID	Time interval block ID
timeInterval	data:TimeInterval (1..*)	Matching time intervals

XSD Source

<xs:element name="AddTimeInterval">
  <xs:annotation>
    <xs:documentation>Add time interval: request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Time interval block ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="timeInterval" type="data:TimeInterval" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Matching time intervals</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddTimeIntervalResponse

Type: common:updateObject

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

Description: Add time interval: response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="AddTimeIntervalResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add time interval: response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

EditTimeInterval

EditTimeInterval

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

Description: Edit time interval: request.

Properties

Property	Value
content	complex

Extends

Base type: data:TimeInterval

Elements

Element	Type	Description
common:ID	common:ID	Time interval block ID
intervalID	common:positiveInteger	Time interval ID

XSD Source

<xs:element name="EditTimeInterval">
  <xs:annotation>
    <xs:documentation>Edit time interval: request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:TimeInterval">
          <xs:sequence>
            <xs:element name="common:ID" type="common:ID">
              <xs:annotation>
                <xs:documentation>Time interval block ID</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="intervalID" type="common:positiveInteger">
              <xs:annotation>
                <xs:documentation>Time interval ID</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditTimeIntervalResponse

Type: common:updateObject

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

Description: Edit time interval: response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="EditTimeIntervalResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit time interval: response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetTimeIntervals

GetTimeIntervals

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

Description: Get time intervals: request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:ID	common:ID	Time interval block ID

XSD Source

<xs:element name="GetTimeIntervals">
  <xs:annotation>
    <xs:documentation>Get time intervals: request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Time interval block ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetTimeIntervalsResponse

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

Description: Get time intervals: response.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
timeInterval	inline (0..*)	Available time intervals
common:ID	common:ID (optional)	Time interval block ID
PBXData:name	PBXData:name (optional)	Time interval block name
PBXData:type	PBXData:type (optional)
common:userID	common:userID (optional)	Time interval owner ID
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetTimeIntervalsResponse">
  <xs:annotation>
    <xs:documentation>Get time intervals: response.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="timeInterval" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available time intervals</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:ID" type="common:ID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Time interval block ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PBXData:name" type="PBXData:name" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Time interval block name</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PBXData:type" type="PBXData:type" minOccurs="0"/>
        <xs:element name="common:userID" type="common:userID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Time interval owner ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

DelTimeInterval

DelTimeInterval

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

Description: Delete time interval from block: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
ID	common:positiveInteger	Time interval block ID
intervalID	common:positiveInteger (1..*)	Time interval ID

XSD Source

<xs:element name="DelTimeInterval">
  <xs:annotation>
    <xs:documentation>Delete time interval from block: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="ID" type="common:positiveInteger">
          <xs:annotation>
            <xs:documentation>Time interval block ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="intervalID" type="common:positiveInteger" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Time interval ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelTimeIntervalResponse

Type: common:delObject

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

Description: Delete time interval from block: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="DelTimeIntervalResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete time interval from block: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

AddTimeIntervalBlock

AddTimeIntervalBlock

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

Description: Add time interval block: request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:name	PBXData:name	Time interval block name
PBXData:type	PBXData:type (optional)
timezone	xs:nonNegativeInteger (optional)	Timezone ID. Use PBX:GetTimezone method fot the list of

						all available timezones |

| (choice) | | One of the following | | └ common:userID | common:userID | Time interval owner ID | | └ common:userIdentifier | common:userIdentifier | Time interval owner identifier | | └ userLogin | common:string | Time interval owner login |

XSD Source

<xs:element name="AddTimeIntervalBlock">
  <xs:annotation>
    <xs:documentation>Add time interval block: request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:name" type="PBXData:name">
          <xs:annotation>
            <xs:documentation>Time interval block name</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PBXData:type" type="PBXData:type" minOccurs="0"/>
        <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>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
          <xs:element name="userLogin" type="common:string" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddTimeIntervalBlockResponse

Type: common:updateObject

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

Description: Add time interval block: response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="AddTimeIntervalBlockResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add time interval block: response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

EditTimeIntervalBlock

EditTimeIntervalBlock

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

Description: Edit time interval block: request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
ID	common:positiveInteger (optional)	Time interval block ID
PBXData:name	PBXData:name (optional)	Time interval block name
PBXData:type	PBXData:type (optional)
timezone	xs:nonNegativeInteger (optional)	Timezone ID. Use PBX:GetTimezone method fot the list of

						all available timezones |

XSD Source

<xs:element name="EditTimeIntervalBlock">
  <xs:annotation>
    <xs:documentation>Edit time interval block: request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="ID" type="common:positiveInteger" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Time interval block ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PBXData:name" type="PBXData:name" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Time interval block name</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PBXData:type" type="PBXData:type" minOccurs="0"/>
        <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>
      </xs:sequence>
    </xs:complexType>
</xs:element>

EditTimeIntervalBlockResponse

Type: common:updateObject

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

Description: Edit time interval block: response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="EditTimeIntervalBlockResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit time interval block: response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetTimeIntervalBlocks

GetTimeIntervalBlocks

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

Description: Get time interval blocks: request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
filter	common:string (optional)	Filter time interval blocks list by

						name |

| (choice) | | One of the following | | └ common:userID | common:userID | Time interval owner ID | | └ common:userIdentifier | common:userIdentifier | Time interval owner identifier |

XSD Source

<xs:element name="GetTimeIntervalBlocks">
  <xs:annotation>
    <xs:documentation>Get time interval blocks: request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="filter" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter time interval blocks list by
							name</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetTimeIntervalBlocksResponse

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

Description: Get time intervals blocks: response.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
timeIntervalBlock	PBXData:TimeIntervalBlock (0..*)	Available time interval blocks
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetTimeIntervalBlocksResponse">
  <xs:annotation>
    <xs:documentation>Get time intervals blocks: response.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="timeIntervalBlock" type="PBXData:TimeIntervalBlock" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available time interval blocks</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

DelTimeIntervalBlock

DelTimeIntervalBlock

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

Description: Delete time interval block: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
ID	common:positiveInteger (1..*)	Time interval block ID

XSD Source

<xs:element name="DelTimeIntervalBlock">
  <xs:annotation>
    <xs:documentation>Delete time interval block: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="ID" type="common:positiveInteger" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Time interval block ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelTimeIntervalBlockResponse

Type: common:delObject

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

Description: Delete time interval block: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="DelTimeIntervalBlockResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete time interval block: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetOwnedSounds

GetOwnedSounds

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

Description: Get client sounds: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
folderID	common:positiveInteger (optional)	Set 0 for all folders.
languageID	common:positiveInteger (optional)	Set 0 for all files.
musicOnHold	common:integer (optional)	0: non music on hold sounds, 1: music on hold files, -1:

						all files. Default -1. |

| system | common:integer (optional) | 0: non system sounds, 1 - system sounds, -1: all files. Default -1. | | status | common:integer (optional) | Default -1. | | (choice) | | One of the following | | └ common:userID | common:userID | User ID | | └ common:userIdentifier | common:userIdentifier | User identifier |

XSD Source

<xs:element name="GetOwnedSounds">
  <xs:annotation>
    <xs:documentation>Get client sounds: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="folderID" type="common:positiveInteger" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Set 0 for all folders.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="languageID" type="common:positiveInteger" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Set 0 for all files.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <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>
        <xs:element name="system" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>0: non system sounds, 1 - system sounds, -1: all files.
							Default -1.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="status" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Default -1.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetOwnedSoundsResponse

Type: PBXData:UserSounds

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

Description: Get client sounds: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetOwnedSoundsResponse" type="PBXData:UserSounds">
  <xs:annotation>
    <xs:documentation>Get client sounds: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetSharedSounds

GetSharedSounds

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

Description: Get shared sounds: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
own	common:boolean (optional)	Filter shared sounds created by the user or all sounds to which this user has access to. Default value: true.
(choice)		One of the following
└ common:userID	common:userID	User ID
└ common:userIdentifier	common:userIdentifier	User identifier

XSD Source

<xs:element name="GetSharedSounds">
  <xs:annotation>
    <xs:documentation>Get shared sounds: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="own" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter shared sounds created by the user or all sounds to which this user has access to. Default value: true.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetSharedSoundsResponse

Type: PBXData:UserSounds

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

Description: Get inherited sounds: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetSharedSoundsResponse" type="PBXData:UserSounds">
  <xs:annotation>
    <xs:documentation>Get inherited sounds: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetFileLanguages

GetFileLanguages

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

Description: Get list of languages for a sound file: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:ID	common:ID	Sound file id

XSD Source

<xs:element name="GetFileLanguages">
  <xs:annotation>
    <xs:documentation>Get list of languages for a sound file: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Sound file id</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetFileLanguagesResponse

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

Description: Get list of languages for a sound file:response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
languages	inline (0..*)	Available languages for sound file
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetFileLanguagesResponse">
  <xs:annotation>
    <xs:documentation>Get list of languages for a sound file:response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="languages" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available languages for sound file</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetFolders

GetFolders

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

Description: Get client list of folders: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
musicOnHold	common:integer (optional)	0: folders that do not contain music on hold, 1: folders

						that contain only music on hold, -1: all folders. Default
						0. |

| emptyFolder | common:integer (optional) | 0: all folders, 1: non empty folders. Default 0. | | (choice) | | One of the following | | └ common:userID | common:userID | | | └ common:userIdentifier | common:userIdentifier | |

XSD Source

<xs:element name="GetFolders">
  <xs:annotation>
    <xs:documentation>Get client list of folders: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="musicOnHold" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>0: folders that do not contain music on hold, 1: folders
							that contain only music on hold, -1: all folders. Default
							0.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="emptyFolder" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>0: all folders, 1: non empty folders. Default
							0.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetFoldersResponse

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

Description: Get client list of folders:response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
folders	PBXData:Folders (0..*)	Available client folders
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetFoldersResponse">
  <xs:annotation>
    <xs:documentation>Get client list of folders:response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="folders" type="PBXData:Folders" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available client folders</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

AddCustomAlert

AddCustomAlert

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

Description: Add custom alert: request

Properties

Property	Value
content	complex

Extends

Base type: data:CustomAlert

Elements

Element	Type	Description
PBXData:severity	PBXData:severity (optional)
(choice)		One of the following
└ common:userID	common:userID	Custom alert owner ID
└ common:userIdentifier	common:userIdentifier	Custom alert owner

									identifier |

XSD Source

<xs:element name="AddCustomAlert">
  <xs:annotation>
    <xs:documentation>Add custom alert: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:CustomAlert">
          <xs:sequence>
            <xs:element name="PBXData:severity" type="PBXData:severity" minOccurs="0"/>
            <xs:choice>
              <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
              <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddCustomAlertResponse

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

Description: Add custom alert: response

Properties

Property	Value
content	complex

Extends

Base type: common:updateObject

Elements

Element	Type	Description
code	common:string (optional)	Custom alert code

XSD Source

<xs:element name="AddCustomAlertResponse">
  <xs:annotation>
    <xs:documentation>Add custom alert: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateObject">
          <xs:sequence>
            <xs:element name="code" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Custom alert code</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

EditCustomAlert

EditCustomAlert

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

Description: Edit custom alert: request

Properties

Property	Value
content	complex

Extends

Base type: data:CustomAlert

XSD Source

<xs:element name="EditCustomAlert">
  <xs:annotation>
    <xs:documentation>Edit custom alert: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:CustomAlert">
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditCustomAlertResponse

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

Description: Edit custom alert: response

Properties

Property	Value
content	complex

Extends

Base type: common:updateObject

Elements

Element	Type	Description
code	common:string (optional)	Custom alert code

XSD Source

<xs:element name="EditCustomAlertResponse">
  <xs:annotation>
    <xs:documentation>Edit custom alert: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateObject">
          <xs:sequence>
            <xs:element name="code" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Custom alert code</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

GetCustomAlerts

GetCustomAlerts

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

Description: Get custom alerts: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:displayLevel	PBXData:displayLevel (optional)
filter	common:string (optional)
(choice)		One of the following
└ common:userID	common:userID	Custom alert owner ID
└ common:userIdentifier	common:userIdentifier	Custom alert owner identifier

XSD Source

<xs:element name="GetCustomAlerts">
  <xs:annotation>
    <xs:documentation>Get custom alerts: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:displayLevel" type="PBXData:displayLevel" minOccurs="0"/>
        <xs:element name="filter" type="common:string" minOccurs="0"/>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetCustomAlertsResponse

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

Description: Get custom alerts: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
button	inline (0..*)	Available custom buttons
common:userID	common:userID (optional)	Custom alert owner ID
common:userIdentifier	common:userIdentifier (optional)	Custom alert owner identifier
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetCustomAlertsResponse">
  <xs:annotation>
    <xs:documentation>Get custom alerts: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="button" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available custom buttons</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:userID" type="common:userID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Custom alert owner ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Custom alert owner identifier</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

DelCustomAlert

DelCustomAlert

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

Description: Get custom alerts: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
code	common:string (1..*)

XSD Source

<xs:element name="DelCustomAlert">
  <xs:annotation>
    <xs:documentation>Get custom alerts: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="common:string" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelCustomAlertResponse

Type: common:delObject

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

Description: Get custom alerts: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="DelCustomAlertResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Get custom alerts: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

SetCustomAlertStatus

SetCustomAlertStatus

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

Description: Get custom alerts: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
code	common:string
status	common:boolean

XSD Source

<xs:element name="SetCustomAlertStatus">
  <xs:annotation>
    <xs:documentation>Get custom alerts: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="common:string"/>
        <xs:element name="status" type="common:boolean"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetCustomAlertStatusResponse

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

Description: Get custom alerts: response

Properties

Property	Value
content	complex

Extends

Base type: common:updateObject

Elements

Element	Type	Description
code	common:string (optional)	Custom button code

XSD Source

<xs:element name="SetCustomAlertStatusResponse">
  <xs:annotation>
    <xs:documentation>Get custom alerts: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateObject">
          <xs:sequence>
            <xs:element name="code" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Custom button code</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

AddCustomButton

AddCustomButton

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

Description: Add custom button: request

Properties

Property	Value
content	complex

Extends

Base type: data:CustomButton

Elements

Element	Type	Description
(choice)		One of the following
└ common:userID	common:userID	Custom alert owner ID
└ common:userIdentifier	common:userIdentifier	Custom alert owner

									identifier |

XSD Source

<xs:element name="AddCustomButton">
  <xs:annotation>
    <xs:documentation>Add custom button: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:CustomButton">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
              <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddCustomButtonResponse

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

Description: Add custom button: response

Properties

Property	Value
content	complex

Extends

Base type: common:updateObject

Elements

Element	Type	Description
code	common:string (optional)	Custom alert code

XSD Source

<xs:element name="AddCustomButtonResponse">
  <xs:annotation>
    <xs:documentation>Add custom button: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateObject">
          <xs:sequence>
            <xs:element name="code" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Custom alert code</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

EditCustomButton

EditCustomButton

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

Description: Edit custom button: request

Properties

Property	Value
content	complex

Extends

Base type: data:CustomButton

Elements

Element	Type	Description
(choice)		One of the following
└ common:userID	common:userID	Custom alert owner ID
└ common:userIdentifier	common:userIdentifier	Custom alert owner identifier

XSD Source

<xs:element name="EditCustomButton">
  <xs:annotation>
    <xs:documentation>Edit custom button: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:CustomButton">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
              <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditCustomButtonResponse

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

Description: Edit custom button: response

Properties

Property	Value
content	complex

Extends

Base type: common:updateObject

Elements

Element	Type	Description
code	common:string (optional)	Custom alert code

XSD Source

<xs:element name="EditCustomButtonResponse">
  <xs:annotation>
    <xs:documentation>Edit custom button: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateObject">
          <xs:sequence>
            <xs:element name="code" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Custom alert code</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

GetCustomButtons

GetCustomButtons

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

Description: Get custom button: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
filter	common:string (optional)
(choice)		One of the following
└ common:userID	common:userID	Custom alert owner ID
└ common:userIdentifier	common:userIdentifier	Custom alert owner identifier

XSD Source

<xs:element name="GetCustomButtons">
  <xs:annotation>
    <xs:documentation>Get custom button: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="filter" type="common:string" minOccurs="0"/>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetCustomButtonsResponse

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

Description: Get custom button: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
button	inline (0..*)	Available custom buttons
common:userID	common:userID (optional)	Custom alert owner ID
common:userIdentifier	common:userIdentifier (optional)	Custom alert owner identifier
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetCustomButtonsResponse">
  <xs:annotation>
    <xs:documentation>Get custom button: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="button" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available custom buttons</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:userID" type="common:userID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Custom alert owner ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Custom alert owner identifier</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

DelCustomButton

DelCustomButton

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

Description: Get custom button: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
code	common:string (1..*)

XSD Source

<xs:element name="DelCustomButton">
  <xs:annotation>
    <xs:documentation>Get custom button: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="common:string" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelCustomButtonResponse

Type: common:delObject

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

Description: Get custom button: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="DelCustomButtonResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Get custom button: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

SetCustomButtonStatus

SetCustomButtonStatus

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

Description: Get custom button: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
code	common:string
status	common:boolean

XSD Source

<xs:element name="SetCustomButtonStatus">
  <xs:annotation>
    <xs:documentation>Get custom button: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="common:string"/>
        <xs:element name="status" type="common:boolean"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetCustomButtonStatusResponse

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

Description: Get custom button: response

Properties

Property	Value
content	complex

Extends

Base type: common:updateObject

Elements

Element	Type	Description
code	common:string (optional)	Custom button code

XSD Source

<xs:element name="SetCustomButtonStatusResponse">
  <xs:annotation>
    <xs:documentation>Get custom button: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateObject">
          <xs:sequence>
            <xs:element name="code" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Custom button code</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

UpdateLicense

UpdateLicense

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

Description: Update license on 4PSA VoipNow server: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
activationCode	common:string	Activation code for license update

XSD Source

<xs:element name="UpdateLicense">
  <xs:annotation>
    <xs:documentation>Update license on 4PSA VoipNow server: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="activationCode" type="common:string">
          <xs:annotation>
            <xs:documentation>Activation code for license update</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

UpdateLicenseResponse

Type: common:updateObject

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

Description: Update license on 4PSA VoipNow server: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="UpdateLicenseResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update license on 4PSA VoipNow server: response</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetDevices

GetDevices

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

Description: Get all devices that are provisioned.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		One of the following
└ ownerID	common:positiveInteger	ID of the owner of the device

XSD Source

<xs:element name="GetDevices">
  <xs:annotation>
    <xs:documentation>Get all devices that are provisioned.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="ownerID" type="common:positiveInteger" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetDevicesResponse

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

Description: Get devices response operation

Properties

Property	Value
content	complex

Elements

Element	Type	Description
devices	inline (0..*)
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetDevicesResponse">
  <xs:annotation>
    <xs:documentation>Get devices response operation</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="devices" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetDeviceDetails

GetDeviceDetails

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

Description: Get specific device detailed data: request operation

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		One of the following
└ PBXData:deviceID	PBXData:deviceID
└ PBXData:serial	PBXData:serial

XSD Source

<xs:element name="GetDeviceDetails">
  <xs:annotation>
    <xs:documentation>Get specific device detailed data: request operation</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="PBXData:deviceID" type="PBXData:deviceID" minOccurs="0"/>
          <xs:element name="PBXData:serial" type="PBXData:serial" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetDeviceDetailsResponse

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

Description: Get specific device detailed data: response operation

Properties

Property	Value
content	complex

Elements

Element	Type	Description
device	inline (optional)
common:notice	common:notice (0..*)

XSD Source

<xs:element name="GetDeviceDetailsResponse">
  <xs:annotation>
    <xs:documentation>Get specific device detailed data: response operation</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="device" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

AddDevice

AddDevice

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

Description: Add a new device to the system

Properties

Property	Value
content	complex

Extends

Base type: data:DeviceInfo

Elements

Element	Type	Description
ownerID	common:positiveInteger (optional)	Id of the owner
PBXData:assignedOrganizationID	PBXData:assignedOrganizationID (optional)
assignedExtensions	data:DeviceExtension (0..*)	IDs of the extensions associated with the device

XSD Source

<xs:element name="AddDevice">
  <xs:annotation>
    <xs:documentation>Add a new device to the system</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:DeviceInfo">
          <xs:sequence>
            <xs:element name="ownerID" type="common:positiveInteger" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Id of the owner</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="PBXData:assignedOrganizationID" type="PBXData:assignedOrganizationID" minOccurs="0"/>
            <xs:element name="assignedExtensions" type="data:DeviceExtension" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>IDs of the extensions associated with the device</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddDeviceResponse

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

Description: Add device operation response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:deviceID	PBXData:deviceID (optional)
PBXData:serial	PBXData:serial (optional)
extensionData:location	extensionData:location (optional)	The provisioning file location
common:notice	common:notice (0..*)

XSD Source

<xs:element name="AddDeviceResponse">
  <xs:annotation>
    <xs:documentation>Add device operation response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:deviceID" type="PBXData:deviceID" minOccurs="0"/>
        <xs:element name="PBXData:serial" type="PBXData:serial" minOccurs="0"/>
        <xs:element name="extensionData:location" type="extensionData:location" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The provisioning file location</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

EditDevice

EditDevice

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

Description: Get all devices that are provisioned.

Properties

Property	Value
content	complex

Extends

Base type: data:DeviceInfo

Elements

Element	Type	Description
PBXData:deviceID	PBXData:deviceID
ownerID	common:positiveInteger (optional)	Id of the owner
PBXData:assignedOrganizationID	PBXData:assignedOrganizationID (optional)
assignedExtensions	data:DeviceExtension (0..*)	IDs of the extensions associated with the device

XSD Source

<xs:element name="EditDevice">
  <xs:annotation>
    <xs:documentation>Get all devices that are provisioned.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:DeviceInfo">
          <xs:sequence>
            <xs:element name="PBXData:deviceID" type="PBXData:deviceID"/>
            <xs:element name="ownerID" type="common:positiveInteger" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Id of the owner</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="PBXData:assignedOrganizationID" type="PBXData:assignedOrganizationID" minOccurs="0"/>
            <xs:element name="assignedExtensions" type="data:DeviceExtension" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>IDs of the extensions associated with the device</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditDeviceResponse

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

Description: Edit device operation response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:deviceID	PBXData:deviceID (optional)
PBXData:serial	PBXData:serial (optional)
extensionData:location	extensionData:location (optional)	The provisioning file location
common:notice	common:notice (0..*)

XSD Source

<xs:element name="EditDeviceResponse">
  <xs:annotation>
    <xs:documentation>Edit device operation response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:deviceID" type="PBXData:deviceID" minOccurs="0"/>
        <xs:element name="PBXData:serial" type="PBXData:serial" minOccurs="0"/>
        <xs:element name="extensionData:location" type="extensionData:location" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The provisioning file location</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

GetEquipmentList

GetEquipmentList

Type: xs:string

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

Description: Phone brand and model: request

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetEquipmentList" type="xs:string">
  <xs:annotation>
    <xs:documentation>Phone brand and model: request</xs:documentation>
  </xs:annotation>
</xs:element>

GetEquipmentListResponse

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

Description: Phone brand and model: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
equipment	extensionData:Equipments (0..*)

XSD Source

<xs:element name="GetEquipmentListResponse">
  <xs:annotation>
    <xs:documentation>Phone brand and model: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="equipment" type="extensionData:Equipments" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

---

DelDevice

DelDevice

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

Description: Delete extensions: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
PBXData:deviceID	PBXData:deviceID (1..*)

XSD Source

<xs:element name="DelDevice">
  <xs:annotation>
    <xs:documentation>Delete extensions: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PBXData:deviceID" type="PBXData:deviceID" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelDeviceResponse

Type: common:delObject

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

Description: Delete extensions: response

Properties

Property	Value
content	complex

XSD Source

<xs:element name="DelDeviceResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete extensions: response</xs:documentation>
  </xs:annotation>
</xs:element>

---