share/OCISchemaAS/Services/OCISchemaServiceSequentialRing.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 <!-- S E Q U E N T I A L   R I N G  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   \r
  25   <!-- ********************************************************************************** -->\r
  26   <!-- S E Q U E N T I A L   R I N G    R E Q U E S T S  A N D  R E S P O N S E S         -->\r
  27   <!-- ********************************************************************************** -->\r
  28   <!--\r
  29   Requests and responses are listed here in alphabetical order.\r
  30   The non-primitive attributes inside the commands are defined in another\r
  31   section of the schema.\r
  32 \r
  33   Requests in this schema file:\r
  34     UserSequentialRingAddCriteriaRequest16    \r
  35     UserSequentialRingDeleteCriteriaRequest    \r
  36     UserSequentialRingGetCriteriaRequest16    \r
  37     UserSequentialRingGetRequest14sp4    \r
  38     UserSequentialRingModifyCriteriaRequest    \r
  39     UserSequentialRingModifyRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="UserSequentialRingAddCriteriaRequest16">\r
  44     <xs:annotation>\r
  45       <xs:documentation>\r
  46         Add a criteria to the user's sequential ring service.\r
  47         The response is either a SuccessResponse or an ErrorResponse.\r
  48       </xs:documentation>\r
  49     </xs:annotation>\r
  50     <xs:complexContent>\r
  51       <xs:extension base="core:OCIRequest">\r
  52         <xs:sequence>\r
  53           <xs:element name="userId" type="UserId"/>\r
  54           <xs:element name="criteriaName" type="CriteriaName"/>\r
  55           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
  56           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
  57           <xs:element name="blacklisted" type="xs:boolean"/>\r
  58           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="UserSequentialRingDeleteCriteriaRequest">\r
  65     <xs:annotation>\r
  66       <xs:documentation>\r
  67         Delete a criteria from the user's sequential ring service.\r
  68         The response is either a SuccessResponse or an ErrorResponse.\r
  69       </xs:documentation>\r
  70     </xs:annotation>\r
  71     <xs:complexContent>\r
  72       <xs:extension base="core:OCIRequest">\r
  73         <xs:sequence>\r
  74           <xs:element name="userId" type="UserId"/>\r
  75           <xs:element name="criteriaName" type="CriteriaName"/>\r
  76         </xs:sequence>\r
  77       </xs:extension>\r
  78     </xs:complexContent>\r
  79   </xs:complexType>    \r
  80     \r
  81   <xs:complexType name="UserSequentialRingGetCriteriaRequest16">\r
  82     <xs:annotation>\r
  83       <xs:documentation>\r
  84         Get a criteria for the user's sequential ring service.\r
  85         The response is either a UserSequentialRingGetCriteriaResponse16 or an ErrorResponse.\r
  86       </xs:documentation>\r
  87     </xs:annotation>\r
  88     <xs:complexContent>\r
  89       <xs:extension base="core:OCIRequest">\r
  90         <xs:sequence>\r
  91           <xs:element name="userId" type="UserId"/>\r
  92           <xs:element name="criteriaName" type="CriteriaName"/>\r
  93         </xs:sequence>\r
  94       </xs:extension>\r
  95     </xs:complexContent>\r
  96   </xs:complexType>    \r
  97     \r
  98   <xs:complexType name="UserSequentialRingGetCriteriaResponse16">\r
  99     <xs:annotation>\r
 100       <xs:documentation>\r
 101         Response to the UserSequentialRingGetCriteriaRequest16.\r
 102       </xs:documentation>\r
 103     </xs:annotation>\r
 104     <xs:complexContent>\r
 105       <xs:extension base="core:OCIDataResponse">\r
 106         <xs:sequence>\r
 107           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 108           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 109           <xs:element name="blacklisted" type="xs:boolean"/>\r
 110           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 111         </xs:sequence>\r
 112       </xs:extension>\r
 113     </xs:complexContent>\r
 114   </xs:complexType>    \r
 115     \r
 116   <xs:complexType name="UserSequentialRingGetRequest14sp4">\r
 117     <xs:annotation>\r
 118       <xs:documentation>\r
 119         Get the user's sequential ring service setting.\r
 120         The response is either a UserSequentialRingGetResponse14sp4 or an ErrorResponse.\r
 121       </xs:documentation>\r
 122     </xs:annotation>\r
 123     <xs:complexContent>\r
 124       <xs:extension base="core:OCIRequest">\r
 125         <xs:sequence>\r
 126           <xs:element name="userId" type="UserId"/>\r
 127         </xs:sequence>\r
 128       </xs:extension>\r
 129     </xs:complexContent>\r
 130   </xs:complexType>    \r
 131     \r
 132   <xs:complexType name="UserSequentialRingGetResponse14sp4">\r
 133     <xs:annotation>\r
 134       <xs:documentation>\r
 135         Response to the UserSequentialRingGetRequest14sp4. The criteria table's column headings are:\r
 136         "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted" and "Holiday Schedule".\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:complexContent>\r
 140       <xs:extension base="core:OCIDataResponse">\r
 141         <xs:sequence>\r
 142           <xs:element name="ringBaseLocationFirst" type="xs:boolean"/>\r
 143           <xs:element name="baseLocationNumberOfRings" type="SequentialRingNumberOfRings"/>\r
 144           <xs:element name="continueIfBaseLocationIsBusy" type="xs:boolean"/>\r
 145           <xs:element name="callerMayStopSearch" type="xs:boolean"/>\r
 146           <xs:element name="Location01" type="SequentialRingLocation14sp4"/>\r
 147           <xs:element name="Location02" type="SequentialRingLocation14sp4"/>\r
 148           <xs:element name="Location03" type="SequentialRingLocation14sp4"/>\r
 149           <xs:element name="Location04" type="SequentialRingLocation14sp4"/>\r
 150           <xs:element name="Location05" type="SequentialRingLocation14sp4"/>\r
 151           <xs:element name="criteriaTable" type="core:OCITable"/>\r
 152         </xs:sequence>\r
 153       </xs:extension>\r
 154     </xs:complexContent>\r
 155   </xs:complexType>    \r
 156     \r
 157   <xs:complexType name="UserSequentialRingModifyCriteriaRequest">\r
 158     <xs:annotation>\r
 159       <xs:documentation>\r
 160         Modify a criteria for the user's sequential ring service.\r
 161         The response is either a SuccessResponse or an ErrorResponse.\r
 162       </xs:documentation>\r
 163     </xs:annotation>\r
 164     <xs:complexContent>\r
 165       <xs:extension base="core:OCIRequest">\r
 166         <xs:sequence>\r
 167           <xs:element name="userId" type="UserId"/>\r
 168           <xs:element name="criteriaName" type="CriteriaName"/>\r
 169           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
 170           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
 171           <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>\r
 172           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
 173           <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>\r
 174         </xs:sequence>\r
 175       </xs:extension>\r
 176     </xs:complexContent>\r
 177   </xs:complexType>    \r
 178     \r
 179   <xs:complexType name="UserSequentialRingModifyRequest">\r
 180     <xs:annotation>\r
 181       <xs:documentation>\r
 182         Modify the user's sequential ring service setting.\r
 183         The response is either a SuccessResponse or an ErrorResponse.\r
 184       </xs:documentation>\r
 185     </xs:annotation>\r
 186     <xs:complexContent>\r
 187       <xs:extension base="core:OCIRequest">\r
 188         <xs:sequence>\r
 189           <xs:element name="userId" type="UserId"/>\r
 190           <xs:element name="ringBaseLocationFirst" type="xs:boolean" minOccurs="0"/>\r
 191           <xs:element name="baseLocationNumberOfRings" type="SequentialRingNumberOfRings" minOccurs="0"/>\r
 192           <xs:element name="continueIfBaseLocationIsBusy" type="xs:boolean" minOccurs="0"/>\r
 193           <xs:element name="callerMayStopSearch" type="xs:boolean" minOccurs="0"/>\r
 194           <xs:element name="Location01" type="SequentialRingLocationModify" minOccurs="0"/>\r
 195           <xs:element name="Location02" type="SequentialRingLocationModify" minOccurs="0"/>\r
 196           <xs:element name="Location03" type="SequentialRingLocationModify" minOccurs="0"/>\r
 197           <xs:element name="Location04" type="SequentialRingLocationModify" minOccurs="0"/>\r
 198           <xs:element name="Location05" type="SequentialRingLocationModify" minOccurs="0"/>\r
 199           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 200         </xs:sequence>\r
 201       </xs:extension>\r
 202     </xs:complexContent>\r
 203   </xs:complexType>    \r
 204     \r
 205   <xs:complexType name="SequentialRingLocation14sp4">\r
 206     <xs:annotation>\r
 207       <xs:documentation>\r
 208         Sequential Ring Location.\r
 209       </xs:documentation>\r
 210     </xs:annotation>\r
 211     <xs:sequence>\r
 212       <xs:element name="phoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 213       <xs:element name="numberOfRings" type="SequentialRingNumberOfRings"/>\r
 214       <xs:element name="answerConfirmationRequired" type="xs:boolean"/>\r
 215     </xs:sequence>\r
 216   </xs:complexType>    \r
 217     \r
 218   <xs:complexType name="SequentialRingLocationModify">\r
 219     <xs:annotation>\r
 220       <xs:documentation>\r
 221         Sequential Ring Location.\r
 222       </xs:documentation>\r
 223     </xs:annotation>\r
 224     <xs:sequence>\r
 225       <xs:element name="phoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 226       <xs:element name="numberOfRings" type="SequentialRingNumberOfRings" minOccurs="0"/>\r
 227       <xs:element name="answerConfirmationRequired" type="xs:boolean" minOccurs="0"/>\r
 228     </xs:sequence>\r
 229   </xs:complexType>    \r
 230     \r
 231   <xs:simpleType name="SequentialRingNumberOfRings">\r
 232     <xs:annotation>\r
 233       <xs:documentation>\r
 234         Number of Rings until call is redirected to next location in sequence.\r
 235       </xs:documentation>\r
 236     </xs:annotation>\r
 237     <xs:restriction base="xs:int">\r
 238       <xs:enumeration value="0"/>\r
 239       <xs:enumeration value="2"/>\r
 240       <xs:enumeration value="3"/>\r
 241       <xs:enumeration value="4"/>\r
 242       <xs:enumeration value="5"/>\r
 243       <xs:enumeration value="6"/>\r
 244       <xs:enumeration value="7"/>\r
 245       <xs:enumeration value="8"/>\r
 246       <xs:enumeration value="9"/>\r
 247       <xs:enumeration value="10"/>\r
 248       <xs:enumeration value="11"/>\r
 249       <xs:enumeration value="12"/>\r
 250       <xs:enumeration value="13"/>\r
 251       <xs:enumeration value="14"/>\r
 252       <xs:enumeration value="15"/>\r
 253       <xs:enumeration value="16"/>\r
 254       <xs:enumeration value="17"/>\r
 255       <xs:enumeration value="18"/>\r
 256       <xs:enumeration value="19"/>\r
 257       <xs:enumeration value="20"/>\r
 258     </xs:restriction>\r
 259   </xs:simpleType>    \r
 260     \r
 261 </xs:schema>\r