Documentation for ClientMessagesInfo

Table of Contents

top

Schema Document Properties

Target Namespace http://4psa.com/ClientMessagesInfo.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/ClientMessagesInfo.xsd/2.0.0
clientData http://4psa.com/ClientData.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/ClientMessagesInfo.xsd/2.0.0" elementFormDefault="qualified" id="ClientMessagesInfo">
<xs:import namespace="http://4psa.com/ClientData.xsd/2.0.0" schemaLocation="ClientData.xsd"/>
<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: GetClientDetailsResponseType

Super-types: clientData:ExtendedClientInfo < GetClientDetailsResponseType (by extension)
Sub-types: None
Name GetClientDetailsResponseType
Abstract no
Documentation Get client account details: response type
XML Instance Representation
<...>
<!-- ' ClientInfo ' super type was not found in this schema. Some elements and attributes may be missing. -->
<mstns:ID> common:positiveInteger </mstns:ID> [1]

'Reseller ID'

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

'Unique client identifier'

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

'User status'

<mstns:phoneStatus> xs:string (value comes from list: {'1'|'16'|'32'|'64'}) </mstns:phoneStatus> [0..1]

'User phone status'

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

'User control panel access'

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

'Owner ID'

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

'Owner Identifier'

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

'Charging plan ID'

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

'Charging plan identifier'

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

'Charging plan name'

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

'Owner name'

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

'User template ID'

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

'Creation date'

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

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

</...>
Schema Component Representation
<xs:complexType name="GetClientDetailsResponseType">
<xs:complexContent>
<xs:extension base=" clientData:ExtendedClientInfo "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GetClientPLResponseType

Super-types: None
Sub-types: None
Name GetClientPLResponseType
Abstract no
Documentation Get client permissions and limits: response type
XML Instance Representation
<...>
<userPL> clientData:ClientPLInfo </userPL> [0..1]

'Reseller preferences and limits'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetClientPLResponseType">
<xs:sequence>
<xs:element name="userPL" type=" clientData:ClientPLInfo " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetClientResponseType

Super-types: None
Sub-types: None
Name GetClientResponseType
Abstract no
Documentation Get client: response type
XML Instance Representation
<...>
<client> clientData:ClientList </client> [0..*]

'Client data'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetClientResponseType">
<xs:sequence>
<xs:element name="client" type=" clientData:ClientList " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: MoveClientsResponseType

Super-types: common:delObject < MoveClientsResponseType (by extension)
Sub-types: None
Name MoveClientsResponseType
Abstract no
Documentation Move clients to another reseller: response type
XML Instance Representation
<...>
<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'

</...>
Schema Component Representation
<xs:complexType name="MoveClientsResponseType">
<xs:complexContent>
<xs:extension base=" common:delObject "/>
</xs:complexContent>
</xs:complexType>
top

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