share/OCISchemaAS/Services/OCISchemaServiceCallNotify.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   N O T I F Y  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   <!-- C A L L   N O T I F Y    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     SystemCallNotifyGetRequest    \r
  35     SystemCallNotifyModifyRequest    \r
  36     UserCallNotifyAddCriteriaRequest16    \r
  37     UserCallNotifyGetCriteriaRequest21    \r
  38     UserCallNotifyDeleteCriteriaRequest    \r
  39     UserCallNotifyModifyCriteriaRequest    \r
  40     UserCallNotifyGetRequest    \r
  41     UserCallNotifyModifyRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="SystemCallNotifyGetRequest">\r
  46     <xs:annotation>\r
  47       <xs:appinfo>\r
  48         <asDataModeSupported>true</asDataModeSupported>\r
  49         <hssDataModeSupported>false</hssDataModeSupported>\r
  50       </xs:appinfo>\r
  51       <xs:documentation>\r
  52         Request the system level data associated with Call Notify.\r
  53         The response is either a SystemCallNotifyGetResponse or an\r
  54         ErrorResponse.\r
  55       </xs:documentation>\r
  56     </xs:annotation>\r
  57     <xs:complexContent>\r
  58       <xs:extension base="core:OCIRequest">\r
  59         <xs:sequence/>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="SystemCallNotifyGetResponse">\r
  65     <xs:annotation>\r
  66       <xs:appinfo>\r
  67         <asDataModeSupported>true</asDataModeSupported>\r
  68         <hssDataModeSupported>false</hssDataModeSupported>\r
  69       </xs:appinfo>\r
  70       <xs:documentation>\r
  71         Response to SystemCallNotifyGetRequest.\r
  72       </xs:documentation>\r
  73     </xs:annotation>\r
  74     <xs:complexContent>\r
  75       <xs:extension base="core:OCIDataResponse">\r
  76         <xs:sequence>\r
  77           <xs:element name="defaultFromAddress" type="EmailAddress"/>\r
  78           <xs:element name="useShortSubjectLine" type="xs:boolean"/>\r
  79           <xs:element name="useDnInMailBody" type="xs:boolean"/>\r
  80         </xs:sequence>\r
  81       </xs:extension>\r
  82     </xs:complexContent>\r
  83   </xs:complexType>    \r
  84     \r
  85   <xs:complexType name="SystemCallNotifyModifyRequest">\r
  86     <xs:annotation>\r
  87       <xs:appinfo>\r
  88         <asDataModeSupported>true</asDataModeSupported>\r
  89         <hssDataModeSupported>false</hssDataModeSupported>\r
  90       </xs:appinfo>\r
  91       <xs:documentation>\r
  92         Modify the system level data associated with Call Notify.\r
  93         The response is either a SuccessResponse or an ErrorResponse.\r
  94       </xs:documentation>\r
  95     </xs:annotation>\r
  96     <xs:complexContent>\r
  97       <xs:extension base="core:OCIRequest">\r
  98         <xs:sequence>\r
  99           <xs:element name="defaultFromAddress" type="EmailAddress" minOccurs="0"/>\r
 100           <xs:element name="useShortSubjectLine" type="xs:boolean" minOccurs="0"/>\r
 101           <xs:element name="useDnInMailBody" type="xs:boolean" minOccurs="0"/>\r
 102         </xs:sequence>\r
 103       </xs:extension>\r
 104     </xs:complexContent>\r
 105   </xs:complexType>    \r
 106     \r
 107   <xs:complexType name="UserCallNotifyAddCriteriaRequest16">\r
 108     <xs:annotation>\r
 109       <xs:documentation>\r
 110         Add a criteria to the user's call notify service.\r
 111         For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
 112         The response is either a SuccessResponse or an ErrorResponse.\r
 113       </xs:documentation>\r
 114     </xs:annotation>\r
 115     <xs:complexContent>\r
 116       <xs:extension base="core:OCIRequest">\r
 117         <xs:sequence>\r
 118           <xs:element name="userId" type="UserId"/>\r
 119           <xs:element name="criteriaName" type="CriteriaName"/>\r
 120           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 121           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 122           <xs:element name="blacklisted" type="xs:boolean"/>\r
 123           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 124           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 125         </xs:sequence>\r
 126       </xs:extension>\r
 127     </xs:complexContent>\r
 128   </xs:complexType>    \r
 129     \r
 130   <xs:complexType name="UserCallNotifyGetCriteriaRequest21">\r
 131     <xs:annotation>\r
 132       <xs:documentation>\r
 133         Get a criteria for the user's call notify service.\r
 134         The response is either a UserCallNotifyGetCriteriaResponse21 or an ErrorResponse.\r
 135       </xs:documentation>\r
 136     </xs:annotation>\r
 137     <xs:complexContent>\r
 138       <xs:extension base="core:OCIRequest">\r
 139         <xs:sequence>\r
 140           <xs:element name="userId" type="UserId"/>\r
 141           <xs:element name="criteriaName" type="CriteriaName"/>\r
 142         </xs:sequence>\r
 143       </xs:extension>\r
 144     </xs:complexContent>\r
 145   </xs:complexType>    \r
 146     \r
 147   <xs:complexType name="UserCallNotifyGetCriteriaResponse21">\r
 148     <xs:annotation>\r
 149       <xs:documentation>\r
 150         Response to the UserCallNotifyGetCriteriaRequest21.\r
 151       </xs:documentation>\r
 152     </xs:annotation>\r
 153     <xs:complexContent>\r
 154       <xs:extension base="core:OCIDataResponse">\r
 155         <xs:sequence>\r
 156           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 157           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 158           <xs:element name="blacklisted" type="xs:boolean"/>\r
 159           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 160           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 161         </xs:sequence>\r
 162       </xs:extension>\r
 163     </xs:complexContent>\r
 164   </xs:complexType>    \r
 165     \r
 166   <xs:complexType name="UserCallNotifyDeleteCriteriaRequest">\r
 167     <xs:annotation>\r
 168       <xs:documentation>\r
 169         Delete a criteria from the user's call notify service.\r
 170         The response is either a SuccessResponse or an ErrorResponse.\r
 171       </xs:documentation>\r
 172     </xs:annotation>\r
 173     <xs:complexContent>\r
 174       <xs:extension base="core:OCIRequest">\r
 175         <xs:sequence>\r
 176           <xs:element name="userId" type="UserId"/>\r
 177           <xs:element name="criteriaName" type="CriteriaName"/>\r
 178         </xs:sequence>\r
 179       </xs:extension>\r
 180     </xs:complexContent>\r
 181   </xs:complexType>    \r
 182     \r
 183   <xs:complexType name="UserCallNotifyModifyCriteriaRequest">\r
 184     <xs:annotation>\r
 185       <xs:documentation>\r
 186         Modify a criteria for the user's call notify service.\r
 187         For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
 188         The response is either a SuccessResponse or an ErrorResponse.\r
 189       </xs:documentation>\r
 190     </xs:annotation>\r
 191     <xs:complexContent>\r
 192       <xs:extension base="core:OCIRequest">\r
 193         <xs:sequence>\r
 194           <xs:element name="userId" type="UserId"/>\r
 195           <xs:element name="criteriaName" type="CriteriaName"/>\r
 196           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
 197           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
 198           <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>\r
 199           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
 200           <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>\r
 201           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
 202         </xs:sequence>\r
 203       </xs:extension>\r
 204     </xs:complexContent>\r
 205   </xs:complexType>    \r
 206     \r
 207   <xs:complexType name="UserCallNotifyGetRequest">\r
 208     <xs:annotation>\r
 209       <xs:documentation>\r
 210         Get the user's call notify service setting.\r
 211         The response is either a UserCallNotifyGetResponse or an ErrorResponse.\r
 212       </xs:documentation>\r
 213     </xs:annotation>\r
 214     <xs:complexContent>\r
 215       <xs:extension base="core:OCIRequest">\r
 216         <xs:sequence>\r
 217           <xs:element name="userId" type="UserId"/>\r
 218         </xs:sequence>\r
 219       </xs:extension>\r
 220     </xs:complexContent>\r
 221   </xs:complexType>    \r
 222     \r
 223   <xs:complexType name="UserCallNotifyGetResponse">\r
 224     <xs:annotation>\r
 225       <xs:documentation>\r
 226         Response to the UserCallNotifyGetRequest. The criteria table's column headings are: "Is Active", \r
 227         "Criteria Name", "Time Schedule", "Calls From", "Blacklisted" ,"Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension".\r
 228        The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:\r
 229           - Primary\r
 230           - Alternate X (where x is a number between 1 and 10)\r
 231           - Mobility        \r
 232         The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:\r
 233           - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number.\r
 234           - When no number is available a blank space is provided instead.\r
 235         The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:\r
 236           - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension.\r
 237           - For Mobility Calls To Type, this is always blank.\r
 238           - When no extension is available a blank space is provided instead.\r
 239       </xs:documentation>\r
 240     </xs:annotation>\r
 241     <xs:complexContent>\r
 242       <xs:extension base="core:OCIDataResponse">\r
 243         <xs:sequence>\r
 244           <xs:element name="callNotifyEmailAddress" type="EmailAddress" minOccurs="0"/>\r
 245           <xs:element name="criteriaTable" type="core:OCITable"/>\r
 246         </xs:sequence>\r
 247       </xs:extension>\r
 248     </xs:complexContent>\r
 249   </xs:complexType>    \r
 250     \r
 251   <xs:complexType name="UserCallNotifyModifyRequest">\r
 252     <xs:annotation>\r
 253       <xs:documentation>\r
 254         Modify the user's call notify service setting.\r
 255         The response is either a SuccessResponse or an ErrorResponse.\r
 256       </xs:documentation>\r
 257     </xs:annotation>\r
 258     <xs:complexContent>\r
 259       <xs:extension base="core:OCIRequest">\r
 260         <xs:sequence>\r
 261           <xs:element name="userId" type="UserId"/>\r
 262           <xs:element name="callNotifyEmailAddress" type="EmailAddress" minOccurs="0"/>\r
 263           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 264         </xs:sequence>\r
 265       </xs:extension>\r
 266     </xs:complexContent>\r
 267   </xs:complexType>    \r
 268     \r
 269 </xs:schema>\r