Documentation for BillingMessagesInfo

Table of Contents

top

Schema Document Properties

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

Global Definitions

Complex Type: GetChargingPlanDetailsResponseType

Super-types: None
Sub-types: None
Name GetChargingPlanDetailsResponseType
Abstract no
Documentation Get charging plan details: response type
XML Instance Representation
<...>
<chargingPlan> [0..1]

'A charging plans list on success'


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

'Charging plan name'

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

'Set default charging plan'

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

'Outgoing routing rule'

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

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

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

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

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

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

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

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

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

'Limit for external outgoing calls'

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

'Limit for external incoming calls'

<mstns:externalUsageRule> [0..1]

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


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

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


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

'Initial outgoing credit'

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

'Initial incoming credit'

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

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

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

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

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

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

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

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

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

'Charge method. Default value: fixed.'

Start Choice [1]

'Either of'


<mstns:fixedCharge> [0..1]

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


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

'Charge direct calls'

<mstns:external> [0..*]

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


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

'Charge external incoming calls'

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

'External charge outside time intervals'

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

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


<mstns:directCalls> [0..1]

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


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

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


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

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


<mstns:mulFactor> xs:float </mstns:mulFactor> [1]
<mstns:adjustment> xs:float </mstns:adjustment> [1]
</mstns:externalIncoming>
</mstns:inheritedCharge>
End Choice
<mstns:soundID> common:positiveInteger </mstns: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..*]
</...>
Schema Component Representation
<xs:complexType name="GetChargingPlanDetailsResponseType">
<xs:sequence>
<xs:element name="chargingPlan" minOccurs="0">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:ChargingPlanInfo ">
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="identifier" type=" common:string " minOccurs="0"/>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="status" type=" common:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetChargingPlanResponseType

Super-types: None
Sub-types: None
Name GetChargingPlanResponseType
Abstract no
Documentation Get charging plans: response type
XML Instance Representation
<...>
<chargingPlan> BillingData:ChargingPlanList </chargingPlan> [0..*]

'A charging plans list on success'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetChargingPlanResponseType">
<xs:sequence>
<xs:element name="chargingPlan" type=" BillingData:ChargingPlanList " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetRechargesResponseType

Super-types: None
Sub-types: None
Name GetRechargesResponseType
Abstract no
Documentation Recharge : response type
XML Instance Representation
<...>
Start Choice [1]
<credit> [0..*]
<!-- ' Credits ' super type was not found in this schema. Some elements and attributes may be missing. -->
<mstns:creditID> common:positiveInteger </mstns:creditID> [1]

'Billling plan credit ID'

<mstns:crDate> xs:dateTime </mstns: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..*]
</...>
Schema Component Representation
<xs:complexType name="GetRechargesResponseType">
<xs:sequence>
<xs:choice>
<xs:element name="credit" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" BillingData:CreditsList "/>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="limit" type=" BillingData:LimitsList " minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
<xs:element name="planType" default="postpaid" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="prepaid"/>
<xs:enumeration value="postpaid"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="currentIn" type=" common:unlimitedUFloat " minOccurs="0"/>
<xs:element name="currentOut" type=" common:unlimitedUFloat " minOccurs="0"/>
<xs:element name="currentOverusage" type=" common:unlimitedUFloat " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top