Documentation for ResellerMessages

Target Namespace	http://4psa.com/ResellerMessages.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/ResellerData.xsd/2.0.0 (at ResellerData.xsd) http://4psa.com/ResellerMessagesInfo.xsd/2.0.0 (at ResellerMessagesInfo.xsd) http://4psa.com/Common.xsd/2.0.0 (at ../Common.xsd)

Prefix	Namespace
Default namespace	http://4psa.com/ResellerMessages.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/ResellerMessagesInfo.xsd/2.0.0
xs	http://www.w3.org/2001/XMLSchema
resellerData	http://4psa.com/ResellerData.xsd/2.0.0

Schema Component Representation

<xs:schema targetNamespace="http://4psa.com/ResellerMessages.xsd/2.0.0" elementFormDefault="qualified" id="ResellerMessages">

<xs:import namespace="http://4psa.com/ResellerData.xsd/2.0.0" schemaLocation="ResellerData.xsd"/>

<xs:import namespace="http://4psa.com/ResellerMessagesInfo.xsd/2.0.0" schemaLocation="ResellerMessagesInfo.xsd"/>

<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>

...

</xs:schema>

Global Declarations

Element: AddResellerRequest

Name	AddResellerRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Add reseller: request

XML Instance Representation

Start Choice [1]

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

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

Start Choice [1]

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

'Charging plan ID'

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

'Charging plan identifier'

End Choice
End Choice

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

'Reseller template ID'

Start Choice [1]

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

'Owner ID'

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

'Owner identifier'

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'

</AddResellerRequest>

Schema Component Representation

<xs:element name="AddResellerRequest">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" resellerData:ResellerInfo ">

<xs:sequence>

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

Element: AddResellerResponse

Name	AddResellerResponse
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Add reseller: response

XML Instance Representation

<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]

'Reseller template'

</AddResellerResponse>

Schema Component Representation

<xs:element name="AddResellerResponse">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" messagesInfo:GetResellerDetailsResponseType ">

<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>

Element: DelResellerRequest

Name	DelResellerRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Delete reseller: request

XML Instance Representation

<DelResellerRequest>
Start Choice [1]

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

'Reselles IDs'

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

'Reseller identifiers'

End Choice
</DelResellerRequest>

Schema Component Representation

<xs:element name="DelResellerRequest">

<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>

Element: DelResellerResponse

Name	DelResellerResponse
Type	common:delObject
Nillable	no
Abstract	no
Documentation	Delete reseller: response

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'

</DelResellerResponse>

Schema Component Representation

<xs:element name="DelResellerResponse" type=" common:delObject "/>

Element: EditResellerRequest

Name	EditResellerRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Edit reseller: request

XML Instance Representation

Start Choice [1]

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

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

Start Choice [1]

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

'Charging plan ID'

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

'Charging plan identifier'

End Choice
End Choice
Start Choice [1]

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

'Reseller ID'

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

'Reseller identifier'

End Choice
</EditResellerRequest>

Schema Component Representation

<xs:element name="EditResellerRequest">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" resellerData:ResellerInfo ">

<xs:choice>

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

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

</xs:choice>

</xs:extension>

</xs:complexContent>

</xs:complexType>

</xs:element>

Element: EditResellerResponse

Name	EditResellerResponse
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Edit reseller: response

XML Instance Representation

<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'

</EditResellerResponse>

Schema Component Representation

<xs:element name="EditResellerResponse">

<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>

Element: GetResellerDetailsRequest

Name	GetResellerDetailsRequest
Type	Locally-defined complex type
Nillable	yes
Abstract	no
Documentation	Get details reseller data: request

XML Instance Representation

<GetResellerDetailsRequest>
Start Choice [1]

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

'Reseller ID'

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

'Reseller identifier'

End Choice
</GetResellerDetailsRequest>

Schema Component Representation

<xs:element name="GetResellerDetailsRequest" nillable="true">

<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>

Element: GetResellerDetailsResponse

Name	GetResellerDetailsResponse
Type	messagesInfo:GetResellerDetailsResponseType
Nillable	no
Abstract	no
Documentation	Get detailed reseller data: response

XML Instance Representation

</GetResellerDetailsResponse>

Schema Component Representation

<xs:element name="GetResellerDetailsResponse" type=" messagesInfo:GetResellerDetailsResponseType "/>

Element: GetResellerPLRequest

Name	GetResellerPLRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get reseller preferences and limits: request

XML Instance Representation

<GetResellerPLRequest>
Start Choice [1]

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

'Reseller ID'

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

'Reseller identifier'

End Choice
</GetResellerPLRequest>

Schema Component Representation

<xs:element name="GetResellerPLRequest">

<xs:complexType>

<xs:choice>

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

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

</xs:choice>

</xs:complexType>

</xs:element>

Element: GetResellerPLResponse

Name	GetResellerPLResponse
Type	messagesInfo:GetResellerPLResponseType
Nillable	no
Abstract	no
Documentation	Get reseller preferences and limits: response

XML Instance Representation

<userPL> resellerData:ResellerPLInfo </userPL> [0..1]

'Reseller preferences and limits'

<notice> common:notice </notice> [0..*]

</GetResellerPLResponse>

Schema Component Representation

<xs:element name="GetResellerPLResponse" type=" messagesInfo:GetResellerPLResponseType "/>

Element: GetResellersRequest

Name	GetResellersRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get resellers: request

XML Instance Representation

<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 resellers list after 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
</GetResellersRequest>

Schema Component Representation

<xs:element name="GetResellersRequest">

<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>

Element: GetResellersResponse

Name	GetResellersResponse
Type	messagesInfo:GetResellersResponseType
Nillable	no
Abstract	no
Documentation	Get resellers: response

XML Instance Representation

<reseller> resellerData:ResellerList </reseller> [0..*]

<notice> common:notice </notice> [0..*]

</GetResellersResponse>

Schema Component Representation

<xs:element name="GetResellersResponse" type=" messagesInfo:GetResellersResponseType "/>

Element: SetResellerCpAccessRequest

Name	SetResellerCpAccessRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Change reseller control panel access:request

XML Instance Representation

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

'Reseller status'

Start Choice [1]

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

'Reseller ID'

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

'Reseller identifier'

End Choice
</SetResellerCpAccessRequest>

Schema Component Representation

<xs:element name="SetResellerCpAccessRequest">

<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>

Element: SetResellerCpAccessResponse

Name	SetResellerCpAccessResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Change reseller control panel access: response

XML Instance Representation

<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..*]

</SetResellerCpAccessResponse>

Schema Component Representation

<xs:element name="SetResellerCpAccessResponse" type=" common:updateObject "/>

Element: SetResellerPLRequest

Name	SetResellerPLRequest
Type	resellerData:ResellerPLInfo
Nillable	no
Abstract	no
Documentation	Update reseller preferences and limits: request

XML Instance Representation

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

'Client Management'

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

'See Stacked Phone Numbers'

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

Start Choice [1]

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

'Reseller ID'

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

'Reseller identifier'

End Choice
</SetResellerPLRequest>

Schema Component Representation

<xs:element name="SetResellerPLRequest" type=" resellerData:ResellerPLInfo "/>

Element: SetResellerPLResponse

Name	SetResellerPLResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Update reseller references and limits: response

XML Instance Representation

<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..*]

</SetResellerPLResponse>

Schema Component Representation

<xs:element name="SetResellerPLResponse" type=" common:updateObject "/>

Element: SetResellerStatusRequest

Name	SetResellerStatusRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Change reseller status:request

XML Instance Representation

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

'Reseller status'

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

'Reseller 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]

'Reseller ID'

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

'Reseller identifier'

End Choice
</SetResellerStatusRequest>

Schema Component Representation

<xs:element name="SetResellerStatusRequest">

<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>

Element: SetResellerStatusResponse

Name	SetResellerStatusResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Change reseller status: response

XML Instance Representation

<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..*]

</SetResellerStatusResponse>

Schema Component Representation

<xs:element name="SetResellerStatusResponse" type=" common:updateObject "/>

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

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: AddResellerRequest

Element: AddResellerResponse

Element: DelResellerRequest

Element: DelResellerResponse

Element: EditResellerRequest

Element: EditResellerResponse

Element: GetResellerDetailsRequest

Element: GetResellerDetailsResponse

Element: GetResellerPLRequest

Element: GetResellerPLResponse

Element: GetResellersRequest

Element: GetResellersResponse

Element: SetResellerCpAccessRequest

Element: SetResellerCpAccessResponse

Element: SetResellerPLRequest

Element: SetResellerPLResponse

Element: SetResellerStatusRequest

Element: SetResellerStatusResponse