User - Complex Types

This section documents the complex data types for User service.

shareGroup

Description: Share with other users

Namespace: http://4psa.com/UserData.xsd/5.2.5

Choice Element

One of the following:

• groupID: xs:positiveInteger
• name: xs:string

---

shareBetween

Description: Share with other users

Namespace: http://4psa.com/UserData.xsd/5.2.5

Choice Element

One of the following:

• groupID: xs:positiveInteger
• everybody: xs:boolean

---

UserList

Description: User list data

Namespace: http://4psa.com/UserData.xsd/5.2.5

Extends: organizationData:OrganizationList

---

UserInfo

Description: User data

Namespace: http://4psa.com/UserData.xsd/5.2.5

Used by

• ExtendedUserInfo
• AddUser
• EditUser

Extends: organizationData:OrganizationInfo

Element: phoneLang

Type: common:code

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Phone language

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="phoneLang" type="common:code" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Phone language</xs:documentation>
  </xs:annotation>
</xs:element>

Element: channelRuleID

Type: common:positiveInteger

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Outgoing routing rules group id

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="channelRuleID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Outgoing routing rules group id</xs:documentation>
  </xs:annotation>
</xs:element>

Element: role

Type: xs:string

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: User role. Possible values member, administrator or owner

Properties

Property	Value
content	simple
minOccurs	0
default	member

XSD Source

<xs:element name="role" type="xs:string" minOccurs="0" default="member">
  <xs:annotation>
    <xs:documentation>User role. Possible values member, administrator or owner</xs:documentation>
  </xs:annotation>
</xs:element>

---

ExtendedUserInfo

Description: User account details data

Namespace: http://4psa.com/UserData.xsd/5.2.5

Used by

• AddUserResponse
• GetUserDetailsResponse

Extends: UserInfo

Element: ID

Type: common:positiveInteger

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: User user ID

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="ID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>User user ID</xs:documentation>
  </xs:annotation>
</xs:element>

Element: identifier

Type: common:string

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Unique client identifier

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="identifier" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Unique client identifier</xs:documentation>
  </xs:annotation>
</xs:element>

Element: parentID

Type: common:positiveInteger

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Owner ID

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="parentID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Owner ID</xs:documentation>
  </xs:annotation>
</xs:element>

Element: parentIdentifier

Type: common:string

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Owner identifier

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="parentIdentifier" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Owner identifier</xs:documentation>
  </xs:annotation>
</xs:element>

Element: status

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: User status

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

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

Element: cpAccess

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: User control panel access

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="cpAccess" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>User control panel access</xs:documentation>
  </xs:annotation>
</xs:element>

Element: parentName

Type: common:string

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Owner name

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

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

Element: chargingPlan

Type: common:string

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Charging plan name

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="chargingPlan" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Charging plan name</xs:documentation>
  </xs:annotation>
</xs:element>

Element: templateID

Type: common:positiveInteger

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: User template ID

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="templateID" type="common:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>User template ID</xs:documentation>
  </xs:annotation>
</xs:element>

Element: common:crDate

Type: common:crDate

Namespace: http://4psa.com/UserData.xsd/5.2.5

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

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

Element: common:scope

Type: common:scope

Namespace: http://4psa.com/UserData.xsd/5.2.5

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

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

Element: accountFlag

Type: restriction of xs:string

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Account flag. Possible values: noneditablelogin

Properties

Property	Value
content	complex
minOccurs	0
maxOccurs	unbounded
default	noneditablelogin

Allowed Values

Value	Description
noneditablelogin

XSD Source

<xs:element name="accountFlag" minOccurs="0" maxOccurs="unbounded" default="noneditablelogin">
  <xs:annotation>
    <xs:documentation>Account flag. Possible values:
								noneditablelogin</xs:documentation>
  </xs:annotation>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="noneditablelogin"/>
      </xs:restriction>
    </xs:simpleType>
</xs:element>

---

UserPLInfo

Description: User permissions and limits data

Namespace: http://4psa.com/UserData.xsd/5.2.5

Used by

• SetUserPL

Extends: accountData:AccountPLInfo

Element: multiUser

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Multi user aware property

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="multiUser" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Multi user aware property</xs:documentation>
  </xs:annotation>
</xs:element>

Element: phoneInsightsNotEligible

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Whether or not the user is eligible for Phone Insights

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="phoneInsightsNotEligible" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Whether or not the user is eligible for Phone Insights</xs:documentation>
  </xs:annotation>
</xs:element>

Element: phoneInsightsNoAccess

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Whether or not the user has read access to Phone Insights

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="phoneInsightsNoAccess" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Whether or not the user has read access to Phone Insights</xs:documentation>
  </xs:annotation>
</xs:element>

---

RelativeUserPLInfo

Description: User permissions and limits data

Namespace: http://4psa.com/UserData.xsd/5.2.5

Used by

• UpdateUserPL

Extends: accountData:RelativeAccountPLInfo

Element: multiUser

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Multi user aware property

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="multiUser" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Multi user aware property</xs:documentation>
  </xs:annotation>
</xs:element>

Element: phoneInsightsNotEligible

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Whether or not the user is eligible for Phone Insights

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="phoneInsightsNotEligible" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Whether or not the user is eligible for Phone Insights</xs:documentation>
  </xs:annotation>
</xs:element>

Element: phoneInsightsNoAccess

Type: common:boolean

Namespace: http://4psa.com/UserData.xsd/5.2.5

Description: Whether or not the user has read access to Phone Insights

Properties

Property	Value
content	simple
minOccurs	0

XSD Source

<xs:element name="phoneInsightsNoAccess" type="common:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Whether or not the user has read access to Phone Insights</xs:documentation>
  </xs:annotation>
</xs:element>

---