share/OCISchemaAS/Services/OCISchemaServiceCallCapacityManagement.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 \r
   3 <!-- ********************************************************************** -->\r
   4 <!-- Copyright (c) 2000-2012 BroadSoft, Inc.  All rights reserved.          -->\r
   5 <!-- ********************************************************************** -->\r
   6 <!-- O C I   X M L   S C H E M A  :  S E R V I C E  P A R T                 -->\r
   7 <!--                                                                        -->\r
   8 <!-- C A L L   C A P A C I T Y   M A N A G E M E N T  S E R V I C E         -->\r
   9 <!--                                                                        -->\r
  10 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
  11 <!-- Open Client Interface (OCI).                                           -->\r
  12 <!-- ********************************************************************** -->\r
  13 \r
  14 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
  15            xmlns:core           = "C"\r
  16            xmlns                = ""\r
  17            attributeFormDefault = "qualified"\r
  18            elementFormDefault   = "qualified">\r
  19   \r
  20   <xs:import namespace      = "C"\r
  21              schemaLocation = "../OCISchemaBASE.xsd"/>\r
  22   \r
  23   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  24   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- C A L L   C A P A C I T Y   M A N A G E M E N T                                    -->\r
  28   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  29   <!-- ********************************************************************************** -->\r
  30   <!--\r
  31   Requests and responses are listed here in alphabetical order.\r
  32   The non-primitive attributes inside the commands are defined in another\r
  33   section of the schema.\r
  34 \r
  35   Requests in this schema file:\r
  36     GroupCallCapacityManagementAddInstanceRequest    \r
  37     GroupCallCapacityManagementDeleteInstanceListRequest    \r
  38     GroupCallCapacityManagementGetAvailableUserListRequest    \r
  39     GroupCallCapacityManagementGetInstanceListRequest    \r
  40     GroupCallCapacityManagementGetInstanceRequest    \r
  41     GroupCallCapacityManagementModifyInstanceRequest    \r
  42     GroupCallCapacityManagementAddUserListRequest    \r
  43     GroupCallCapacityManagementDeleteUserListRequest    \r
  44     \r
  45   --> \r
  46   \r
  47   <xs:complexType name="GroupCallCapacityManagementAddInstanceRequest">\r
  48     <xs:annotation>\r
  49       <xs:documentation>\r
  50         Adds a Call Capacity Management group.\r
  51         The response is either SuccessResponse or ErrorResponse.\r
  52       </xs:documentation>\r
  53     </xs:annotation>\r
  54     <xs:complexContent>\r
  55       <xs:extension base="core:OCIRequest">\r
  56         <xs:sequence>\r
  57           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  58           <xs:element name="groupId" type="GroupId"/>\r
  59           <xs:element name="name" type="ServiceInstanceName"/>\r
  60           <xs:element name="maxActiveCallsAllowed" type="CallCapacityCallLimit"/>\r
  61           <xs:element name="maxIncomingActiveCallsAllowed" type="CallCapacityCallLimit" minOccurs="0"/>\r
  62           <xs:element name="maxOutgoingActiveCallsAllowed" type="CallCapacityCallLimit" minOccurs="0"/>\r
  63           <xs:element name="becomeDefaultGroupForNewUsers" type="xs:boolean"/>\r
  64           <xs:element name="userId" type="UserId" minOccurs="0" maxOccurs="unbounded"/>\r
  65         </xs:sequence>\r
  66       </xs:extension>\r
  67     </xs:complexContent>\r
  68   </xs:complexType>    \r
  69     \r
  70   <xs:complexType name="GroupCallCapacityManagementDeleteInstanceListRequest">\r
  71     <xs:annotation>\r
  72       <xs:documentation>\r
  73         Deletes one or more Call Capacity Management groups.\r
  74         The response is either SuccessResponse or ErrorResponse.\r
  75       </xs:documentation>\r
  76     </xs:annotation>\r
  77     <xs:complexContent>\r
  78       <xs:extension base="core:OCIRequest">\r
  79         <xs:sequence>\r
  80           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  81           <xs:element name="groupId" type="GroupId"/>\r
  82           <xs:element name="name" type="ServiceInstanceName" minOccurs="1" maxOccurs="unbounded"/>\r
  83         </xs:sequence>\r
  84       </xs:extension>\r
  85     </xs:complexContent>\r
  86   </xs:complexType>    \r
  87     \r
  88   <xs:complexType name="GroupCallCapacityManagementGetAvailableUserListRequest">\r
  89     <xs:annotation>\r
  90       <xs:documentation>\r
  91         Get a list of users that can be assigned to a Call Capacity Management group.\r
  92         The available user list for a new Call Capacity Management group can be obtained\r
  93         by not setting the name.\r
  94         The response is either GroupCallCapacityManagementGetAvailableUserListResponse or ErrorResponse.\r
  95       </xs:documentation>\r
  96     </xs:annotation>\r
  97     <xs:complexContent>\r
  98       <xs:extension base="core:OCIRequest">\r
  99         <xs:sequence>\r
 100           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 101           <xs:element name="groupId" type="GroupId"/>\r
 102           <xs:element name="name" type="ServiceInstanceName" minOccurs="0"/>\r
 103           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 104           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 105           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 106           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
 107           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 108           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 109           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 110         </xs:sequence>\r
 111       </xs:extension>\r
 112     </xs:complexContent>\r
 113   </xs:complexType>    \r
 114     \r
 115   <xs:complexType name="GroupCallCapacityManagementGetAvailableUserListResponse">\r
 116     <xs:annotation>\r
 117       <xs:documentation>\r
 118         Response to the GroupCallCapacityManagementGetAvailableUserListRequest.\r
 119         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 120         "Phone Number", "Extension", "Department", "Email Address".\r
 121       </xs:documentation>\r
 122     </xs:annotation>\r
 123     <xs:complexContent>\r
 124       <xs:extension base="core:OCIDataResponse">\r
 125         <xs:sequence>\r
 126           <xs:element name="userTable" type="core:OCITable"/>\r
 127         </xs:sequence>\r
 128       </xs:extension>\r
 129     </xs:complexContent>\r
 130   </xs:complexType>    \r
 131     \r
 132   <xs:complexType name="GroupCallCapacityManagementGetInstanceListRequest">\r
 133     <xs:annotation>\r
 134       <xs:documentation>\r
 135         Request to get a list of Call Capacity Management instances within a group.\r
 136         The response is either GroupCallCapacityManagementGetInstanceListResponse or ErrorResponse.\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:complexContent>\r
 140       <xs:extension base="core:OCIRequest">\r
 141         <xs:sequence>\r
 142           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 143           <xs:element name="groupId" type="GroupId"/>\r
 144         </xs:sequence>\r
 145       </xs:extension>\r
 146     </xs:complexContent>\r
 147   </xs:complexType>    \r
 148     \r
 149   <xs:complexType name="GroupCallCapacityManagementGetInstanceListResponse">\r
 150     <xs:annotation>\r
 151       <xs:documentation>\r
 152         Response to the GroupCallCapacityManagementGetInstanceListRequest.\r
 153         Contains a table with column headings: "Name", "Is Default", "Maximum Calls", "Maximum Incoming Calls", "Maximum Outgoing Calls".\r
 154       </xs:documentation>\r
 155     </xs:annotation>\r
 156     <xs:complexContent>\r
 157       <xs:extension base="core:OCIDataResponse">\r
 158         <xs:sequence>\r
 159           <xs:element name="callCapacityGroupTable" type="core:OCITable"/>\r
 160         </xs:sequence>\r
 161       </xs:extension>\r
 162     </xs:complexContent>\r
 163   </xs:complexType>    \r
 164     \r
 165   <xs:complexType name="GroupCallCapacityManagementGetInstanceRequest">\r
 166     <xs:annotation>\r
 167       <xs:documentation>\r
 168         Gets a Call Capacity Management group.\r
 169         The response is either GroupCallCapacityManagementGetInstanceResponse or ErrorResponse.\r
 170       </xs:documentation>\r
 171     </xs:annotation>\r
 172     <xs:complexContent>\r
 173       <xs:extension base="core:OCIRequest">\r
 174         <xs:sequence>\r
 175           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 176           <xs:element name="groupId" type="GroupId"/>\r
 177           <xs:element name="name" type="ServiceInstanceName"/>\r
 178         </xs:sequence>\r
 179       </xs:extension>\r
 180     </xs:complexContent>\r
 181   </xs:complexType>    \r
 182     \r
 183   <xs:complexType name="GroupCallCapacityManagementGetInstanceResponse">\r
 184     <xs:annotation>\r
 185       <xs:documentation>\r
 186         Response to the GroupCallCapacityManagementGetInstanceRequest.\r
 187         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 188         "Phone Number", "Extension", "Department", "Email Address".\r
 189       </xs:documentation>\r
 190     </xs:annotation>\r
 191     <xs:complexContent>\r
 192       <xs:extension base="core:OCIDataResponse">\r
 193         <xs:sequence>\r
 194           <xs:element name="name" type="ServiceInstanceName"/>\r
 195           <xs:element name="maxActiveCallsAllowed" type="CallCapacityCallLimit"/>\r
 196           <xs:element name="maxIncomingActiveCallsAllowed" type="CallCapacityCallLimit" minOccurs="0"/>\r
 197           <xs:element name="maxOutgoingActiveCallsAllowed" type="CallCapacityCallLimit" minOccurs="0"/>\r
 198           <xs:element name="defaultGroupForNewUsers" type="xs:boolean"/>\r
 199           <xs:element name="userTable" type="core:OCITable"/>\r
 200         </xs:sequence>\r
 201       </xs:extension>\r
 202     </xs:complexContent>\r
 203   </xs:complexType>    \r
 204     \r
 205   <xs:complexType name="GroupCallCapacityManagementModifyInstanceRequest">\r
 206     <xs:annotation>\r
 207       <xs:documentation>\r
 208         Modifies a Call Capacity Management group. Replaces the entire list of users in the group.\r
 209         The response is either SuccessResponse or ErrorResponse.\r
 210       </xs:documentation>\r
 211     </xs:annotation>\r
 212     <xs:complexContent>\r
 213       <xs:extension base="core:OCIRequest">\r
 214         <xs:sequence>\r
 215           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 216           <xs:element name="groupId" type="GroupId"/>\r
 217           <xs:element name="name" type="ServiceInstanceName"/>\r
 218           <xs:element name="newName" type="ServiceInstanceName" minOccurs="0"/>\r
 219           <xs:element name="maxActiveCallsAllowed" type="CallCapacityCallLimit" minOccurs="0"/>\r
 220           <xs:element name="maxIncomingActiveCallsAllowed" type="CallCapacityCallLimit" nillable="true" minOccurs="0"/>\r
 221           <xs:element name="maxOutgoingActiveCallsAllowed" type="CallCapacityCallLimit" nillable="true" minOccurs="0"/>\r
 222           <xs:element name="becomeDefaultGroupForNewUsers" type="xs:boolean" minOccurs="0"/>\r
 223           <xs:element name="userIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 224         </xs:sequence>\r
 225       </xs:extension>\r
 226     </xs:complexContent>\r
 227   </xs:complexType>    \r
 228     \r
 229   <xs:complexType name="GroupCallCapacityManagementAddUserListRequest">\r
 230     <xs:annotation>\r
 231       <xs:documentation>\r
 232         Adds one or more users to a Call Capacity Management group.\r
 233         The response is either SuccessResponse or ErrorResponse.\r
 234       </xs:documentation>\r
 235     </xs:annotation>\r
 236     <xs:complexContent>\r
 237       <xs:extension base="core:OCIRequest">\r
 238         <xs:sequence>\r
 239           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 240           <xs:element name="groupId" type="GroupId"/>\r
 241           <xs:element name="name" type="ServiceInstanceName"/>\r
 242           <xs:element name="userId" type="UserId" minOccurs="1" maxOccurs="unbounded"/>\r
 243         </xs:sequence>\r
 244       </xs:extension>\r
 245     </xs:complexContent>\r
 246   </xs:complexType>    \r
 247     \r
 248   <xs:complexType name="GroupCallCapacityManagementDeleteUserListRequest">\r
 249     <xs:annotation>\r
 250       <xs:documentation>\r
 251         Deletes one or more users from a Call Capacity Management group.\r
 252         The response is either SuccessResponse or ErrorResponse.\r
 253       </xs:documentation>\r
 254     </xs:annotation>\r
 255     <xs:complexContent>\r
 256       <xs:extension base="core:OCIRequest">\r
 257         <xs:sequence>\r
 258           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 259           <xs:element name="groupId" type="GroupId"/>\r
 260           <xs:element name="name" type="ServiceInstanceName"/>\r
 261           <xs:element name="userId" type="UserId" minOccurs="1" maxOccurs="unbounded"/>\r
 262         </xs:sequence>\r
 263       </xs:extension>\r
 264     </xs:complexContent>\r
 265   </xs:complexType>    \r
 266     \r
 267   <xs:simpleType name="CallCapacityCallLimit">\r
 268     <xs:annotation>\r
 269       <xs:documentation>\r
 270           Range of values for the call capacity of a capacity group.\r
 271         </xs:documentation>\r
 272     </xs:annotation>\r
 273     <xs:restriction base="xs:int">\r
 274       <xs:minInclusive value="0"/>\r
 275       <xs:maxInclusive value="99999"/>\r
 276     </xs:restriction>\r
 277   </xs:simpleType>    \r
 278     \r
 279 </xs:schema>\r