Documentation for BillingMessages

Table of Contents

top

Schema Document Properties

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

Declared Namespaces

Prefix Namespace
Default namespace http://4psa.com/BillingMessages.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/BillingMessagesInfo.xsd/2.0.0
xs http://www.w3.org/2001/XMLSchema
BillingData http://4psa.com/BillingData.xsd/2.0.0
Schema Component Representation
<xs:schema targetNamespace="http://4psa.com/BillingMessages.xsd/2.0.0" elementFormDefault="qualified" id="BillingMessages">
<xs:import namespace="http://4psa.com/BillingData.xsd/2.0.0" schemaLocation="BillingData.xsd"/>
<xs:import namespace="http://4psa.com/BillingMessagesInfo.xsd/2.0.0" schemaLocation="BillingMessagesInfo.xsd"/>
<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: AddChargingPackageRequest

Name AddChargingPackageRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add free minutes package: request.
Logical Diagram
XML Instance Representation
<AddChargingPackageRequest>
<name> common:string </name> [0..1]

'Package name'

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

'Included minutes'

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

'Chraging plan ID'

</AddChargingPackageRequest>
Schema Component Representation
<xs:element name="AddChargingPackageRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:ChargingPackage ">
<xs:sequence>
<xs:element name="chargingPlanID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddChargingPackageResponse

Name AddChargingPackageResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Add free minutes package: response.
Logical Diagram
XML Instance Representation
<AddChargingPackageResponse>
<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..*]
</AddChargingPackageResponse>
Schema Component Representation
<xs:element name="AddChargingPackageResponse" type=" common:updateObject "/>
top

Element: AddChargingPlanRequest

Name AddChargingPlanRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add charging plan: request
Logical Diagram
XML Instance Representation
<AddChargingPlanRequest>
<name> common:string </name> [1]

'Charging plan name'

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

'Set default charging plan'

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

'Outgoing routing rule'

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

'Allow incoming calls. Default value: 0 on add operation'

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

'Allow outgoing external calls. Default value: 0 on add operation'

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

'Allow outgoing extended local calls. Default value: 0 on add operation'

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

'Charging plan type: prepaid or postpaid. Default prepaid.'

<includedCreditOut> common:unlimitedUFloat </includedCreditOut> [0..1]

'Limit for external outgoing calls'

<includedCreditIn> common:unlimitedUFloat </includedCreditIn> [0..1]

'Limit for external incoming calls'

<externalUsageRule> [0..1]

'External outgoing over usage: {mulFactor} x {externalMin} included outgoing minutes + {addFactor} minutes'


<mulFactor> common:integer </mulFactor> [1]
<addFactor> common:integer </addFactor> [1]
</externalUsageRule>
<externalMin> [0..*]

'Available outgoing external minutes: {minutes} in time interval {intervalID}'


<minutes> common:integer </minutes> [1]
<intervalID> common:positiveInteger </intervalID> [1]
</externalMin>
<initialCreditOut> common:unlimitedUFloat </initialCreditOut> [0..1]

'Initial outgoing credit'

<initialCreditIn> common:unlimitedUFloat </initialCreditIn> [0..1]

'Initial incoming credit'

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

'Charge outgoing indivisible for the first {chargeOut} seconds. Default: 60 seconds.'

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

'Then charge every {thenChargeOut} seconds. Default: 10 seconds.'

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

'Charge external incoming indivisible for the first {chargeIn} seconds. Default: 60 seconds.'

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

'Then charge every {thenChargeIn} seconds. Default: 10 seconds.'

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

'Charge method. Default value: fixed.'

Start Choice [1]

'Either of'
<fixedCharge> [0..1]

'Fixed prices charge method. Send only if {chargeMethod} value is fixed'


<directCalls> xs:float </directCalls> [0..1]

'Charge direct calls'

<external> [0..*]

'Charge external outgoing calls : {charge} /second in time interval {intervalId}'


<charge> xs:float </charge> [1]
<intervalID> common:positiveInteger </intervalID> [1]
</external>
<externalIncoming> xs:float </externalIncoming> [0..1]

'Charge external incoming calls'

<outsideInterval> xs:float </outsideInterval> [0..1]

'External charge outside time intervals'

</fixedCharge>
<inheritedCharge> [0..1]

'Relative to call cost charge method. Send only if {chargeMethod} value is inherited'


<directCalls> [0..1]

'Charge direct calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</directCalls>
<external> [0..1]

'Charge external outgoing calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</external>
<externalIncoming> [0..1]

'Charge external incoming calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</externalIncoming>
</inheritedCharge>
End Choice
<soundID> common:positiveInteger </soundID> [0..1]

'Custom sound file played when outgoing access is blocked'

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

'Charging plan owner ID'

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

'Charging plan owner identifier'

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

'Charging plan owner login'

End Choice
<forceChannelRule> common:boolean </forceChannelRule> [0..1]

'Create charging plan with default outgoing routing rules group if channelRuleID is not valid'

<exception> [0..*]

'Destination exceptions'


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

'Area code'

<description> common:string </description> [0..1]
<charge> [0..1]
<initialAmount> xs:float </initialAmount> [0..1]

'For fixed charging plans ONLY'

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

'For fixed charging plans ONLY'

<amount> xs:float </amount> [1]
<interval> common:integer </interval> [1]
<setupAmount> xs:float </setupAmount> [0..1]

'For inherited charging plans ONLY'

</charge>
<package> [0..1]

'Free minutes package'


<name> common:string </name> [1]
<minutes> xs:float </minutes> [1]
</package>
</exception>
<scope> common:string </scope> [0..1]

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

</AddChargingPlanRequest>
Schema Component Representation
<xs:element name="AddChargingPlanRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:ChargingPlanInfo ">
<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:element name="forceChannelRule" type=" common:boolean " default="1" minOccurs="0"/>
<xs:element name="exception" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="areaCode" type=" common:string " minOccurs="0"/>
<xs:element name="description" type=" common:string " minOccurs="0"/>
<xs:element name="charge" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="initialAmount" type=" xs:float " minOccurs="0"/>
<xs:element name="initialInterval" type=" common:integer " minOccurs="0"/>
<xs:element name="amount" type=" xs:float "/>
<xs:element name="interval" type=" common:integer "/>
<xs:element name="setupAmount" type=" xs:float " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="package" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type=" common:string "/>
<xs:element name="minutes" type=" xs:float "/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="scope" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddChargingPlanResponse

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

'Unique client identifier'

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

Element: AddDestinationExceptionRequest

Name AddDestinationExceptionRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add destination exception charge: request.
Logical Diagram
XML Instance Representation
<AddDestinationExceptionRequest>
<exception> BillingData:DestinationException </exception> [1..*]
<chargingPlanID> common:positiveInteger </chargingPlanID> [1]

'Charging plan ID'

</AddDestinationExceptionRequest>
Schema Component Representation
<xs:element name="AddDestinationExceptionRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="exception" type=" BillingData:DestinationException " maxOccurs="unbounded"/>
<xs:element name="chargingPlanID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AddDestinationExceptionResponse

Name AddDestinationExceptionResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Add destination exception charge: response.
Logical Diagram
XML Instance Representation
<AddDestinationExceptionResponse>
<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..*]
</AddDestinationExceptionResponse>
Schema Component Representation
<xs:element name="AddDestinationExceptionResponse" type=" common:updateObject "/>
top

Element: DelChargingPackageRequest

Name DelChargingPackageRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Remove free minutes package: request.
Logical Diagram
XML Instance Representation
<DelChargingPackageRequest>
<chargingPlanID> common:positiveInteger </chargingPlanID> [1]

'Charging plan ID'

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

'Free minutes package ID'

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

Element: DelChargingPackageResponse

Name DelChargingPackageResponse
Type common:delObject
Nillable no
Abstract no
Documentation Remove free minutes package: response.
Logical Diagram
XML Instance Representation
<DelChargingPackageResponse>
<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'

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

Element: DelChargingPlanRequest

Name DelChargingPlanRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete charging plans: request.
Logical Diagram
XML Instance Representation
<DelChargingPlanRequest>
<timeIntervalRemoval> common:boolean </timeIntervalRemoval> [0..1]

'Remove also time intervals used by this charging plan'

Start Choice [1]
<ID> common:positiveInteger </ID> [1..*]

'Charging plan ID'

<identifier> common:string </identifier> [1..*]

'Charging plan identifier'

End Choice
</DelChargingPlanRequest>
Schema Component Representation
<xs:element name="DelChargingPlanRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="timeIntervalRemoval" type=" common:boolean " minOccurs="0"/>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
<xs:element name="identifier" type=" common:string " maxOccurs="unbounded"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelChargingPlanResponse

Name DelChargingPlanResponse
Type common:delObject
Nillable no
Abstract no
Documentation Delete charging plans: response.
Logical Diagram
XML Instance Representation
<DelChargingPlanResponse>
<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'

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

Element: DelDestinationExceptionRequest

Name DelDestinationExceptionRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Remove destination exception charge: request.
Logical Diagram
XML Instance Representation
<DelDestinationExceptionRequest>
<chargingPlanID> common:positiveInteger </chargingPlanID> [1]

'Charging plan ID'

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

'Destination exception charge'

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

Element: DelDestinationExceptionResponse

Name DelDestinationExceptionResponse
Type common:delObject
Nillable no
Abstract no
Documentation Remove destination exception charge: response.
Logical Diagram
XML Instance Representation
<DelDestinationExceptionResponse>
<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'

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

Element: DelMonthlyLimitRequest

Name DelMonthlyLimitRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete recharge monthly limit: request.
Logical Diagram
XML Instance Representation
<DelMonthlyLimitRequest>
Start Choice [1]
<userID> common:positiveInteger </userID> [1]

'User ID'

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

'User identifier'

End Choice
</DelMonthlyLimitRequest>
Schema Component Representation
<xs:element name="DelMonthlyLimitRequest">
<xs:complexType>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger "/>
<xs:element name="userIdentifier" type=" common:string "/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: DelMonthlyLimitResponse

Name DelMonthlyLimitResponse
Type common:delObject
Nillable no
Abstract no
Documentation Delete recharge monthly limit: response.
Logical Diagram
XML Instance Representation
<DelMonthlyLimitResponse>
<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'

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

Element: EditChargingPackageRequest

Name EditChargingPackageRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit free minutes package: request.
Logical Diagram
XML Instance Representation
<EditChargingPackageRequest>
<name> common:string </name> [0..1]

'Package name'

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

'Included minutes'

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

'Chraging plan ID'

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

'Free minutes package ID'

</EditChargingPackageRequest>
Schema Component Representation
<xs:element name="EditChargingPackageRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:ChargingPackage ">
<xs:sequence>
<xs:element name="chargingPlanID" type=" common:positiveInteger "/>
<xs:element name="chargingPackageID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditChargingPackageResponse

Name EditChargingPackageResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Edit free minutes package: response.
Logical Diagram
XML Instance Representation
<EditChargingPackageResponse>
<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..*]
</EditChargingPackageResponse>
Schema Component Representation
<xs:element name="EditChargingPackageResponse" type=" common:updateObject "/>
top

Element: EditChargingPlanRequest

Name EditChargingPlanRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit charging plan: request
Logical Diagram
XML Instance Representation
<EditChargingPlanRequest>
<name> common:string </name> [1]

'Charging plan name'

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

'Set default charging plan'

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

'Outgoing routing rule'

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

'Allow incoming calls. Default value: 0 on add operation'

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

'Allow outgoing external calls. Default value: 0 on add operation'

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

'Allow outgoing extended local calls. Default value: 0 on add operation'

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

'Charging plan type: prepaid or postpaid. Default prepaid.'

<includedCreditOut> common:unlimitedUFloat </includedCreditOut> [0..1]

'Limit for external outgoing calls'

<includedCreditIn> common:unlimitedUFloat </includedCreditIn> [0..1]

'Limit for external incoming calls'

<externalUsageRule> [0..1]

'External outgoing over usage: {mulFactor} x {externalMin} included outgoing minutes + {addFactor} minutes'


<mulFactor> common:integer </mulFactor> [1]
<addFactor> common:integer </addFactor> [1]
</externalUsageRule>
<externalMin> [0..*]

'Available outgoing external minutes: {minutes} in time interval {intervalID}'


<minutes> common:integer </minutes> [1]
<intervalID> common:positiveInteger </intervalID> [1]
</externalMin>
<initialCreditOut> common:unlimitedUFloat </initialCreditOut> [0..1]

'Initial outgoing credit'

<initialCreditIn> common:unlimitedUFloat </initialCreditIn> [0..1]

'Initial incoming credit'

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

'Charge outgoing indivisible for the first {chargeOut} seconds. Default: 60 seconds.'

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

'Then charge every {thenChargeOut} seconds. Default: 10 seconds.'

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

'Charge external incoming indivisible for the first {chargeIn} seconds. Default: 60 seconds.'

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

'Then charge every {thenChargeIn} seconds. Default: 10 seconds.'

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

'Charge method. Default value: fixed.'

Start Choice [1]

'Either of'
<fixedCharge> [0..1]

'Fixed prices charge method. Send only if {chargeMethod} value is fixed'


<directCalls> xs:float </directCalls> [0..1]

'Charge direct calls'

<external> [0..*]

'Charge external outgoing calls : {charge} /second in time interval {intervalId}'


<charge> xs:float </charge> [1]
<intervalID> common:positiveInteger </intervalID> [1]
</external>
<externalIncoming> xs:float </externalIncoming> [0..1]

'Charge external incoming calls'

<outsideInterval> xs:float </outsideInterval> [0..1]

'External charge outside time intervals'

</fixedCharge>
<inheritedCharge> [0..1]

'Relative to call cost charge method. Send only if {chargeMethod} value is inherited'


<directCalls> [0..1]

'Charge direct calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</directCalls>
<external> [0..1]

'Charge external outgoing calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</external>
<externalIncoming> [0..1]

'Charge external incoming calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</externalIncoming>
</inheritedCharge>
End Choice
<soundID> common:positiveInteger </soundID> [0..1]

'Custom sound file played when outgoing access is blocked'

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

'Charging plan ID'

<identifier> ... </identifier> [1]

'Charging plan identifier'

End Choice
</EditChargingPlanRequest>
Schema Component Representation
<xs:element name="EditChargingPlanRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:ChargingPlanInfo ">
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="identifier"/>
</xs:choice>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditChargingPlanResponse

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

'Unique client identifier'

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

Element: EditDestinationExceptionRequest

Name EditDestinationExceptionRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit destination exception charge: request.
Logical Diagram
XML Instance Representation
<EditDestinationExceptionRequest>
<areaCode> common:string </areaCode> [0..1]

'Area code'

<description> common:string </description> [0..1]
<charge> [0..1]
<initialAmount> xs:float </initialAmount> [0..1]

'For fixed charging plans ONLY'

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

'For fixed charging plans ONLY'

<amount> xs:float </amount> [0..1]
<interval> common:integer </interval> [0..1]
<setupAmount> xs:float </setupAmount> [0..1]

'For inherited charging plans ONLY'

</charge>
<chargingPackageID> common:positiveInteger </chargingPackageID> [0..1]

'Free minutes package ID'

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

'Destination exception charge ID'

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

'Charging plan ID'

</EditDestinationExceptionRequest>
Schema Component Representation
<xs:element name="EditDestinationExceptionRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:DestinationException ">
<xs:sequence>
<xs:element name="exceptionID" type=" common:positiveInteger "/>
<xs:element name="chargingPlanID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditDestinationExceptionResponse

Name EditDestinationExceptionResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Edit destination exception charge: response.
Logical Diagram
XML Instance Representation
<EditDestinationExceptionResponse>
<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..*]
</EditDestinationExceptionResponse>
Schema Component Representation
<xs:element name="EditDestinationExceptionResponse" type=" common:updateObject "/>
top

Element: GetChargingPackagesRequest

Name GetChargingPackagesRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get free minutes packages: request.
Logical Diagram
XML Instance Representation
<GetChargingPackagesRequest>
<chargingPlanID> ... </chargingPlanID> [1]

'Charging plan ID'

<filter> ... </filter> [0..1]

'Filter destination exception charges list after areaCode, description'

</GetChargingPackagesRequest>
Schema Component Representation
<xs:element name="GetChargingPackagesRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="chargingPlanID"/>
<xs:element name="filter" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetChargingPackagesResponse

Name GetChargingPackagesResponse
Type BillingData:ChargingPackageList
Nillable no
Abstract no
Documentation Get free minutes packages: response.
Logical Diagram
XML Instance Representation
<GetChargingPackagesResponse>
<chargingPlanID> common:positiveInteger </chargingPlanID> [1]

'Charging plan ID'

<package> [0..*]

'Free minutes package list'


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

'Free minutes package ID'

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

'Package name'

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

'Included minutes'

</package>
</GetChargingPackagesResponse>
Schema Component Representation
<xs:element name="GetChargingPackagesResponse" type=" BillingData:ChargingPackageList "/>
top

Element: GetChargingPlanDetailsRequest

Name GetChargingPlanDetailsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get charging plan details: request
Logical Diagram
XML Instance Representation
<GetChargingPlanDetailsRequest>
Start Choice [1]
<ID> common:positiveInteger </ID> [0..1]

'Charging plan ID'

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

'Charging plan identifier'

End Choice
</GetChargingPlanDetailsRequest>
Schema Component Representation
<xs:element name="GetChargingPlanDetailsRequest">
<xs:complexType>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="identifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: GetChargingPlanDetailsResponse

Name GetChargingPlanDetailsResponse
Type messagesInfo:GetChargingPlanDetailsResponseType
Nillable no
Abstract no
Documentation Get charging plan details: response
Logical Diagram
XML Instance Representation
<GetChargingPlanDetailsResponse>
<chargingPlan> [0..1]

'A charging plans list on success'


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

'Charging plan name'

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

'Set default charging plan'

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

'Outgoing routing rule'

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

'Allow incoming calls. Default value: 0 on add operation'

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

'Allow outgoing external calls. Default value: 0 on add operation'

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

'Allow outgoing extended local calls. Default value: 0 on add operation'

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

'Charging plan type: prepaid or postpaid. Default prepaid.'

<includedCreditOut> common:unlimitedUFloat </includedCreditOut> [0..1]

'Limit for external outgoing calls'

<includedCreditIn> common:unlimitedUFloat </includedCreditIn> [0..1]

'Limit for external incoming calls'

<externalUsageRule> [0..1]

'External outgoing over usage: {mulFactor} x {externalMin} included outgoing minutes + {addFactor} minutes'


<mulFactor> common:integer </mulFactor> [1]
<addFactor> common:integer </addFactor> [1]
</externalUsageRule>
<externalMin> [0..*]

'Available outgoing external minutes: {minutes} in time interval {intervalID}'


<minutes> common:integer </minutes> [1]
<intervalID> common:positiveInteger </intervalID> [1]
</externalMin>
<initialCreditOut> common:unlimitedUFloat </initialCreditOut> [0..1]

'Initial outgoing credit'

<initialCreditIn> common:unlimitedUFloat </initialCreditIn> [0..1]

'Initial incoming credit'

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

'Charge outgoing indivisible for the first {chargeOut} seconds. Default: 60 seconds.'

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

'Then charge every {thenChargeOut} seconds. Default: 10 seconds.'

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

'Charge external incoming indivisible for the first {chargeIn} seconds. Default: 60 seconds.'

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

'Then charge every {thenChargeIn} seconds. Default: 10 seconds.'

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

'Charge method. Default value: fixed.'

Start Choice [1]

'Either of'
<fixedCharge> [0..1]

'Fixed prices charge method. Send only if {chargeMethod} value is fixed'


<directCalls> xs:float </directCalls> [0..1]

'Charge direct calls'

<external> [0..*]

'Charge external outgoing calls : {charge} /second in time interval {intervalId}'


<charge> xs:float </charge> [1]
<intervalID> common:positiveInteger </intervalID> [1]
</external>
<externalIncoming> xs:float </externalIncoming> [0..1]

'Charge external incoming calls'

<outsideInterval> xs:float </outsideInterval> [0..1]

'External charge outside time intervals'

</fixedCharge>
<inheritedCharge> [0..1]

'Relative to call cost charge method. Send only if {chargeMethod} value is inherited'


<directCalls> [0..1]

'Charge direct calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</directCalls>
<external> [0..1]

'Charge external outgoing calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</external>
<externalIncoming> [0..1]

'Charge external incoming calls: {mulFactor} x call cost + {adjustment} /second'


<mulFactor> xs:float </mulFactor> [1]
<adjustment> xs:float </adjustment> [1]
</externalIncoming>
</inheritedCharge>
End Choice
<soundID> common:positiveInteger </soundID> [0..1]

'Custom sound file played when outgoing access is blocked'

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

'Charging plan ID'

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

'Charging plan identifier'

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

'Charging plan owner ID'

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

'Charging plan status'

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

Element: GetChargingPlansRequest

Name GetChargingPlansRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get charging plans: request
Logical Diagram
XML Instance Representation
<GetChargingPlansRequest>
<default> common:boolean </default> [0..1]

'Set to filter default charging plan'

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

'Filter charging plan list by charging plan name. Ignored when default filter in on.'

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

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

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

'Charging plan owner ID'

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

'Charging plan owner identifier'

End Choice
</GetChargingPlansRequest>
Schema Component Representation
<xs:element name="GetChargingPlansRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="default" type=" common:boolean " minOccurs="0"/>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
<xs:element name="scope" type=" common:string " 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: GetChargingPlansResponse

Name GetChargingPlansResponse
Type messagesInfo:GetChargingPlanResponseType
Nillable no
Abstract no
Documentation Get charging plans: response
Logical Diagram
XML Instance Representation
<GetChargingPlansResponse>
<chargingPlan> BillingData:ChargingPlanList </chargingPlan> [0..*]

'A charging plans list on success'

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

Element: GetDestinationExceptionsRequest

Name GetDestinationExceptionsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get destination exception charges: request.
Logical Diagram
XML Instance Representation
<GetDestinationExceptionsRequest>
<chargingPlanID> ... </chargingPlanID> [1]

'Charging plan ID'

<filter> ... </filter> [0..1]

'Filter destination exception charges list after areaCode, description'

</GetDestinationExceptionsRequest>
Schema Component Representation
<xs:element name="GetDestinationExceptionsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="chargingPlanID"/>
<xs:element name="filter" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetDestinationExceptionsResponse

Name GetDestinationExceptionsResponse
Type BillingData:DestinationExceptionList
Nillable no
Abstract no
Documentation Get destination exception charges: response.
Logical Diagram
XML Instance Representation
<GetDestinationExceptionsResponse>
<chargingPlanID> common:positiveInteger </chargingPlanID> [1]

'Charging plan ID'

<exception> [0..*]

'Destination exception charge'


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

'Destination exception charge ID'

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

'Area code'

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

'Included free minutes'

<description> common:string </description> [0..1]
<initialAmount> xs:float </initialAmount> [0..1]
<initialInterval> common:integer </initialInterval> [0..1]
<amount> xs:float </amount> [0..1]
<interval> common:integer </interval> [0..1]
<chargingPackageID> common:positiveInteger </chargingPackageID> [0..1]

'Free minutes package ID'

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

'Free minutes package name'

</exception>
<notice> common:notice </notice> [0..*]
</GetDestinationExceptionsResponse>
Schema Component Representation
<xs:element name="GetDestinationExceptionsResponse" type=" BillingData:DestinationExceptionList "/>
top

Element: GetRechargesRequest

Name GetRechargesRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get user list of charging limits/credits: request
Logical Diagram
XML Instance Representation
<GetRechargesRequest>
Start Choice [1]
<userID> common:positiveInteger </userID> [0..1]

'User ID'

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

'User identifier'

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

Element: GetRechargesResponse

Name GetRechargesResponse
Type messagesInfo:GetRechargesResponseType
Nillable no
Abstract no
Documentation Get user list of charging limits/credits: response
Logical Diagram
XML Instance Representation
<GetRechargesResponse>
Start Choice [1]
<credit> [0..*]
<!-- ' Credits ' super type was not found in this schema. Some elements and attributes may be missing. -->
<creditID> common:positiveInteger </creditID> [1]

'Billling plan credit ID'

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

'Creation date'

</credit>
<limit> BillingData:LimitsList </limit> [0..*]
End Choice
<planType> xs:string (value comes from list: {'prepaid'|'postpaid'}) </planType> [0..1]

'Charging plan type'

<currentIn> common:unlimitedUFloat </currentIn> [0..1]

'Currently incoming credit/limit left'

<currentOut> common:unlimitedUFloat </currentOut> [0..1]

'Currently outgoing credit/limit left'

<currentOverusage> common:unlimitedUFloat </currentOverusage> [0..1]

'Currently overusage minutes left'

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

Element: RechargeRequest

Name RechargeRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add charging limits/credits to charging plan:request
Logical Diagram
XML Instance Representation
<RechargeRequest>
Start Choice [1]

'Either of'
<limit> BillingData:Limits </limit> [1]

'Charging plan limit definition: for postpaid charging plan'

<credit> BillingData:Credits </credit> [1]

'Charging plan credit definiton: for prepaid charging plan'

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

'User for which the recharge is made'

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

'User for which the recharge is made'

End Choice
</RechargeRequest>
Schema Component Representation
<xs:element name="RechargeRequest">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="limit" type=" BillingData:Limits "/>
<xs:element name="credit" type=" BillingData:Credits "/>
</xs:choice>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger "/>
<xs:element name="userIdentifier" type=" common:string "/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: RechargeResponse

Name RechargeResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Add charging limits/credits to charging plan: response
Logical Diagram
XML Instance Representation
<RechargeResponse>
<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..*]
</RechargeResponse>
Schema Component Representation
<xs:element name="RechargeResponse" type=" common:updateObject "/>
top

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