Documentation for PBXMessages

Table of Contents

top

Schema Document Properties

Target Namespace http://4psa.com/PBXMessages.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/PBXMessages.xsd/2.0.0
common http://4psa.com/Common.xsd/2.0.0
xml http://www.w3.org/XML/1998/namespace
messagesInfo http://4psa.com/PBXMessagesInfo.xsd/2.0.0
xs http://www.w3.org/2001/XMLSchema
data http://4psa.com/PBXData.xsd/2.0.0
Schema Component Representation
<xs:schema targetNamespace="http://4psa.com/PBXMessages.xsd/2.0.0" elementFormDefault="qualified" id="PBXMessages">
<xs:import namespace="http://4psa.com/PBXData.xsd/2.0.0" schemaLocation="PBXData.xsd"/>
<xs:import namespace="http://4psa.com/PBXMessagesInfo.xsd/2.0.0" schemaLocation="PBXMessagesInfo.xsd"/>
<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: AddCustomAlertRequest

Name AddCustomAlertRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add custom alert: request
Logical Diagram
XML Instance Representation
<AddCustomAlertRequest>
<code> common:string </code> [0..1]
<text> common:string </text> [0..1]
<priority> common:integer </priority> [0..1]
<displayMethod> xs:string (value comes from list: {'inherit'|'select'}) </displayMethod> [0..1]

'Possible values: inherit, select. Display method'

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

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

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

'Display on owner account'

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

'Custom button expiration date'

<severity> xs:string (value comes from list: {'0'|'4'|'7'}) </severity> [0..1]

'Possible values: 7 - info, 4 - warning, 0 - error'

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

'Custom alert owner ID'

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

'Custom alert owner identifier'

End Choice
</AddCustomAlertRequest>
Schema Component Representation
<xs:element name="AddCustomAlertRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" data:CustomAlert ">
<xs:sequence>
<xs:element name="severity" default="7" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="0"/>
<xs:enumeration value="4"/>
<xs:enumeration value="7"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddCustomAlertResponse

Name AddCustomAlertResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add custom alert: response
Logical Diagram
XML Instance Representation
<AddCustomAlertResponse>
<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..*]
<code> common:string </code> [0..1]

'Custom alert code'

</AddCustomAlertResponse>
Schema Component Representation
<xs:element name="AddCustomAlertResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" common:updateObject ">
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddCustomButtonRequest

Name AddCustomButtonRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add custom button: request
Logical Diagram
XML Instance Representation
<AddCustomButtonRequest>
<!-- ' CustomAlert ' super type was not found in this schema. Some elements and attributes may be missing. -->
<URL> common:domain </URL> [0..1]
<location> xs:string (value comes from list: {'navigation'|'content'}) </location> [0..1]

'Possible values: navigation, content.'

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

'Possible values: newWindow, currentWindow.'

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

'Include reseller ID: reseller_id'

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

'Include client ID: client_id'

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

'Include endpoint ID: extension_id'

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

'Include endpoint internal number: extension_inumber'

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

'Include endpoint public numbe: extension_pnumber'

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

'Include charging plan: billing_plan'

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

'Custom alert owner ID'

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

'Custom alert owner identifier'

End Choice
</AddCustomButtonRequest>
Schema Component Representation
<xs:element name="AddCustomButtonRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" data:CustomButton ">
<xs:sequence>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddCustomButtonResponse

Name AddCustomButtonResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add custom button: response
Logical Diagram
XML Instance Representation
<AddCustomButtonResponse>
<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..*]
<code> common:string </code> [0..1]

'Custom alert code'

</AddCustomButtonResponse>
Schema Component Representation
<xs:element name="AddCustomButtonResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" common:updateObject ">
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddTimeIntervalBlockRequest

Name AddTimeIntervalBlockRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add time interval block: request.
Logical Diagram
XML Instance Representation
<AddTimeIntervalBlockRequest>
<name> common:string </name> [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.'

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

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

<timeInterval> data:TimeInterval </timeInterval> [1..*]

'Time intervals'

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

'Time interval owner ID'

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

'Time interval owner identifier'

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

'Time interval owner login'

End Choice
</AddTimeIntervalBlockRequest>
Schema Component Representation
<xs:element name="AddTimeIntervalBlockRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type=" common:string "/>
<xs:element name="type" default="interval" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="interval"/>
<xs:enumeration value="day"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="timezone" type=" common:positiveInteger " minOccurs="0"/>
<xs:sequence>
<xs:element name="timeInterval" type=" data:TimeInterval " maxOccurs="unbounded"/>
</xs:sequence>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
<xs:element name="userLogin" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AddTimeIntervalBlockResponse

Name AddTimeIntervalBlockResponse
Type messagesInfo:UpdateObjectResponseType
Nillable no
Abstract no
Documentation Add time interval block: response.
Logical Diagram
XML Instance Representation
<AddTimeIntervalBlockResponse>
<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..*]
</AddTimeIntervalBlockResponse>
Schema Component Representation
<xs:element name="AddTimeIntervalBlockResponse" type=" messagesInfo:UpdateObjectResponseType "/>
top

Element: AddTimeIntervalRequest

Name AddTimeIntervalRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add time interval: request.
Logical Diagram
XML Instance Representation
<AddTimeIntervalRequest>
<ID> common:positiveInteger </ID> [1]

'Time interval block ID'

<timeInterval> data:TimeInterval </timeInterval> [1..*]

'Matching time intervals'

</AddTimeIntervalRequest>
Schema Component Representation
<xs:element name="AddTimeIntervalRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="timeInterval" type=" data:TimeInterval " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AddTimeIntervalResponse

Name AddTimeIntervalResponse
Type messagesInfo:UpdateObjectResponseType
Nillable no
Abstract no
Documentation Add time interval: response.
Logical Diagram
XML Instance Representation
<AddTimeIntervalResponse>
<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..*]
</AddTimeIntervalResponse>
Schema Component Representation
<xs:element name="AddTimeIntervalResponse" type=" messagesInfo:UpdateObjectResponseType "/>
top

Element: DelCustomAlertRequest

Name DelCustomAlertRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom alerts: request
Logical Diagram
XML Instance Representation
<DelCustomAlertRequest>
<code> common:string </code> [1..*]
</DelCustomAlertRequest>
Schema Component Representation
<xs:element name="DelCustomAlertRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:string " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelCustomAlertResponse

Name DelCustomAlertResponse
Type common:delObject
Nillable no
Abstract no
Documentation Get custom alerts: response
Logical Diagram
XML Instance Representation
<DelCustomAlertResponse>
<items> xs:integer </items> [0..1]

'Number of affected items'

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

'Operation result'

</DelCustomAlertResponse>
Schema Component Representation
<xs:element name="DelCustomAlertResponse" type=" common:delObject "/>
top

Element: DelCustomButtonRequest

Name DelCustomButtonRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom button: request
Logical Diagram
XML Instance Representation
<DelCustomButtonRequest>
<code> common:string </code> [1..*]
</DelCustomButtonRequest>
Schema Component Representation
<xs:element name="DelCustomButtonRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:string " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelCustomButtonResponse

Name DelCustomButtonResponse
Type common:delObject
Nillable no
Abstract no
Documentation Get custom button: response
Logical Diagram
XML Instance Representation
<DelCustomButtonResponse>
<items> xs:integer </items> [0..1]

'Number of affected items'

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

'Operation result'

</DelCustomButtonResponse>
Schema Component Representation
<xs:element name="DelCustomButtonResponse" type=" common:delObject "/>
top

Element: DelTimeIntervalBlockRequest

Name DelTimeIntervalBlockRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete time interval block: request
Logical Diagram
XML Instance Representation
<DelTimeIntervalBlockRequest>
<ID> common:positiveInteger </ID> [1..*]

'Time interval block ID'

</DelTimeIntervalBlockRequest>
Schema Component Representation
<xs:element name="DelTimeIntervalBlockRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelTimeIntervalBlockResponse

Name DelTimeIntervalBlockResponse
Type common:delObject
Nillable no
Abstract no
Documentation Delete time interval block: response
Logical Diagram
XML Instance Representation
<DelTimeIntervalBlockResponse>
<items> xs:integer </items> [0..1]

'Number of affected items'

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

'Operation result'

</DelTimeIntervalBlockResponse>
Schema Component Representation
<xs:element name="DelTimeIntervalBlockResponse" type=" common:delObject "/>
top

Element: DelTimeIntervalRequest

Name DelTimeIntervalRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete time interval from block: request
Logical Diagram
XML Instance Representation
<DelTimeIntervalRequest>
<ID> common:positiveInteger </ID> [1]

'Time interval block ID'

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

'Time interval ID'

</DelTimeIntervalRequest>
Schema Component Representation
<xs:element name="DelTimeIntervalRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="intervalID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelTimeIntervalResponse

Name DelTimeIntervalResponse
Type common:delObject
Nillable no
Abstract no
Documentation Delete time interval from block: response
Logical Diagram
XML Instance Representation
<DelTimeIntervalResponse>
<items> xs:integer </items> [0..1]

'Number of affected items'

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

'Operation result'

</DelTimeIntervalResponse>
Schema Component Representation
<xs:element name="DelTimeIntervalResponse" type=" common:delObject "/>
top

Element: EditCustomAlertRequest

Name EditCustomAlertRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit custom alert: request
Logical Diagram
XML Instance Representation
<EditCustomAlertRequest>
<code> common:string </code> [0..1]
<text> common:string </text> [0..1]
<priority> common:integer </priority> [0..1]
<displayMethod> xs:string (value comes from list: {'inherit'|'select'}) </displayMethod> [0..1]

'Possible values: inherit, select. Display method'

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

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

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

'Display on owner account'

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

'Custom button expiration date'

</EditCustomAlertRequest>
Schema Component Representation
<xs:element name="EditCustomAlertRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" data:CustomAlert "/>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditCustomAlertResponse

Name EditCustomAlertResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit custom alert: response
Logical Diagram
XML Instance Representation
<EditCustomAlertResponse>
<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..*]
<code> common:string </code> [0..1]

'Custom alert code'

</EditCustomAlertResponse>
Schema Component Representation
<xs:element name="EditCustomAlertResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" common:updateObject ">
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditCustomButtonRequest

Name EditCustomButtonRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit custom button: request
Logical Diagram
XML Instance Representation
<EditCustomButtonRequest>
<!-- ' CustomAlert ' super type was not found in this schema. Some elements and attributes may be missing. -->
<URL> common:domain </URL> [0..1]
<location> xs:string (value comes from list: {'navigation'|'content'}) </location> [0..1]

'Possible values: navigation, content.'

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

'Possible values: newWindow, currentWindow.'

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

'Include reseller ID: reseller_id'

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

'Include client ID: client_id'

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

'Include endpoint ID: extension_id'

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

'Include endpoint internal number: extension_inumber'

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

'Include endpoint public numbe: extension_pnumber'

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

'Include charging plan: billing_plan'

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

'Custom alert owner ID'

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

'Custom alert owner identifier'

End Choice
</EditCustomButtonRequest>
Schema Component Representation
<xs:element name="EditCustomButtonRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" data:CustomButton ">
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditCustomButtonResponse

Name EditCustomButtonResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit custom button: response
Logical Diagram
XML Instance Representation
<EditCustomButtonResponse>
<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..*]
<code> common:string </code> [0..1]

'Custom alert code'

</EditCustomButtonResponse>
Schema Component Representation
<xs:element name="EditCustomButtonResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" common:updateObject ">
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditTimeIntervalBlockRequest

Name EditTimeIntervalBlockRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit time interval block: request.
Logical Diagram
XML Instance Representation
<EditTimeIntervalBlockRequest>
<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.'

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

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

</EditTimeIntervalBlockRequest>
Schema Component Representation
<xs:element name="EditTimeIntervalBlockRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="type" default="interval" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="interval"/>
<xs:enumeration value="day"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="timezone" type=" common:positiveInteger " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: EditTimeIntervalBlockResponse

Name EditTimeIntervalBlockResponse
Type messagesInfo:UpdateObjectResponseType
Nillable no
Abstract no
Documentation Edit time interval block: response.
Logical Diagram
XML Instance Representation
<EditTimeIntervalBlockResponse>
<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..*]
</EditTimeIntervalBlockResponse>
Schema Component Representation
<xs:element name="EditTimeIntervalBlockResponse" type=" messagesInfo:UpdateObjectResponseType "/>
top

Element: EditTimeIntervalRequest

Name EditTimeIntervalRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit time interval: request.
Logical Diagram
XML Instance Representation
<EditTimeIntervalRequest>
<startTime> xs:time </startTime> [0..1]

'Start time in format: 00:00.'

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

'End time in format: 00:00.'

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

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

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

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

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

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

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

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

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

'Month'

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

'Time interval block ID'

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

'Time interval ID'

</EditTimeIntervalRequest>
Schema Component Representation
<xs:element name="EditTimeIntervalRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" data:TimeInterval ">
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="intervalID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditTimeIntervalResponse

Name EditTimeIntervalResponse
Type messagesInfo:UpdateObjectResponseType
Nillable no
Abstract no
Documentation Edit time interval: response.
Logical Diagram
XML Instance Representation
<EditTimeIntervalResponse>
<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..*]
</EditTimeIntervalResponse>
Schema Component Representation
<xs:element name="EditTimeIntervalResponse" type=" messagesInfo:UpdateObjectResponseType "/>
top

Element: EnrollRequest

Name EnrollRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Enroll 4PSA VoipNow in third-party applications: request
Logical Diagram
XML Instance Representation
<EnrollRequest>
<scope> common:string </scope> [1]

'The enrollment scope. Scope:automation is reserved for 4PSA VoipNow Automation'

<URL> common:domain </URL> [1]

'IP/URL of the infrastructure controller that enrolls (master host)'

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

'Authentication key of the master'

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

'Authentication type of the master'

<param> [0..64]

'Pairs of name/value parameters'


Start Sequence [1..*]
<name> common:string </name> [0..1]
<value> xs:string </value> [0..1]
End Sequence
</param>
</EnrollRequest>
Schema Component Representation
<xs:element name="EnrollRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="scope" type=" common:string "/>
<xs:element name="URL" type=" common:domain "/>
<xs:element name="masterAuth" type=" common:string "/>
<xs:element name="masterAuthType" type=" common:string "/>
<xs:element name="param" minOccurs="0" maxOccurs="64">
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="value" type=" xs:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: EnrollResponse

Name EnrollResponse
Type messagesInfo:EnrollmentResponseType
Nillable no
Abstract no
Documentation Enroll 4PSA VoipNow in third-party applications: response
Logical Diagram
XML Instance Representation
<EnrollResponse>
<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..*]
</EnrollResponse>
Schema Component Representation
<xs:element name="EnrollResponse" type=" messagesInfo:EnrollmentResponseType "/>
top

Element: GetCustomAlertsRequest

Name GetCustomAlertsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom alerts: request
Logical Diagram
XML Instance Representation
<GetCustomAlertsRequest>
Start Choice [1]
<userID> common:positiveInteger </userID> [0..1]

'Custom alert owner ID'

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

'Custom alert owner identifier'

End Choice
<displayLevel> xs:string (value comes from list: {'admin'|'reseller'|'client'|'extension'}) </displayLevel> [0..1]

'Display Level'

<filter> common:string </filter> [0..1]
</GetCustomAlertsRequest>
Schema Component Representation
<xs:element name="GetCustomAlertsRequest">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:element name="displayLevel" default="admin" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="admin"/>
<xs:enumeration value="reseller"/>
<xs:enumeration value="client"/>
<xs:enumeration value="extension"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetCustomAlertsResponse

Name GetCustomAlertsResponse
Type messagesInfo:GetCustomAlertsResponseType
Nillable no
Abstract no
Documentation Get custom alerts: response
Logical Diagram
XML Instance Representation
<GetCustomAlertsResponse>
<button> [0..*]

'Available custom buttons'


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

'Possible values: inherit, select. Display method'

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

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

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

'Display on owner account'

<expiration> common:unlimitedDate </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..*]
</GetCustomAlertsResponse>
Schema Component Representation
<xs:element name="GetCustomAlertsResponse" type=" messagesInfo:GetCustomAlertsResponseType "/>
top

Element: GetCustomButtonsRequest

Name GetCustomButtonsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom button: request
Logical Diagram
XML Instance Representation
<GetCustomButtonsRequest>
Start Choice [1]
<userID> common:positiveInteger </userID> [0..1]

'Custom alert owner ID'

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

'Custom alert owner identifier'

End Choice
<filter> common:string </filter> [0..1]
</GetCustomButtonsRequest>
Schema Component Representation
<xs:element name="GetCustomButtonsRequest">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetCustomButtonsResponse

Name GetCustomButtonsResponse
Type messagesInfo:GetCustomButtonsResponseType
Nillable no
Abstract no
Documentation Get custom button: response
Logical Diagram
XML Instance Representation
<GetCustomButtonsResponse>
<button> [0..*]

'Available custom buttons'


<!-- ' CustomAlert ' super type was not found in this schema. Some elements and attributes may be missing. -->
<URL> common:domain </URL> [0..1]
<location> xs:string (value comes from list: {'navigation'|'content'}) </location> [0..1]

'Possible values: navigation, content.'

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

'Possible values: newWindow, currentWindow.'

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

'Include reseller ID: reseller_id'

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

'Include client ID: client_id'

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

'Include endpoint ID: extension_id'

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

'Include endpoint internal number: extension_inumber'

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

'Include endpoint public numbe: extension_pnumber'

<includeChargingPlanID> common:boolean </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..*]
</GetCustomButtonsResponse>
Schema Component Representation
<xs:element name="GetCustomButtonsResponse" type=" messagesInfo:GetCustomButtonsResponseType "/>
top

Element: GetFileLanguagesRequest

Name GetFileLanguagesRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get list of languages for a sound file: request
Logical Diagram
XML Instance Representation
<GetFileLanguagesRequest>
<ID> common:positiveInteger </ID> [1]

'Sound file id'

</GetFileLanguagesRequest>
Schema Component Representation
<xs:element name="GetFileLanguagesRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetFileLanguagesResponse

Name GetFileLanguagesResponse
Type messagesInfo:GetFileLanguagesResponseType
Nillable no
Abstract no
Documentation Get list of languages for a sound file:response
Logical Diagram
XML Instance Representation
<GetFileLanguagesResponse>
<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..*]
</GetFileLanguagesResponse>
Schema Component Representation
<xs:element name="GetFileLanguagesResponse" type=" messagesInfo:GetFileLanguagesResponseType "/>
top

Element: GetFoldersRequest

Name GetFoldersRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get client list of folders: request
Logical Diagram
XML Instance Representation
<GetFoldersRequest>
<emptyFolder> common:integer </emptyFolder> [0..1]

'0: all folders, 1: non empty folders. Default 0.'

</GetFoldersRequest>
Schema Component Representation
<xs:element name="GetFoldersRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="emptyFolder" type=" common:integer " default="0" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetFoldersResponse

Name GetFoldersResponse
Type messagesInfo:GetFoldersResponseType
Nillable no
Abstract no
Documentation Get client list of folders:response
Logical Diagram
XML Instance Representation
<GetFoldersResponse>
<folders> PBXData:Folders </folders> [0..*]

'Available client folders'

<notice> common:notice </notice> [0..*]
</GetFoldersResponse>
Schema Component Representation
<xs:element name="GetFoldersResponse" type=" messagesInfo:GetFoldersResponseType "/>
top

Element: GetInterfaceLangRequest

Name GetInterfaceLangRequest
Type common:string
Nillable no
Abstract no
Documentation Get available interface languages: request
Logical Diagram
XML Instance Representation
<GetInterfaceLangRequest> common:string </GetInterfaceLangRequest>
Schema Component Representation
<xs:element name="GetInterfaceLangRequest" type=" common:string "/>
top

Element: GetInterfaceLangResponse

Name GetInterfaceLangResponse
Type messagesInfo:GetInterfaceLangResponseType
Nillable no
Abstract no
Documentation Get available interface languages: response
Logical Diagram
XML Instance Representation
<GetInterfaceLangResponse>
<interfaceLang> PBXData:Language </interfaceLang> [0..*]

'Available interface languages on success'

<notice> common:notice </notice> [0..*]
</GetInterfaceLangResponse>
Schema Component Representation
<xs:element name="GetInterfaceLangResponse" type=" messagesInfo:GetInterfaceLangResponseType "/>
top

Element: GetPhoneLangRequest

Name GetPhoneLangRequest
Type common:string
Nillable no
Abstract no
Documentation Get the list with available phone languages: request
Logical Diagram
XML Instance Representation
<GetPhoneLangRequest> common:string </GetPhoneLangRequest>
Schema Component Representation
<xs:element name="GetPhoneLangRequest" type=" common:string "/>
top

Element: GetPhoneLangResponse

Name GetPhoneLangResponse
Type messagesInfo:GetPhoneLangResponseType
Nillable no
Abstract no
Documentation Get the list with available phone languages: response
Logical Diagram
XML Instance Representation
<GetPhoneLangResponse>
<phoneLang> PBXData:Language </phoneLang> [0..*]

'A list with available phone languages on success'

<notice> common:notice </notice> [0..*]
</GetPhoneLangResponse>
Schema Component Representation
<xs:element name="GetPhoneLangResponse" type=" messagesInfo:GetPhoneLangResponseType "/>
top

Element: GetRegionsRequest

Name GetRegionsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get all available regions for a country: request
Logical Diagram
XML Instance Representation
<GetRegionsRequest>
<code> common:string </code> [1]

'Country code'

</GetRegionsRequest>
Schema Component Representation
<xs:element name="GetRegionsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:string "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetRegionsResponse

Name GetRegionsResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get all available regions for a country: response
Logical Diagram
XML Instance Representation
<GetRegionsResponse>
<region> [0..*]
Start Sequence [0..1]
<ID> common:positiveInteger </ID> [0..1]
<name> common:string </name> [0..1]

'Region name'

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

'Default region for chosen country'

End Sequence
</region>
<notice> common:notice </notice> [0..*]
</GetRegionsResponse>
Schema Component Representation
<xs:element name="GetRegionsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="region" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="default" type=" common:boolean " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetSchemaVersionsRequest

Name GetSchemaVersionsRequest
Type common:string
Nillable no
Abstract no
Documentation Get all available schema versions: request
Logical Diagram
XML Instance Representation
<GetSchemaVersionsRequest> common:string </GetSchemaVersionsRequest>
Schema Component Representation
<xs:element name="GetSchemaVersionsRequest" type=" common:string "/>
top

Element: GetSchemaVersionsResponse

Name GetSchemaVersionsResponse
Type messagesInfo:GetSchemaVersionsResponseType
Nillable no
Abstract no
Documentation Get all available schema versions: response
Logical Diagram
XML Instance Representation
<GetSchemaVersionsResponse>
<versions> common:string </versions> [0..*]

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

</GetSchemaVersionsResponse>
Schema Component Representation
<xs:element name="GetSchemaVersionsResponse" type=" messagesInfo:GetSchemaVersionsResponseType "/>
top

Element: GetSoundsRequest

Name GetSoundsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get client sounds: request
Logical Diagram
XML Instance Representation
<GetSoundsRequest>
Start Choice [1]
<folderID> common:positiveInteger </folderID> [0..1]

'Set 0 for all folders.'

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

'Set 0 for all files.'

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

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

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

'Default -1.'

End Choice
</GetSoundsRequest>
Schema Component Representation
<xs:element name="GetSoundsRequest">
<xs:complexType>
<xs:choice>
<xs:sequence>
<xs:element name="folderID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="languageID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="system" type=" common:integer " default="-1" minOccurs="0"/>
<xs:element name="status" type=" common:integer " default="-1" minOccurs="0"/>
</xs:sequence>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: GetSoundsResponse

Name GetSoundsResponse
Type messagesInfo:GetSoundsResponseType
Nillable no
Abstract no
Documentation Get client sounds: response
Logical Diagram
XML Instance Representation
<GetSoundsResponse>
<sounds> PBXData:Sounds </sounds> [0..*]

'Sounds'

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

'User ID'

<notice> common:notice </notice> [0..*]
</GetSoundsResponse>
Schema Component Representation
<xs:element name="GetSoundsResponse" type=" messagesInfo:GetSoundsResponseType "/>
top

Element: GetTemplatesRequest

Name GetTemplatesRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get user templates list: request
Logical Diagram
XML Instance Representation
<GetTemplatesRequest>
Start Choice [1]

'Either of'
<ID> common:positiveInteger </ID> [0..1]

'User template ID'

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

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

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

'Template owner ID'

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

'Template owner identifier'

End Choice
End Choice
</GetTemplatesRequest>
Schema Component Representation
<xs:element name="GetTemplatesRequest">
<xs:complexType>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:sequence>
<xs:element name="userLevel" type=" common:integer " minOccurs="0"/>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: GetTemplatesResponse

Name GetTemplatesResponse
Type messagesInfo:GetTemplatesResponseType
Nillable no
Abstract no
Documentation Get user templates list: response
Logical Diagram
XML Instance Representation
<GetTemplatesResponse>
<template> PBXData:Template </template> [0..*]

'Template data'

<notice> common:notice </notice> [0..*]
</GetTemplatesResponse>
Schema Component Representation
<xs:element name="GetTemplatesResponse" type=" messagesInfo:GetTemplatesResponseType "/>
top

Element: GetTimeIntervalBlocksRequest

Name GetTimeIntervalBlocksRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get time interval blocks: request.
Logical Diagram
XML Instance Representation
<GetTimeIntervalBlocksRequest>
<filter> ... </filter> [0..1]

'Filter time interval blocks list by name'

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

'Time interval owner ID'

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

'Time interval owner identifier'

End Choice
</GetTimeIntervalBlocksRequest>
Schema Component Representation
<xs:element name="GetTimeIntervalBlocksRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="filter" minOccurs="0"/>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetTimeIntervalBlocksResponse

Name GetTimeIntervalBlocksResponse
Type messagesInfo:GetTimeIntervalBlocksResponseType
Nillable no
Abstract no
Documentation Get time intervals blocks: response.
Logical Diagram
XML Instance Representation
<GetTimeIntervalBlocksResponse>
<timeIntervalBlock> PBXData:TimeIntervalBlock </timeIntervalBlock> [0..*]

'Available time interval blocks'

<notice> common:notice </notice> [0..*]
</GetTimeIntervalBlocksResponse>
Schema Component Representation
<xs:element name="GetTimeIntervalBlocksResponse" type=" messagesInfo:GetTimeIntervalBlocksResponseType "/>
top

Element: GetTimeIntervalsRequest

Name GetTimeIntervalsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get time intervals: request.
Logical Diagram
XML Instance Representation
<GetTimeIntervalsRequest>
<ID> common:positiveInteger </ID> [1]

'Time interval block ID'

</GetTimeIntervalsRequest>
Schema Component Representation
<xs:element name="GetTimeIntervalsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetTimeIntervalsResponse

Name GetTimeIntervalsResponse
Type messagesInfo:GetTimeIntervalsResponseType
Nillable no
Abstract no
Documentation Get time intervals: response.
Logical Diagram
XML Instance Representation
<GetTimeIntervalsResponse>
<timeInterval> [0..*]

'Available time intervals'


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

'Start time in format: 00:00.'

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

'End time in format: 00:00.'

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

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

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

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

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

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

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

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

<month> common:integer </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..*]
</GetTimeIntervalsResponse>
Schema Component Representation
<xs:element name="GetTimeIntervalsResponse" type=" messagesInfo:GetTimeIntervalsResponseType "/>
top

Element: GetTimezoneRequest

Name GetTimezoneRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get all available timezones: request
Logical Diagram
XML Instance Representation
<GetTimezoneRequest>
<code> common:string </code> [0..1]

'Country code'

</GetTimezoneRequest>
Schema Component Representation
<xs:element name="GetTimezoneRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetTimezoneResponse

Name GetTimezoneResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get all available timezones: response
Logical Diagram
XML Instance Representation
<GetTimezoneResponse>
<timezone> [0..*]
Start Sequence [0..1]
<ID> common:positiveInteger </ID> [0..1]
<name> common:string </name> [0..1]

'Timezone description'

End Sequence
</timezone>
<notice> common:notice </notice> [0..*]
</GetTimezoneResponse>
Schema Component Representation
<xs:element name="GetTimezoneResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="timezone" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="name" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: PingRequest

Name PingRequest
Type common:string
Nillable no
Abstract no
Documentation Ping 4PSA VoipNow server: request
Logical Diagram
XML Instance Representation
<PingRequest> common:string </PingRequest>
Schema Component Representation
<xs:element name="PingRequest" type=" common:string "/>
top

Element: PingResponse

Name PingResponse
Type messagesInfo:PingResponseType
Nillable no
Abstract no
Documentation Ping 4PSA VoipNow server: response
Logical Diagram
XML Instance Representation
<PingResponse>
<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'

</PingResponse>
Schema Component Representation
<xs:element name="PingResponse" type=" messagesInfo:PingResponseType "/>
top

Element: SetCustomAlertStatusRequest

Name SetCustomAlertStatusRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom alerts: request
Logical Diagram
XML Instance Representation
<SetCustomAlertStatusRequest>
<code> common:string </code> [1]
<status> common:boolean </status> [1]
</SetCustomAlertStatusRequest>
Schema Component Representation
<xs:element name="SetCustomAlertStatusRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:string "/>
<xs:element name="status" type=" common:boolean "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: SetCustomAlertStatusResponse

Name SetCustomAlertStatusResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom alerts: response
Logical Diagram
XML Instance Representation
<SetCustomAlertStatusResponse>
<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..*]
<code> common:string </code> [0..1]

'Custom button code'

</SetCustomAlertStatusResponse>
Schema Component Representation
<xs:element name="SetCustomAlertStatusResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" common:updateObject ">
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: SetCustomButtonStatusRequest

Name SetCustomButtonStatusRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom button: request
Logical Diagram
XML Instance Representation
<SetCustomButtonStatusRequest>
<code> common:string </code> [1]
<status> common:boolean </status> [1]
</SetCustomButtonStatusRequest>
Schema Component Representation
<xs:element name="SetCustomButtonStatusRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type=" common:string "/>
<xs:element name="status" type=" common:boolean "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: SetCustomButtonStatusResponse

Name SetCustomButtonStatusResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get custom button: response
Logical Diagram
XML Instance Representation
<SetCustomButtonStatusResponse>
<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..*]
<code> common:string </code> [0..1]

'Custom button code'

</SetCustomButtonStatusResponse>
Schema Component Representation
<xs:element name="SetCustomButtonStatusResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" common:updateObject ">
<xs:sequence>
<xs:element name="code" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: UpgradeHistoryRequest

Name UpgradeHistoryRequest
Type common:string
Nillable no
Abstract no
Documentation Upgrade 4PSA VoipNow history report: request
Logical Diagram
XML Instance Representation
<UpgradeHistoryRequest> common:string </UpgradeHistoryRequest>
Schema Component Representation
<xs:element name="UpgradeHistoryRequest" type=" common:string "/>
top

Element: UpgradeHistoryResponse

Name UpgradeHistoryResponse
Type messagesInfo:UpgradeHistoryResponseType
Nillable no
Abstract no
Documentation Upgrade 4PSA VoipNow history report: response
Logical Diagram
XML Instance Representation
<UpgradeHistoryResponse>
<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>
</UpgradeHistoryResponse>
Schema Component Representation
<xs:element name="UpgradeHistoryResponse" type=" messagesInfo:UpgradeHistoryResponseType "/>
top

Element: UpgradeVoipNowRequest

Name UpgradeVoipNowRequest
Type common:string
Nillable no
Abstract no
Documentation Upgrade 4PSA VoipNow to latest release: request
Logical Diagram
XML Instance Representation
<UpgradeVoipNowRequest> common:string </UpgradeVoipNowRequest>
Schema Component Representation
<xs:element name="UpgradeVoipNowRequest" type=" common:string "/>
top

Element: UpgradeVoipNowResponse

Name UpgradeVoipNowResponse
Type messagesInfo:UpgradeVoipNowResponseType
Nillable no
Abstract no
Documentation Upgrade 4PSA VoipNow to latest release: response
Logical Diagram
XML Instance Representation
<UpgradeVoipNowResponse>
<result> xs:string (value comes from list: {'in progress'|'failure'}) </result> [0..1]

'Operation result: started/failure'

<notice> common:notice </notice> [0..*]
</UpgradeVoipNowResponse>
Schema Component Representation
<xs:element name="UpgradeVoipNowResponse" type=" messagesInfo:UpgradeVoipNowResponseType "/>
top

Element: WithdrawRequest

Name WithdrawRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Withdraw 4PSA VoipNow in third-party applications: request
Logical Diagram
XML Instance Representation
<WithdrawRequest>
<enrollmentID> common:string </enrollmentID> [0..1]

'Enrollment unique identifier'

</WithdrawRequest>
Schema Component Representation
<xs:element name="WithdrawRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="enrollmentID" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: WithdrawResponse

Name WithdrawResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Withdraw 4PSA VoipNow in third-party applications: response
Logical Diagram
XML Instance Representation
<WithdrawResponse>
<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</WithdrawResponse>
Schema Component Representation
<xs:element name="WithdrawResponse">
<xs:complexType>
<xs:sequence>
<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:sequence>
</xs:complexType>
</xs:element>
top

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