Simple Types
This section documents all simple data types used across the API.
Common
positiveInteger
Object ID
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:positiveInteger
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
| totalDigits | 4 |
Used by
<accountdata:parentID>element<accountdata:fromUser>element<accountdata:chargingPlanID>element<accountdata:channelRuleID>element<accountdata:templateID>element- ChargingPlanInfo/soundID
- ChargingPlanInfo/channelRuleID
- ChargingPlanList/ID
- ChargingPlanList/userID
- CreditsList/creditID
- LimitsList/limitID
- DestinationException/chargingPackageID
- DestinationExceptionList/chargingPlanID
- ChargingPackageList/chargingPlanID
<channeldata:channelID>element- SIPChannelInfo/codecs
- ChannelList/ID
- Codecs/ID
- PublicNoList/channelID
- PublicNoList/didID
- PublicNoList/callbackExtID
- ChannelGroupInfo/channelID
- ChannelGroupList/ID
- RoutingRuleInfo/intervalID
- RoutingRuleInfo/channelID
- RoutingRuleGroupInfo/userID
- CallRulesOutGroupList/ID
<common:ID>element<common:userID>element- singleUpdateObject/ID
<extensiondata:CallerIDRef>element<extensiondata:extensionID>element<extensiondata:ruleID>element- ExtensionInfo/channelRuleID
- ExtendedExtensionInfo/parentID
- ExtendedExtensionInfo/templateID
- SIPPreferencesInfo/codecs
- CallRuleInfo/intervalID
- CardCodeList/ID
- CallerIDList/ID
- CreditInfo/ID
- RechargeInfo/ID
- PhoneCallerIDInfo/defaultCallerIDRef
- PhoneCallerIDInfo/callerIDRefs
- Agent/ID
- VoicemailInfo/connectionSnd
- DeviceRegistrationInfo/status
- ScheduledConference/roomSize
- OrganizationInfo/region
- OrganizationInfo/timezone
<pbxdata:deviceID>element<pbxdata:assignedOrganizationID>element- UserSounds/userID
- Template/ID
- Template/userID
- Template/chargingPlanID
- TimeIntervalBlock/ID
- TimeIntervalBlock/userID
- Sounds/ID
- Sounds/folderID
- Folders/ID
- Folders/userID
- shareGroup/groupID
- shareBetween/groupID
- UserInfo/channelRuleID
- ExtendedUserInfo/ID
- ExtendedUserInfo/parentID
- ExtendedUserInfo/templateID
boolean
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:boolean
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
Used by
<accountdata:verbose>element<accountdata:status>element<accountdata:cpAccess>element- CommonPL/extensionManag
- CommonPL/extFeatureManag
- CommonPL/sipManag
- CommonPL/sipTrunkingManag
- CommonPL/soundManag
- CommonPL/numberManag
- CommonPL/callAPIManag
- CommonPL/callerIDManag
- ChargingPlanInfo/default
- ChargingPlanList/status
- ChargingPlanList/default
- Limits/monthly
- SIPChannelInfo/register
- SIPChannelInfo/paid
- SIPChannelInfo/behindNAT
- SIPChannelInfo/trusted
- SIPChannelInfo/trustRemotePartyID
- SIPChannelInfo/sendRemotePartyID
- SIPChannelInfo/supportIce
- SIPChannelInfo/supportEncryption
- SIPChannelInfo/enableDTLS
- SIPChannelInfo/useMD5
- ChannelList/status
- ChannelList/paid
- RoutingRuleInfo/final
- RoutingRuleGroupInfo/default
- CallRulesOutGroupList/status
- CallRulesOutGroupList/inUse
- CallRulesOutGroupList/default
- share/everybody
- limit/unlimited
<extensiondata:auth>element<extensiondata:supervisor>element- shareBetween/everybody
- SIPPreferencesInfo/provision
- SIPPreferencesInfo/PBXConnected
- SIPPreferencesInfo/qualify
- SIPPreferencesInfo/allowReInvite
- SIPPreferencesInfo/publishStatus
- SIPPreferencesInfo/forceMWI
- SIPPreferencesInfo/allowVirtualization
- SIPPreferencesInfo/register
- CallRuleTransferInfo/call
- CallRuleTransferInfo/askForCaller
- CallRuleTransferInfo/transferFromCallee
- CardCodeList/status
- CallerIDList/status
- PhoneTerminal/callWaiting
- PhoneCallerIDInfo/anonymous
- PhoneCallerIDInfo/callerIDInternal
- PhoneCallerIDInfo/callerIDOnTransfer
- PhoneCallerIDInfo/SIPIdentity
- PhoneQueue/record
- PhoneQueue/phoneInsightsNotEligible
- PhoneQueue/phoneInsightsOrgShared
- PhoneQueue/disconnectSndActive
- QueueCenterInfo/connectionSndActive
- Voicemail/status
- Voicemail/autoAnswer
- Voicemail/directory
- Voicemail/envelope
- Conference/status
- Conference/mohActive
- Conference/PIN
- Conference/close
- Conference/announceUserCount
- Conference/announceUser
- CallRecording/status
- CallRecording/recordSndActive
- CallRecording/phoneInsightsNotEligible
- CallRecording/phoneInsightsOrgShared
- FaxCenter/status
- FaxCenter/autoAnswer
- FaxCenter/fax2voicemail
- FaxCenter/faxFromEmailActive
- FaxCenter/faxSndActive
- Agent/supervisor
- QueueMember/supervisor
- QueueMember/status
- VoicemailCenterInfo/connectionSndActive
- ConferenceInfo/connectionSndActive
- ConferenceInfo/phoneInsightsNotEligible
- ConferenceInfo/phoneInsightsOrgShared
- ConferenceInfo/mohActive
- ConferenceInfo/close
- ConferenceInfo/announceExtensionCount
- ConferenceInfo/announceExtension
- VoicemailInfo/connectionSndActive
- RemoteAgent/requireConfirmation
- ScheduledConference/connectSndActive
- ScheduledConference/mohActive
- ScheduledConference/close
- ScheduledConference/startMuted
- ScheduledConference/unmuteAllowed
- ScheduledConference/userCountAnnounce
- ScheduledConference/joinAnnounce
- OrganizationInfo/passwordAuto
- OrganizationInfo/forceUpdate
- OrganizationPLInfo/permsManag
- OrganizationPLInfo/chargingPlanManag
- RelativeOrganizationPLInfo/permsManag
- RelativeOrganizationPLInfo/chargingPlanManag
- DeviceInfo/MACBased
- Template/subscription
- CustomAlert/displayToOwner
- CustomButton/includeServiceProviderID
- CustomButton/includeClientID
- CustomButton/includeExtensionID
- CustomButton/includeExtensionNo
- CustomButton/includeExtensionPublicNo
- CustomButton/includeChargingPlanID
- ServiceProviderPLInfo/organizationManag
- ServiceProviderPLInfo/stackedManag
- ServiceProviderPLInfo/allowPhoneInsights
- RelativeServiceProviderPLInfo/organizationManag
- RelativeServiceProviderPLInfo/stackedManag
- RelativeServiceProviderPLInfo/allowPhoneInsights
- ExtendedUserInfo/status
- ExtendedUserInfo/cpAccess
- UserPLInfo/multiUser
- UserPLInfo/phoneInsightsNotEligible
- UserPLInfo/phoneInsightsNoAccess
- RelativeUserPLInfo/multiUser
- RelativeUserPLInfo/phoneInsightsNotEligible
- RelativeUserPLInfo/phoneInsightsNoAccess
integer
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:integer
Used by
<accountdata:linkResourceID>element- ChargingPackage/minutes
- SIPChannelInfo/port
- SIPChannelInfo/sessionExpire
- SIPChannelInfo/sessionMinExpire
- ChannelGroupList/channels
- delObject/items
- limit/value
<extensiondata:penalty>element- SIPPreferencesInfo/port
- CallRuleTransferInfo/ring
- CardCodeList/recharges
- CallerIDList/recharges
- PhoneTerminal/noAnswer
- PhoneTerminal/parkTimeout
- ExtendedQueue/agents
- ExtendedQueue/registeredAgents
- ExtendedQueue/supervisors
- Voicemail/autoAnswerTime
- Conference/size
- Conference/timeout
- FaxCenter/autoAnswerSeconds
- Agent/penalty
- QueueMember/penalty
- ConferenceInfo/size
- IVR/timeout
- IVR/lifetime
- RemoteAgent/penalty
- ScheduledConference/timezoneID
- DeviceExtension/line
- TimeInterval/month
- Template/users
- TimeIntervalBlock/intervals
- Sounds/system
- Sounds/status
- Sounds/musicOnHold
- Folders/musicOnHoldSoundsNo
- Folders/nonMusicOnHoldSoundsNo
- CustomAlert/priority
- UserStatistics/total
- UserStatistics/active
- UserStatistics/expired
- UserStatistics/suspended
- CallStatistics/total
- QuickStats/phoneNumbers
- QuickStats/callcardCodes
- QuickStats/callbackCallerIDs
- QuickStats/concurrentCallSipTrunking
- QuickStats/extensionsWithSipTrunkingChannels
<userdata:extensionNo>element
unsignedInt
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:unsignedInt
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
Used by
- RoutingRuleInfo/position
- CallRulesOutGroupList/rulesNo
- unlimitedUInt
- unlimitedUString
- CallRuleInfo/position
- ScheduledConference/dayOfWeek
- ScheduledConference/dayOfMonth
- ScheduledConference/month
- ScheduledConferenceSession/participants
- ScheduledConferenceSession/maxParticipants
- TimeInterval/startDay
- TimeInterval/endDay
- TimeInterval/startWkday
- TimeInterval/endWkday
- CallCostInfo/totalCalls
- CallCostInfo/localCall
- CallCostInfo/elocalCall
- CallCostInfo/externalCall
- CallCostInfo/incomingCall
- CallCostInfo/outgoingCall
short
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:short
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
unsignedShort
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:unsignedShort
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
double
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:double
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
float
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:float
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
Used by
emptyFloat
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| pattern | ([0-9]+)\.([0-9]+)? |
dateTime
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:dateTime
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
Used by
string
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| maxLength | 255 |
| whiteSpace | collapse |
Used by
<accountdata:parentIdentifier>element<accountdata:fromUserIdentifier>element<accountdata:notifyOnly>element<accountdata:filter>element<accountdata:linkUUID>element<accountdata:dku>element<accountdata:serverID>element<accountdata:parentLogin>element<accountdata:chargingPlanIdentifier>element<accountdata:template>element- ChargingPlanInfo/name
- ChargingPlanInfo/planType
- ChargingPlanInfo/channelRule
- ChargingPlanList/identifier
- ChargingPlanList/name
- ChargingPlanList/planType
- ChargingPlanList/userName
- Credits/creditIn
- Credits/creditOut
- Credits/orderNo
- Limits/limitIn
- Limits/limitOut
- Limits/overusage
- Limits/orderNo
- DestinationException/areaCode
- DestinationException/description
- ChargingPackage/name
- Recharge/currency
- SIPChannelInfo/name
- SIPChannelInfo/login
- SIPChannelInfo/authUsername
- SIPChannelInfo/fromUser
- SIPChannelInfo/authExt
- SIPChannelInfo/didFromInvite
- SIPChannelInfo/notes
- ChannelList/name
- Codecs/name
- Codecs/type
- PublicNoInfo/phoneNo
- PublicNoInfo/did
- PublicNoInfo/location
- PublicNoList/channel
- PublicNoList/did
- PublicNoList/location
- PublicNoList/phoneNo
- PublicNoList/callbackExt
- ChannelGroupInfo/name
- ChannelGroupList/name
- RoutingRuleInfo/engine
- RoutingRuleGroupInfo/name
- CallRulesOutGroupList/name
<common:scope>element<common:extendedNumber>element<common:identifier>element<common:userIdentifier>element- singleUpdateObject/identifier
- updateExtensionObject/extendedNumber
- diskSpace/used
- limit/increase
- limit/decrease
<extensiondata:label>element<extensiondata:queueExtendedNumber>element<extensiondata:agentExtendedNumber>element<extensiondata:CallerID>element<extensiondata:extensionNo>element<extensiondata:phoneNo>element<extensiondata:code>element<extensiondata:location>element<extensiondata:extensionIdentifier>element- ExtensionList/name
- ExtensionList/firstName
- ExtensionList/lastName
- ExtensionList/identifier
- ExtendedExtensionInfo/parentIdentifier
- ExtendedExtensionInfo/parentName
- ExtendedExtensionInfo/firstName
- ExtendedExtensionInfo/lastName
- SIPPreferencesInfo/agentId
- SIPPreferencesInfo/description
- Equipments/uniqueID
- Equipments/model
- CardCodeInfo/code
- CardCodeInfo/orderNo
- CallerIDInfo/CallerID
- CallerIDInfo/orderNo
- RechargeInfo/orderNo
- PhoneTerminal/mohFolder
- PhoneTerminal/virtualizationCode
- PhoneCallerIDInfo/callerName
- PhoneCallerIDInfo/callerNumber
- ExtendedPhoneTerminal/terminal
- ExtendedPhoneTerminal/state
- ExtendedPhoneTerminal/voicemailMsgQuota
- ExtendedPhoneTerminal/faxMsgQuota
- ExtendedPhoneTerminal/musicFilesQuota
- ExtendedPhoneTerminal/soundFilesQuota
- ExtendedPhoneTerminal/recordedMsgQuota
- PhoneQueue/name
- PhoneQueue/disconnectSnd
- QueueCenterInfo/connectionSnd
- Voicemail/password
- Voicemail/exitToOperator
- CallRecording/recordSnd
- FaxCenter/faxSnd
- Agent/extensionNo
- QueueMember/name
- VoicemailCenterInfo/connectionSnd
- ConferenceInfo/connectionSnd
- ConferenceInfo/mohFolder
- IVR/name
- IVR/description
- IVR/mohFolder
- IVR/transferExtension
- IVR/sound
- RemoteAgent/name
- RemoteAgent/phoneNumber
- DeviceRegistrationInfo/agent
- ScheduledConference/name
- ScheduledConference/connectSnd
- updateScheduledConfObject/conferenceNumber
- OrganizationInfo/name
- OrganizationInfo/firstName
- OrganizationInfo/lastName
- OrganizationInfo/company
- OrganizationInfo/login
- OrganizationInfo/phone
- OrganizationInfo/fax
- OrganizationInfo/address
- OrganizationInfo/city
- OrganizationInfo/chargingIdentifier
- OrganizationInfo/subscriptionID
- ExtendedOrganizationInfo/chargingPlan
- ExtendedOrganizationInfo/parentName
- OrganizationPLInfo/phoneInsightsSubscription
- RelativeOrganizationPLInfo/phoneInsightsSubscription
- OrganizationList/name
- OrganizationList/firstName
- OrganizationList/lastName
- OrganizationList/login
- OrganizationList/company
<pbxdata:name>element<pbxdata:enrollmentID>element<pbxdata:serial>element<pbxdata:version>element- DeviceInfo/connectionType
- DeviceInfo/connectionIP
- DeviceInfo/mask
- DeviceInfo/gateway
- Language/version
- Template/userName
- Template/chargingPlan
- Sounds/folder
- Folders/userName
- CustomAlert/code
- CustomAlert/text
- Ping
- UpgradeVoipNow
- UpgradeHistory
- GetSchemaVersions
- GetInterfaceLang
- GetPhoneLang
- GetEquipmentList
<reportdata:login>element<reportdata:currency>element- shareGroup/name
- UserInfo/role
- ExtendedUserInfo/identifier
- ExtendedUserInfo/parentIdentifier
- ExtendedUserInfo/parentName
- ExtendedUserInfo/chargingPlan
text
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | preserve |
base64
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:base64Binary
Restrictions:
| Facet | Value |
|---|---|
| whiteSpace | collapse |
ip
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| pattern | `\A([01]?\d{1,2} |
| whiteSpace | collapse |
Used by
rule
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| pattern | [*XZN\-\.\[\]\d]+ |
| whiteSpace | collapse |
password
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| minLength | 4 |
| maxLength | 64 |
Used by
- SIPChannelInfo/password
<extensiondata:password>element- OrganizationInfo/password
email
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| minLength | 0 |
| maxLength | 255 |
| pattern | [\-\+_[a-zA-Z]\d\.]*@([[a-xA-Z]\d][\-[a-zA-Z]\d]*\.)*[[a-zA-Z]][\-[a-zA-Z]\d]*\.? |
domain
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| pattern | `(((([a-zA-Z0-9]+) |
| whiteSpace | collapse |
code
Two-character code type.Used for languages and countries.
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| maxLength | 2 |
| whiteSpace | collapse |
Used by
pcode
Postal/zip code type
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Restrictions:
| Facet | Value |
|---|---|
| maxLength | 10 |
Used by
queueAnnounceOption
Namespace: http://4psa.com/Common.xsd/5.2.5
Base type: xs:string
Allowed Values:
| Value | Description |
|---|---|
never | |
once | |
periodic |