Documentation for ClientMessagesInfo

Table of Contents

Master schema documentation file: ClientMessagesInfo.xsd.html

top

Schema Document Properties

Target Namespace http://4psa.com/ClientData.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/ClientData.xsd/2.0.0
xml http://www.w3.org/XML/1998/namespace
mstns http://4psa.com/ClientData.xsd/2.0.0
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/ClientData.xsd/2.0.0" elementFormDefault="qualified" id="ClientData">
<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: ClientInfo

Super-types: None
Sub-types:
Name ClientInfo
Abstract no
Documentation Client account data
XML Instance Representation
<...>
<mstns:name> common:string </mstns:name> [0..1]

'Contact name'

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

'Company name'

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

'Username'

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

'Password auto generation'

<mstns:password> common:password </mstns:password> [0..1]

'User password'

<mstns:passwordStrength> xs:string (value comes from list: {'low'|'medium'|'high'|'veryHigh'}) </mstns:passwordStrength> [0..1]

'Password strength for password validation'

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

'Force user update on duplicate login (new login computed)'

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

'Phone'

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

'Fax'

<mstns:email> common:email </mstns:email> [0..1]

'Email address'

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

'Address'

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

'City'

<mstns:pcode> common:pcode </mstns:pcode> [0..1]

'Postal/ZIP code'

<mstns:country> common:code </mstns:country> [0..1]

'Country'

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

'Region ID. Use PBX:GetRegions method fot the list of all available regions'

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

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

<mstns:interfaceLang> common:code </mstns:interfaceLang> [0..1]

'Interface language'

<mstns:notes> common:text </mstns:notes> [0..1]

'User notes'

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

'Unique request location identifier'

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

'Charging identifier'

</...>
Schema Component Representation
<xs:complexType name="ClientInfo">
<xs:sequence>
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="company" type=" common:string " minOccurs="0"/>
<xs:element name="login" type=" common:string " minOccurs="0"/>
<xs:element name="passwordAuto" type=" common:boolean " minOccurs="0"/>
<xs:element name="password" type=" common:password " minOccurs="0"/>
<xs:element name="passwordStrength" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="low"/>
<xs:enumeration value="medium"/>
<xs:enumeration value="high"/>
<xs:enumeration value="veryHigh"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="forceUpdate" type=" common:boolean " minOccurs="0"/>
<xs:element name="phone" type=" common:string " minOccurs="0"/>
<xs:element name="fax" type=" common:string " minOccurs="0"/>
<xs:element name="email" type=" common:email " minOccurs="0"/>
<xs:element name="address" type=" common:string " minOccurs="0"/>
<xs:element name="city" type=" common:string " minOccurs="0"/>
<xs:element name="pcode" type=" common:pcode " minOccurs="0"/>
<xs:element name="country" type=" common:code " minOccurs="0"/>
<xs:element name="region" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="timezone" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="interfaceLang" type=" common:code " minOccurs="0"/>
<xs:element name="notes" type=" common:text " minOccurs="0"/>
<xs:element name="serverID" type=" common:string " minOccurs="0"/>
<xs:element name="chargingIdentifier" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ClientList

Super-types: None
Sub-types: None
Name ClientList
Abstract no
Documentation Client list data
XML Instance Representation
<...>
<mstns:ID> common:positiveInteger </mstns:ID> [0..1]

'User ID'

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

'Contact name'

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

'Username'

<mstns:email> common:email </mstns:email> [0..1]

'Email address'

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

'Unique client identifier'

<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="ClientList">
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="login" type=" common:string " minOccurs="0"/>
<xs:element name="email" type=" common:email " minOccurs="0"/>
<xs:element name="identifier" type=" common:string " minOccurs="0"/>
<xs:element name="scope" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ClientPLInfo

Super-types: None
Sub-types: None
Name ClientPLInfo
Abstract no
Documentation Client permissions and limits data
XML Instance Representation
<...>
<mstns:permsManag> common:boolean </mstns:permsManag> [0..1]

'Permission and limit Management'

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

'Endpoint Management'

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

'Endpoint Feature Management'

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

'Endpoint SIP management'

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

'Charging Plan Management'

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

'Phone Numbers Management'

<mstns:endpointMax> common:unlimitedUInt </mstns:endpointMax> [0..1]

'Maximum number of endpoints'

<mstns:concurentCalls> common:unlimitedUInt </mstns:concurentCalls> [0..1]

'Maximum concurrent calls'

<mstns:recordStorage> common:unlimitedUInt </mstns:recordStorage> [0..1]

'Maximum disk space for call recording (MB)'

<mstns:accountExpire> common:unlimitedDate </mstns:accountExpire> [0..1]

'Account expiration date'

</...>
Schema Component Representation
<xs:complexType name="ClientPLInfo">
<xs:sequence>
<xs:element name="permsManag" type=" common:boolean " minOccurs="0"/>
<xs:element name="endpointManag" type=" common:boolean " minOccurs="0"/>
<xs:element name="endpFeatureManag" type=" common:boolean " minOccurs="0"/>
<xs:element name="sipManag" type=" common:boolean " minOccurs="0"/>
<xs:element name="chargingPlanManag" type=" common:boolean " minOccurs="0"/>
<xs:element name="numberManag" type=" common:boolean " minOccurs="0"/>
<xs:element name="endpointMax" type=" common:unlimitedUInt " minOccurs="0"/>
<xs:element name="concurentCalls" type=" common:unlimitedUInt " minOccurs="0"/>
<xs:element name="recordStorage" type=" common:unlimitedUInt " minOccurs="0"/>
<xs:element name="accountExpire" type=" common:unlimitedDate " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ExtendedClientInfo

Super-types: ClientInfo < ExtendedClientInfo (by extension)
Sub-types: None
Name ExtendedClientInfo
Abstract no
Documentation Client account details data
XML Instance Representation
<...>
<mstns:name> common:string </mstns:name> [0..1]

'Contact name'

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

'Company name'

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

'Username'

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

'Password auto generation'

<mstns:password> common:password </mstns:password> [0..1]

'User password'

<mstns:passwordStrength> xs:string (value comes from list: {'low'|'medium'|'high'|'veryHigh'}) </mstns:passwordStrength> [0..1]

'Password strength for password validation'

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

'Force user update on duplicate login (new login computed)'

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

'Phone'

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

'Fax'

<mstns:email> common:email </mstns:email> [0..1]

'Email address'

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

'Address'

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

'City'

<mstns:pcode> common:pcode </mstns:pcode> [0..1]

'Postal/ZIP code'

<mstns:country> common:code </mstns:country> [0..1]

'Country'

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

'Region ID. Use PBX:GetRegions method fot the list of all available regions'

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

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

<mstns:interfaceLang> common:code </mstns:interfaceLang> [0..1]

'Interface language'

<mstns:notes> common:text </mstns:notes> [0..1]

'User notes'

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

'Unique request location identifier'

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

'Charging identifier'

<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="ExtendedClientInfo">
<xs:complexContent>
<xs:extension base=" ClientInfo ">
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="identifier" type=" common:string " minOccurs="0"/>
<xs:element name="status" type=" common:boolean " minOccurs="0"/>
<xs:element name="phoneStatus" default="1" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="1"/>
<xs:enumeration value="16"/>
<xs:enumeration value="32"/>
<xs:enumeration value="64"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="cpAccess" type=" common:boolean " minOccurs="0"/>
<xs:element name="parentID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="parentIdentifier" type=" common:string " minOccurs="0"/>
<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>
<xs:element name="chargingPlan" type=" common:string " minOccurs="0"/>
<xs:element name="parentName" type=" common:string " minOccurs="0"/>
<xs:element name="templateID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="crDate" type=" xs:dateTime " minOccurs="0"/>
<xs:element name="scope" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</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: