Documentation for ClientMessages

Table of Contents

top

Schema Document Properties

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

Global Declarations

Element: AddClientRequest

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

'Contact name'

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

'Company name'

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

'Username'

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

'Password auto generation'

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

'User password'

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

'Password strength for password validation'

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

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

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

'Phone'

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

'Fax'

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

'Email address'

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

'Address'

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

'City'

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

'Postal/ZIP code'

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

'Country'

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

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

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

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

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

'Interface language'

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

'User notes'

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

'Unique request location identifier'

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

'Charging identifier'

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

'Client template ID'

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

'Outgoing routing rules group ID. Only for charging plan disabled'

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

'Unique client identifier'

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

'Owner ID'

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

'Unique owner identifier'

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

'Owner login'

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

'Charging plan ID'

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

'Unique charging plan identifier'

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

'Context user ID for requests made on behalf of this user.'

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

'Context user identifier for requests made on behalf of this user.'

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

'Response verbosity. Set 1 to receive detailed information on newly created account'

<notifyOnly> xs:decimal </notifyOnly> [0..1]

'Mask of 4 bits to setup notification preferences ARCE (ADMIN{0/1}, RESELLER{0/1}, CLIENT{0/1}, EXTENSION{0/1})'

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

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

</AddClientRequest>
Schema Component Representation
<xs:element name="AddClientRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" clientData:ClientInfo ">
<xs:sequence>
<xs:element name="templateID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="channelRuleID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="identifier" type=" common:string " minOccurs="0"/>
<xs:choice>
<xs:element name="parentID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="parentIdentifier" type=" common:string " minOccurs="0"/>
<xs:element name="parentLogin" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:choice>
<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:choice>
<xs:element name="fromUser" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="fromUserIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:element name="verbose" type=" common:boolean " default="0" minOccurs="0"/>
<xs:element name="notifyOnly" type=" xs:decimal " minOccurs="0"/>
<xs:element name="scope" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: AddClientResponse

Name AddClientResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add client: response
Logical Diagram
XML Instance Representation
<AddClientResponse>
<!-- ' ClientInfo ' super type was not found in this schema. Some elements and attributes may be missing. -->
<ID> common:positiveInteger </ID> [1]

'Reseller ID'

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

'Unique client identifier'

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

'User status'

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

'User phone status'

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

'User control panel access'

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

'Owner ID'

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

'Owner Identifier'

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

'Charging plan ID'

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

'Charging plan identifier'

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

'Charging plan name'

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

'Owner name'

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

'User template ID'

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

'Creation date'

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

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

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

'Operation result'

<notice> common:notice </notice> [0..*]
<template> common:string </template> [0..1]

'Client template'

</AddClientResponse>
Schema Component Representation
<xs:element name="AddClientResponse">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" messagesInfo:GetClientDetailsResponseType ">
<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:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="template" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: DelClientRequest

Name DelClientRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete clients: request
Logical Diagram
XML Instance Representation
<DelClientRequest>
Start Choice [1]
<ID> common:positiveInteger </ID> [1..*]

'Client IDs'

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

'Client identifiers'

End Choice
</DelClientRequest>
Schema Component Representation
<xs:element name="DelClientRequest">
<xs:complexType>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
<xs:element name="identifier" type=" common:string " maxOccurs="unbounded"/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: DelClientResponse

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

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

Element: EditClientRequest

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

'Contact name'

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

'Company name'

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

'Username'

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

'Password auto generation'

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

'User password'

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

'Password strength for password validation'

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

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

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

'Phone'

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

'Fax'

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

'Email address'

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

'Address'

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

'City'

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

'Postal/ZIP code'

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

'Country'

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

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

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

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

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

'Interface language'

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

'User notes'

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

'Unique request location identifier'

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

'Charging identifier'

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

'Outgoing routing rules group ID. Only for charging plan disabled'

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

'Client ID'

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

'Client identifier'

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

'Charging plan ID'

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

'Charging plan identifier'

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

'Context user ID for requests made on behalf of this user.'

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

'Context user identifier for requests made on behalf of this user.'

End Choice
</EditClientRequest>
Schema Component Representation
<xs:element name="EditClientRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" clientData:ClientInfo ">
<xs:sequence>
<xs:element name="channelRuleID" type=" common:positiveInteger " minOccurs="0"/>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="identifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:choice>
<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<xs:choice>
<xs:element name="fromUser" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="fromUserIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditClientResponse

Name EditClientResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit client: response
Logical Diagram
XML Instance Representation
<EditClientResponse>
<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]

'User unique identifier'

</EditClientResponse>
Schema Component Representation
<xs:element name="EditClientResponse">
<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: GetClientDetailsRequest

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

'Client ID'

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

'Client identifier'

End Choice
</GetClientDetailsRequest>
Schema Component Representation
<xs:element name="GetClientDetailsRequest">
<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: GetClientDetailsResponse

Name GetClientDetailsResponse
Type messagesInfo:GetClientDetailsResponseType
Nillable no
Abstract no
Documentation Get client account details: response
Logical Diagram
XML Instance Representation
<GetClientDetailsResponse>
<!-- ' ClientInfo ' super type was not found in this schema. Some elements and attributes may be missing. -->
<ID> common:positiveInteger </ID> [1]

'Reseller ID'

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

'Unique client identifier'

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

'User status'

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

'User phone status'

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

'User control panel access'

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

'Owner ID'

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

'Owner Identifier'

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

'Charging plan ID'

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

'Charging plan identifier'

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

'Charging plan name'

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

'Owner name'

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

'User template ID'

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

'Creation date'

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

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

</GetClientDetailsResponse>
Schema Component Representation
<xs:element name="GetClientDetailsResponse" type=" messagesInfo:GetClientDetailsResponseType "/>
top

Element: GetClientPLRequest

Name GetClientPLRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get client preferences and limits: request
Logical Diagram
XML Instance Representation
<GetClientPLRequest>
Start Choice [1]
<ID> common:positiveInteger </ID> [1]

'Client ID'

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

'Client identifier'

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

Element: GetClientPLResponse

Name GetClientPLResponse
Type messagesInfo:GetClientPLResponseType
Nillable no
Abstract no
Documentation Get client preferences and limits: response
Logical Diagram
XML Instance Representation
<GetClientPLResponse>
<userPL> clientData:ClientPLInfo </userPL> [0..1]

'Reseller preferences and limits'

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

Element: GetClientsRequest

Name GetClientsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get clients: request
Logical Diagram
XML Instance Representation
<GetClientsRequest>
<templateID> common:positiveInteger </templateID> [0..1]

'Client template ID'

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

'Set CTRLPANEL to filter only account added from 4PSA VoipNow control panel'

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

'Filter client list by name, company, email, login'

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

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

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

'Owner ID'

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

'Owner identifier'

End Choice
</GetClientsRequest>
Schema Component Representation
<xs:element name="GetClientsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="templateID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="serverID" type=" common:string " 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="parentID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="parentIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetClientsResponse

Name GetClientsResponse
Type messagesInfo:GetClientResponseType
Nillable no
Abstract no
Documentation Get clients: response
Logical Diagram
XML Instance Representation
<GetClientsResponse>
<client> clientData:ClientList </client> [0..*]

'Client data'

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

Element: MoveClientsRequest

Name MoveClientsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Move clients to a specific reseller account: request
Logical Diagram
XML Instance Representation
<MoveClientsRequest>
Start Choice [1]
<resellerID> common:positiveInteger </resellerID> [1]

'New owner ID for client accounts'

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

'New owner identifier for client accounts'

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

'Charging plan ID associated with moved clients'

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

'Charging plan identifier associated with moved clients'

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

'Client IDs'

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

'Client identifiers'

End Choice
</MoveClientsRequest>
Schema Component Representation
<xs:element name="MoveClientsRequest">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="resellerID" type=" common:positiveInteger "/>
<xs:element name="resellerIdentifier" type=" common:string "/>
</xs:choice>
<xs:choice>
<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
<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: MoveClientsResponse

Name MoveClientsResponse
Type messagesInfo:MoveClientsResponseType
Nillable no
Abstract no
Documentation Move clients to a specific reseller account: response
Logical Diagram
XML Instance Representation
<MoveClientsResponse>
<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'

</MoveClientsResponse>
Schema Component Representation
<xs:element name="MoveClientsResponse" type=" messagesInfo:MoveClientsResponseType "/>
top

Element: SetClientCpAccessRequest

Name SetClientCpAccessRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Change client control panel access:request
Logical Diagram
XML Instance Representation
<SetClientCpAccessRequest>
<cpAccess> common:boolean </cpAccess> [1]

'Client status'

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

'Client ID'

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

'Client identifier'

End Choice
</SetClientCpAccessRequest>
Schema Component Representation
<xs:element name="SetClientCpAccessRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="cpAccess" type=" common:boolean "/>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="identifier" type=" common:string "/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: SetClientCpAccessResponse

Name SetClientCpAccessResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Change client control panel access: response
Logical Diagram
XML Instance Representation
<SetClientCpAccessResponse>
<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..*]
</SetClientCpAccessResponse>
Schema Component Representation
<xs:element name="SetClientCpAccessResponse" type=" common:updateObject "/>
top

Element: SetClientPLRequest

Name SetClientPLRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Update client preferences and limits: request
Logical Diagram
XML Instance Representation
<SetClientPLRequest>
<permsManag> common:boolean </permsManag> [0..1]

'Permission and limit Management'

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

'Endpoint Management'

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

'Endpoint Feature Management'

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

'Endpoint SIP management'

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

'Charging Plan Management'

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

'Phone Numbers Management'

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

'Maximum number of endpoints'

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

'Maximum concurrent calls'

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

'Maximum disk space for call recording (MB)'

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

'Account expiration date'

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

'Client ID'

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

'Client identifier'

End Choice
</SetClientPLRequest>
Schema Component Representation
<xs:element name="SetClientPLRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" clientData:ClientPLInfo ">
<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: SetClientPLResponse

Name SetClientPLResponse
Type common:updateObject
Nillable no
Abstract no
Documentation Update client preferences and limits: response
Logical Diagram
XML Instance Representation
<SetClientPLResponse>
<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..*]
</SetClientPLResponse>
Schema Component Representation
<xs:element name="SetClientPLResponse" type=" common:updateObject "/>
top

Element: SetClientStatusRequest

Name SetClientStatusRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Change client status:request
Logical Diagram
XML Instance Representation
<SetClientStatusRequest>
<status> common:boolean </status> [0..1]

'Client status'

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

'Client phone status. Default value:1.'

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

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

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

'Client ID'

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

'Client identifier'

End Choice
</SetClientStatusRequest>
Schema Component Representation
<xs:element name="SetClientStatusRequest">
<xs:complexType>
<xs:sequence>
<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="scope" type=" common:string " default="automation" minOccurs="0"/>
<xs:choice>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:element name="identifier" type=" common:string "/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: SetClientStatusResponse

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

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