share/OCISchemaAS/OCISchemaAS.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!-- ********************************************************************** -->\r
   3 <!-- Copyright (c) 2004-2005 Broadsoft, Inc.  All rights reserved.          -->\r
   4 <!-- ********************************************************************** -->\r
   5 <!--                 O C I   X M L   S C H E M A                            -->\r
   6 <!--                                                                        -->\r
   7 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
   8 <!-- Open Client Interface (OCI).                                           -->\r
   9 <!-- ********************************************************************** -->\r
  10 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="C" attributeFormDefault="qualified" elementFormDefault="qualified">\r
  11   <xs:import namespace="C" schemaLocation="OCISchemaBASE.xsd"/>\r
  12   <xs:include schemaLocation="OCISchemaDataTypes.xsd"/>\r
  13   <xs:include schemaLocation="OCISchemaSearchCriteria.xsd"/>\r
  14   <xs:include schemaLocation="OCISchemaEnterprise.xsd"/>\r
  15   <xs:include schemaLocation="OCISchemaGroup.xsd"/>\r
  16   <xs:include schemaLocation="OCISchemaLogin.xsd"/>\r
  17   <xs:include schemaLocation="OCISchemaServiceProvider.xsd"/>\r
  18   <xs:include schemaLocation="OCISchemaSystem.xsd"/>\r
  19   <xs:include schemaLocation="OCISchemaUser.xsd"/>\r
  20   <xs:include schemaLocation="OCISchemaHiddenDeprecated20.xsd"/>\r
  21   <xs:include schemaLocation="OCISchemaLawfulInterceptDeprecated20.xsd"/>\r
  22   <xs:include schemaLocation="OCISchemaASDeprecatedSpecialExceptions.xsd"/>\r
  23   <xs:include schemaLocation="Services/OCISchemaService3G4GContinuity.xsd"/>\r
  24   <xs:include schemaLocation="Services/OCISchemaServiceAccountAuthorizationCodes.xsd"/>\r
  25   <xs:include schemaLocation="Services/OCISchemaServiceAdviceOfCharge.xsd"/>\r
  26   <xs:include schemaLocation="Services/OCISchemaServiceAlternateNumbers.xsd"/>\r
  27   <xs:include schemaLocation="Services/OCISchemaServiceAnonymousCallRejection.xsd"/>\r
  28   <xs:include schemaLocation="Services/OCISchemaServiceAttendantConsole.xsd"/>\r
  29   <xs:include schemaLocation="Services/OCISchemaServiceAuthentication.xsd"/>\r
  30   <xs:include schemaLocation="Services/OCISchemaServiceAutoAttendant.xsd"/>\r
  31   <xs:include schemaLocation="Services/OCISchemaServiceAutomaticCallback.xsd"/>\r
  32   <xs:include schemaLocation="Services/OCISchemaServiceAutomaticHoldRetrieve.xsd"/>\r
  33   <xs:include schemaLocation="Services/OCISchemaServiceBargeInExempt.xsd"/>\r
  34   <xs:include schemaLocation="Services/OCISchemaServiceBasicCallLogs.xsd"/>\r
  35   <xs:include schemaLocation="Services/OCISchemaServiceBroadWorksAnywhere.xsd"/>\r
  36   <xs:include schemaLocation="Services/OCISchemaServiceBroadWorksMobility.xsd"/>\r
  37   <xs:include schemaLocation="Services/OCISchemaServiceGroupPaging.xsd"/>\r
  38   <xs:include schemaLocation="Services/OCISchemaServiceBusyLampField.xsd"/>\r
  39   <xs:include schemaLocation="Services/OCISchemaServiceCallCapacityManagement.xsd"/>\r
  40   <xs:include schemaLocation="Services/OCISchemaServiceCallCenter.xsd"/>\r
  41   <xs:include schemaLocation="Services/OCISchemaServiceCallCenterMonitoring.xsd"/>\r
  42   <xs:include schemaLocation="Services/OCISchemaServiceCallForwardingAlways.xsd"/>\r
  43   <xs:include schemaLocation="Services/OCISchemaServiceCallForwardingBusy.xsd"/>\r
  44   <xs:include schemaLocation="Services/OCISchemaServiceCallForwardingNoAnswer.xsd"/>\r
  45   <xs:include schemaLocation="Services/OCISchemaServiceCallForwardingNotReachable.xsd"/>\r
  46   <xs:include schemaLocation="Services/OCISchemaServiceCallingLineIDBlockingOverride.xsd"/>\r
  47   <xs:include schemaLocation="Services/OCISchemaServiceCallingLineIDDeliveryBlocking.xsd"/>\r
  48   <xs:include schemaLocation="Services/OCISchemaServiceCallingNameDelivery.xsd"/>\r
  49   <xs:include schemaLocation="Services/OCISchemaServiceCallingNameRetrieval.xsd"/>\r
  50   <xs:include schemaLocation="Services/OCISchemaServiceCallingNumberDelivery.xsd"/>\r
  51   <xs:include schemaLocation="Services/OCISchemaServiceCallingPartyCategory.xsd"/>\r
  52   <xs:include schemaLocation="Services/OCISchemaServiceCallingPlan.xsd"/>\r
  53   <xs:include schemaLocation="Services/OCISchemaServiceCallForwardingSelective.xsd"/>\r
  54   <xs:include schemaLocation="Services/OCISchemaServiceCallMeNow.xsd"/>\r
  55   <xs:include schemaLocation="Services/OCISchemaServiceCallNotify.xsd"/>\r
  56   <xs:include schemaLocation="Services/OCISchemaServiceCallPark.xsd"/>\r
  57   <xs:include schemaLocation="Services/OCISchemaServiceCallPickup.xsd"/>\r
  58   <xs:include schemaLocation="Services/OCISchemaServiceCallReturn.xsd"/>\r
  59   <xs:include schemaLocation="Services/OCISchemaServiceCallRecording.xsd"/>\r
  60   <xs:include schemaLocation="Services/OCISchemaServiceCallTransfer.xsd"/>\r
  61   <xs:include schemaLocation="Services/OCISchemaServiceCallWaiting.xsd"/>\r
  62   <xs:include schemaLocation="Services/OCISchemaServiceChargeNumber.xsd"/>\r
  63   <xs:include schemaLocation="Services/OCISchemaServiceClassMark.xsd"/>\r
  64   <xs:include schemaLocation="Services/OCISchemaServiceCollaborate.xsd"/>\r
  65   <xs:include schemaLocation="Services/OCISchemaServiceCommPilotCallManager.xsd"/>\r
  66   <xs:include schemaLocation="Services/OCISchemaServiceCommPilotExpress.xsd"/>\r
  67   <xs:include schemaLocation="Services/OCISchemaServiceCommPilotExpressSR.xsd"/>\r
  68   <xs:include schemaLocation="Services/OCISchemaServiceCommunicationBarringUserControl.xsd"/>\r
  69   <xs:include schemaLocation="Services/OCISchemaServiceCommunicator.xsd"/>\r
  70   <xs:include schemaLocation="Services/OCISchemaServiceConnectedLineIdentificationRestriction.xsd"/>\r
  71   <xs:include schemaLocation="Services/OCISchemaServiceConnectedLineIdentificationPresentation.xsd"/>\r
  72   <xs:include schemaLocation="Services/OCISchemaServiceCustomRingback.xsd"/>\r
  73   <xs:include schemaLocation="Services/OCISchemaServiceDirectedCallPickupWithBargeIn.xsd"/>\r
  74   <xs:include schemaLocation="Services/OCISchemaServiceDirectoryNumberHunting.xsd"/>\r
  75   <xs:include schemaLocation="Services/OCISchemaServiceDoNotDisturb.xsd"/>\r
  76   <xs:include schemaLocation="Services/OCISchemaServiceDualModeVCC.xsd"/>\r
  77   <xs:include schemaLocation="Services/OCISchemaServiceEmergencyZones.xsd"/>\r
  78   <xs:include schemaLocation="Services/OCISchemaServiceEnhancedCallLogs.xsd"/>\r
  79   <xs:include schemaLocation="Services/OCISchemaServiceExecutive.xsd"/>\r
  80   <xs:include schemaLocation="Services/OCISchemaServiceExecutiveAssistant.xsd"/>\r
  81   <xs:include schemaLocation="Services/OCISchemaServiceExternalCallingLineIDDelivery.xsd"/>\r
  82   <xs:include schemaLocation="Services/OCISchemaServiceExternalCustomRingback.xsd"/>\r
  83   <xs:include schemaLocation="Services/OCISchemaServiceFaxMessaging.xsd"/>\r
  84   <xs:include schemaLocation="Services/OCISchemaServiceFindMeFollowMe.xsd"/>\r
  85   <xs:include schemaLocation="Services/OCISchemaServiceFlexibleSeatingGuest.xsd"/>\r
  86   <xs:include schemaLocation="Services/OCISchemaServiceGroupNightForwarding.xsd"/>\r
  87   <xs:include schemaLocation="Services/OCISchemaServiceHotelingGuest.xsd"/>\r
  88   <xs:include schemaLocation="Services/OCISchemaServiceHotelingHost.xsd"/>\r
  89   <xs:include schemaLocation="Services/OCISchemaServiceHuntGroup.xsd"/>\r
  90   <xs:include schemaLocation="Services/OCISchemaServiceInCallServiceActivation.xsd"/>\r
  91   <xs:include schemaLocation="Services/OCISchemaServiceINIntegration.xsd"/>\r
  92   <xs:include schemaLocation="Services/OCISchemaServiceIncomingCallingPlan.xsd"/>\r
  93   <xs:include schemaLocation="Services/OCISchemaServiceInstantGroupCall.xsd"/>\r
  94   <xs:include schemaLocation="Services/OCISchemaServiceIntegratedIMP.xsd"/>\r
  95   <xs:include schemaLocation="Services/OCISchemaServiceIntelligentNetworkServiceControl.xsd"/>\r
  96   <xs:include schemaLocation="Services/OCISchemaServiceInternalCallingLineIDDelivery.xsd"/>\r
  97   <xs:include schemaLocation="Services/OCISchemaServiceInventoryReport.xsd"/>\r
  98   <xs:include schemaLocation="Services/OCISchemaServiceIntercept.xsd"/>\r
  99   <xs:include schemaLocation="Services/OCISchemaServiceLegacyAutomaticCallback.xsd"/>\r
 100   <xs:include schemaLocation="Services/OCISchemaServiceLDAPIntegration.xsd"/>\r
 101   <xs:include schemaLocation="Services/OCISchemaServiceLocationBasedCallingRestrictions.xsd"/>\r
 102   <xs:include schemaLocation="Services/OCISchemaServiceMaliciousCallTrace.xsd"/>\r
 103   <xs:include schemaLocation="Services/OCISchemaServiceMeetMeConferencing.xsd"/>\r
 104   <xs:include schemaLocation="Services/OCISchemaServiceMusicOnHold.xsd"/>\r
 105   <xs:include schemaLocation="Services/OCISchemaServiceMWIDeliveryToMobileEndpoint.xsd"/>\r
 106   <xs:include schemaLocation="Services/OCISchemaServiceNumberPortabilityAnnouncement.xsd"/>\r
 107   <xs:include schemaLocation="Services/OCISchemaServiceOMAPresence.xsd"/>\r
 108   <xs:include schemaLocation="Services/OCISchemaServiceOutlookIntegration.xsd"/>\r
 109   <xs:include schemaLocation="Services/OCISchemaServiceOutgoingCallingPlan.xsd"/>\r
 110   <xs:include schemaLocation="Services/OCISchemaServiceOutlookIntegration.xsd"/>\r
 111   <xs:include schemaLocation="Services/OCISchemaServicePersonalAssistant.xsd"/>\r
 112   <xs:include schemaLocation="Services/OCISchemaServicePhysicalLocation.xsd"/>\r
 113   <xs:include schemaLocation="Services/OCISchemaServicePreAlertingAnnouncement.xsd"/>\r
 114   <xs:include schemaLocation="Services/OCISchemaServicePreferredCarrier.xsd"/>\r
 115   <xs:include schemaLocation="Services/OCISchemaServicePolycomPhoneServices.xsd"/>\r
 116   <xs:include schemaLocation="Services/OCISchemaServicePriorityAlert.xsd"/>\r
 117   <xs:include schemaLocation="Services/OCISchemaServicePrepaid.xsd"/>\r
 118   <xs:include schemaLocation="Services/OCISchemaServicePrivacy.xsd"/>\r
 119   <xs:include schemaLocation="Services/OCISchemaServicePushToTalk.xsd"/>\r
 120   <xs:include schemaLocation="Services/OCISchemaServiceReceptionistEnterprise.xsd"/>\r
 121   <xs:include schemaLocation="Services/OCISchemaServiceReceptionistOffice.xsd"/>\r
 122   <xs:include schemaLocation="Services/OCISchemaServiceReceptionistSmallBusiness.xsd"/>\r
 123   <xs:include schemaLocation="Services/OCISchemaServiceRemoteOffice.xsd"/>\r
 124   <xs:include schemaLocation="Services/OCISchemaServiceRouteList.xsd"/>\r
 125   <xs:include schemaLocation="Services/OCISchemaServiceRoutePoint.xsd"/>\r
 126   <xs:include schemaLocation="Services/OCISchemaServiceSecurityClassification.xsd"/>\r
 127   <xs:include schemaLocation="Services/OCISchemaServiceSelectiveCallAcceptance.xsd"/>\r
 128   <xs:include schemaLocation="Services/OCISchemaServiceSelectiveCallRejection.xsd"/>\r
 129   <xs:include schemaLocation="Services/OCISchemaServiceSequentialRing.xsd"/>\r
 130   <xs:include schemaLocation="Services/OCISchemaServiceSeriesCompletion.xsd"/>\r
 131   <xs:include schemaLocation="Services/OCISchemaServiceServiceScripts.xsd"/>\r
 132   <xs:include schemaLocation="Services/OCISchemaServiceSharedCallAppearance.xsd"/>\r
 133   <xs:include schemaLocation="Services/OCISchemaServiceSimultaneousRingFamily.xsd"/>\r
 134   <xs:include schemaLocation="Services/OCISchemaServiceSimultaneousRingPersonal.xsd"/>\r
 135   <xs:include schemaLocation="Services/OCISchemaServiceSMDIMessageDesk.xsd"/>\r
 136   <xs:include schemaLocation="Services/OCISchemaServiceSpeedDial8.xsd"/>\r
 137   <xs:include schemaLocation="Services/OCISchemaServiceSpeedDial100.xsd"/>\r
 138   <xs:include schemaLocation="Services/OCISchemaServiceThirdPartyIMP.xsd"/>\r
 139   <xs:include schemaLocation="Services/OCISchemaServiceThirdPartyVoiceMailSupport.xsd"/>\r
 140   <xs:include schemaLocation="Services/OCISchemaServiceTrunkGroup.xsd"/>\r
 141   <xs:include schemaLocation="Services/OCISchemaServiceTwoStageDialing.xsd"/>\r
 142   <xs:include schemaLocation="Services/OCISchemaServiceVideoAddOn.xsd"/>\r
 143   <xs:include schemaLocation="Services/OCISchemaServiceVirtualOnNetEnterpriseExtensions.xsd"/>\r
 144   <xs:include schemaLocation="Services/OCISchemaServiceVoiceMessaging.xsd"/>\r
 145   <xs:include schemaLocation="Services/OCISchemaServiceVoicePortalCalling.xsd"/>\r
 146   <xs:include schemaLocation="Services/OCISchemaServiceVoiceXml.xsd"/>\r
 147   <xs:include schemaLocation="Services/OCISchemaServiceZoneCallingRestrictions.xsd"/>\r
 148   <xs:include schemaLocation="Services/OCISchemaServiceCustomerOriginatedTrace.xsd"/>\r
 149   <xs:include schemaLocation="OCISchemaDeprecated14.xsd"/>\r
 150   <xs:include schemaLocation="OCISchemaDeprecated15.xsd"/>\r
 151   <xs:include schemaLocation="OCISchemaDeprecated16.xsd"/>\r
 152   <xs:include schemaLocation="OCISchemaDeprecated17.xsd"/>\r
 153   <xs:include schemaLocation="OCISchemaDeprecated18.xsd"/>\r
 154   <xs:include schemaLocation="OCISchemaDeprecated19.xsd"/>\r
 155   <xs:include schemaLocation="OCISchemaDeprecated20.xsd"/>\r
 156   <!-- *********************************************************************** -->\r
 157   <!-- N A M I N G   C O N V E N T I O N S                                     -->\r
 158   <!-- *********************************************************************** -->\r
 159   <!--
 160   Transactions:
 161     Object[Aspect-or-Feature]Verb[Aspect2](Request | Response)
 162     Possible verbs are Add, Assign, Delete, Get, Modify, Unassign, etc.
 163
 164   Transactions involving an array:
 165     Object[Aspect-or-Feature]Verb[Aspect2]List(Request | Response)
 166
 167   Transaction involving a table:
 168     Object[Aspect-or-Feature]Get[Aspect2]ListResponse
 169     Note: tables are only sent in responses, not requests.
 170
 171   Array element name:
 172     The element name is not plural.
 173     For example: tagName
 174
 175   Table element name:
 176     The element name is suffixed with "Table".
 177     For example: tagNameTable
 178
 179   Table column headings:
 180     "Capitalized Multiple Words"
 181     "Id", not "ID"
 182
 183   Table boolean column values:
 184     "true" or "false"
 185
 186   -->\r
 187   <!-- *********************************************************************** -->\r
 188   <!-- C O N T E N T   R U L E S                                               -->\r
 189   <!-- *********************************************************************** -->\r
 190   <!--
 191   Minimal GET Responses:
 192     The elements in a GET request are not sent back in a GET response because the client
 193     already knows the values.
 194
 195   Keys and Display Values:
 196     Both keys and display values are returned in a GET command. Display values are
 197     ignored in an ADD or MODIFY command.
 198
 199   Eraseable Elements, Empty Tags, and Missing Tags:
 200     Every data element of a MODIFY command is optional, even if there is only one element.
 201
 202     A MODIFY command with a missing optional element implies the value of the element
 203     should not be changed.
 204
 205     Arrays of replacement objects in a MODIFY command are wrapped in an optional list element
 206     so the entire array can be ommitted when no change is required.
 207
 208     Eraseable elements are indicated by the nillable="true" attribute in a MODIFY command.
 209
 210     The nillable attribute never appears in any command except MODIFY commands.
 211
 212     Elements that are optional in an ADD command are both optional and nillable in
 213     a MODIFY command and optional in a GET command.
 214
 215     Booleans cannot be erased
 216
 217     Ints are erased by setting the element xsi:nill attribute.
 218
 219     Strings can be erased either with the xsi:nill attribute or by sending a zero-length string.
 220
 221     Arrays of replacement objects in a MODIFY command can be erased by setting the xsi:nill attribute
 222     on the wrapping list element. The embedded array has minOccurs=1.
 223
 224   Services:
 225     Services are referred to as "Service", not "Feature". This is consistent with the
 226     web and CLI interfaces and other parts of the schema.
 227
 228     Each service has its own schema file, for example, OCISchemaServiceAutoAttendant.xsd.
 229
 230     Services with both a group component and a user component have a single schema file.
 231     For example: OCISchemaServiceVoiceMessaging.xsd.
 232
 233     All the commands for a service are in the same schema file. The commands can be at
 234     all levels: system, service provider, group, or user.
 235
 236     The list of services we expose to clients is enumerated in the schema itself. These
 237     are the services that can be authorized. It does not include the default features.
 238     When deciding whether or not a command is a service command, we will use the rule that
 239     the service must be exposed in the list of services in the schema.
 240     For example, Feature Access Codes is not exposed as a service and the commands related
 241     to Feature Access Codes will not be placed in a separate schema file.
 242
 243   -->\r
 244 </xs:schema>\r