Documentation for EndpointMessagesInfo

Table of Contents

top

Schema Document Properties

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

Global Definitions

Complex Type: GetAvailableCallerIDResponseType

Super-types: None
Sub-types: None
Name GetAvailableCallerIDResponseType
Abstract no
Documentation Get available Caller ID list for phone terminal endpoint: response type
XML Instance Representation
<...>
<CallerID> [0..*]

'Available Caller-ID'


<endpointNo> xs:decimal </endpointNo> [1]

'Endpoint number'

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

'Contact name'

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

'Public phone number'

<CallerIDRef> common:positiveInteger </CallerIDRef> [1]

'Caller-ID reference ID'

</CallerID>
<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetAvailableCallerIDResponseType">
<xs:sequence>
<xs:element name="CallerID" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="endpointNo" type=" xs:decimal "/>
<xs:element name="name" type=" common:string "/>
<xs:element name="phoneNo" type=" common:string "/>
<xs:element name="CallerIDRef" type=" common:positiveInteger "/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetEndpointDetailsResponseType

Super-types: endpointData:ExtendedEndpointInfo < GetEndpointDetailsResponseType (by extension)
Sub-types: None
Name GetEndpointDetailsResponseType
Abstract no
Documentation Get detailed endpoint data: response type
XML Instance Representation
<...>
<!-- ' EndpointInfo ' super type was not found in this schema. Some elements and attributes may be missing. -->
<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'

<endpointNo> common:integer </endpointNo> [0..1]

'Endpoint number'

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

'Charging plan ID'

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

'Charging plan identifier'

</...>
Schema Component Representation
<xs:complexType name="GetEndpointDetailsResponseType">
<xs:complexContent>
<xs:extension base=" endpointData:ExtendedEndpointInfo ">
<xs:sequence>
<xs:element name="endpointNo" type=" common:integer " minOccurs="0"/>
<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GetEndpointPLResponseType

Super-types: None
Sub-types: None
Name GetEndpointPLResponseType
Abstract no
Documentation Get endpoints permissions and limits: response data
XML Instance Representation
<...>
<endpointPL> endpointData:EndpointPLInfo </endpointPL> [0..1]

'Endpoint permissions and limits data'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetEndpointPLResponseType">
<xs:sequence>
<xs:element name="endpointPL" type=" endpointData:EndpointPLInfo " minOccurs="0"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetEndpointResponseType

Super-types: None
Sub-types: None
Name GetEndpointResponseType
Abstract no
Documentation Get endpoint: response type
XML Instance Representation
<...>
<endpoint> endpointData:EndpointList </endpoint> [0..*]

'Endpoint data on succes'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetEndpointResponseType">
<xs:sequence>
<xs:element name="endpoint" type=" endpointData:EndpointList " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top