Documentation for EndpointMessagesInfo

Target Namespace	http://4psa.com/EndpointData.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): http://4psa.com/Common.xsd/2.0.0 (at ../Common.xsd) http://4psa.com/ClientData.xsd/2.0.0 (at ../Client/ClientData.xsd)

Prefix	Namespace
Default namespace	http://4psa.com/EndpointData.xsd/2.0.0
xml	http://www.w3.org/XML/1998/namespace
mstns	http://4psa.com/EndpointData.xsd/2.0.0
xs	http://www.w3.org/2001/XMLSchema
common	http://4psa.com/Common.xsd/2.0.0
clientData	http://4psa.com/ClientData.xsd/2.0.0

Super-types:	clientData:ClientInfo < EndpointInfo (by extension)
Sub-types:	ExtendedEndpointInfo (by extension)

Name	EndpointInfo
Abstract	no
Documentation	Endpoint 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:trusted> common:boolean </mstns:trusted> [0..1]

'Set this endpoint as trusted'

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

'Phone language'

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

'Outgoing routing rules group id'

</...>

Schema Component Representation

<xs:complexType name="EndpointInfo">

<xs:complexContent>

<xs:extension base=" clientData:ClientInfo ">

<xs:sequence>

<xs:element name="trusted" type=" common:boolean " minOccurs="0"/>

<xs:element name="phoneLang" type=" common:code " minOccurs="0"/>

<xs:element name="channelRuleId" type=" common:positiveInteger " minOccurs="0"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Complex Type: EndpointList

Super-types:	None
Sub-types:	None

Name	EndpointList
Abstract	no
Documentation	Endpoint list data

XML Instance Representation

<...>

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

'Endpoint user ID'

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

'Endpoint 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:endpointNo> xs:decimal </mstns:endpointNo> [0..1]

'Endpoint number'

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

'Unique endpoint user identifier'

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

'Scope identifier for the enrollment server'

</...>

Schema Component Representation

<xs:complexType name="EndpointList">

<xs:sequence>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="endpointID" 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="endpointNo" type=" xs:decimal " minOccurs="0"/>

<xs:element name="identifier" type=" common:string " minOccurs="0"/>

<xs:element name="scope" type=" common:string " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: EndpointPLInfo

Super-types:	None
Sub-types:	None

Name	EndpointPLInfo
Abstract	no
Documentation	Endpoint permissions and limits data

XML Instance Representation

<...>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice

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

'Endpoint SIP management'

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

'Maximum concurrent calls'

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

'Account expiration date'

</...>

Schema Component Representation

<xs:complexType name="EndpointPLInfo">

<xs:sequence>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

<xs:element name="sipManag" type=" common:boolean " minOccurs="0"/>

<xs:element name="concurentCalls" type=" common:unlimitedUInt " minOccurs="0"/>

<xs:element name="accountExpire" type=" common:unlimitedDate " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: EndpointSetup

Super-types:	None
Sub-types:	None

Name	EndpointSetup
Abstract	no
Documentation	Endpoint setup data

XML Instance Representation

<...>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice

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

'Caller-ID name in public calls. Values: 1- server, 0-equipment, 2-anonymous. Default: by server.'

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

'Caller-ID number in public calls. Values: 1- server, 0-equipment, 2-anonymous. Default: by server.'

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

'Public Caller-ID to be used'

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

'CallerID on internal calls like on public calls (if public callerID is available)'

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

'Send SIP P-Asserted-Identity header'

<mstns:ringEndpoint> common:integer </mstns:ringEndpoint> [1]

'Time interval to ring endpoint. Default value: 30 seconds'

<mstns:dtmf> xs:string (value comes from list: {'rfc2833'|'inband'|'info'|'auto'}) </mstns:dtmf> [0..1]

'DTMF mode. Default rfc2833.'

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

'Ping endpoint to check its status'

<mstns:codecs> common:positiveInteger </mstns:codecs> [1..*]

'Allowed codecs'

Start Choice [1]

<mstns:lockIP> common:ip </mstns:lockIP> [0..*]

'Lock endpoint to IP(s)'

<mstns:host> common:ip </mstns:host> [0..1]

'Phone is on IP {host} port {port}'

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

End Choice

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

'Equipment description'

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

'Enable/ Disable function'

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

'Call recording storage space (MB)'

<mstns:recordTrigger> xs:int (value comes from list: {'0'|'2'}) </mstns:recordTrigger> [0..1]

'Record triggered. Default value: 0'

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

'Terminal advertised by the extension if registered'

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

'Extension state, from the network perspective connection'

<mstns:registration> common:dateTime </mstns:registration> [0..1]

'Extension\'s registration expires on/expired on'

<mstns:IP> common:ip </mstns:IP> [0..1]

'Registered extension IP address'

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

</...>

Schema Component Representation

<xs:complexType name="EndpointSetup">

<xs:sequence>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

<xs:element name="callerIDSend" default="1" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="1"/>

<xs:enumeration value="0"/>

<xs:enumeration value="2"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="callerNoSend" default="1" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="1"/>

<xs:enumeration value="0"/>

<xs:enumeration value="2"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="CallerIDRef" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="callerIDInternal" type=" common:boolean " minOccurs="0"/>

<xs:element name="SIPIdentity" type=" common:boolean " minOccurs="0"/>

<xs:element name="ringEndpoint" type=" common:integer "/>

<xs:element name="dtmf" default="rfc2833" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="rfc2833"/>

<xs:enumeration value="inband"/>

<xs:enumeration value="info"/>

<xs:enumeration value="auto"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="ping" type=" common:boolean " minOccurs="0"/>

<xs:element name="codecs" type=" common:positiveInteger " maxOccurs="unbounded"/>

<xs:choice>

<xs:element name="lockIP" type=" common:ip " minOccurs="0" maxOccurs="unbounded"/>

<xs:sequence>

<xs:element name="host" type=" common:ip " minOccurs="0"/>

<xs:element name="port" type=" common:integer " minOccurs="0"/>

</xs:sequence>

</xs:choice>

<xs:element name="description" type=" common:string " minOccurs="0"/>

<xs:sequence>

<xs:element name="recordStatus" type=" common:boolean " minOccurs="0"/>

<xs:element name="recordStorage" type=" common:unlimitedUInt " minOccurs="0"/>

<xs:element name="recordTrigger" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:int ">

<xs:enumeration value="0"/>

<xs:enumeration value="2"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

</xs:sequence>

<xs:sequence>

<xs:element name="terminal" type=" common:string " minOccurs="0"/>

<xs:element name="state" type=" common:string " minOccurs="0"/>

<xs:element name="registration" type=" common:dateTime " minOccurs="0"/>

<xs:element name="IP" type=" common:ip " minOccurs="0"/>

<xs:element name="recordedMsgQuota" type=" common:string " minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Complex Type: ExtendedEndpointInfo

Super-types:	clientData:ClientInfo < EndpointInfo (by extension) < ExtendedEndpointInfo (by extension)
Sub-types:	None

Name	ExtendedEndpointInfo
Abstract	no
Documentation	Endpoint 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:trusted> common:boolean </mstns:trusted> [0..1]

'Set this endpoint as trusted'

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

'Phone language'

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

'Outgoing routing rules group id'

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

'Endpoint user ID'

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

'Unique client identifier'

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

'Endpoint ID'

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

'Owner ID'

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

'Owner identifier'

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

'User status'

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

'User control panel access'

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

'User template ID'

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

'Owner name'

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

'Charging plan name'

<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="ExtendedEndpointInfo">

<xs:complexContent>

<xs:extension base=" EndpointInfo ">

<xs:sequence>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="identifier" type=" common:string " minOccurs="0"/>

<xs:element name="endpointID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="parentID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="parentIdentifier" type=" common:string " minOccurs="0"/>

<xs:element name="status" type=" common:boolean " minOccurs="0"/>

<xs:element name="cpAccess" type=" common:boolean " minOccurs="0"/>

<xs:element name="templateID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="parentName" type=" common:string " minOccurs="0"/>

<xs:element name="chargingPlan" type=" common:string " 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>

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

Documentation for EndpointMessagesInfo

Table of Contents

Master schema documentation file: EndpointMessagesInfo.xsd.html

Schema Document Properties

Declared Namespaces

Global Definitions

Complex Type: EndpointInfo

Complex Type: EndpointList

Complex Type: EndpointPLInfo

Complex Type: EndpointSetup

Complex Type: ExtendedEndpointInfo