share/OCISchemaAS/Services/OCISchemaServiceIncomingCallingPlan.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 <!-- I N C O M I N G   C A L L I N G   P L A N  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   <!-- I N C O M I N G   C A L L I N G   P L A N                                          -->\r
  27   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  28   <!-- ********************************************************************************** -->\r
  29   <!--\r
  30   Requests and responses are listed here in alphabetical order.\r
  31   The non-primitive attributes inside the commands are defined in another\r
  32   section of the schema.\r
  33 \r
  34   Requests in this schema file:\r
  35     GroupIncomingCallingPlanGetListRequest    \r
  36     GroupIncomingCallingPlanModifyListRequest    \r
  37     UserIncomingCallingPlanGetRequest    \r
  38     UserIncomingCallingPlanModifyRequest    \r
  39     \r
  40   --> \r
  41   \r
  42   <xs:complexType name="GroupIncomingCallingPlanGetListRequest">\r
  43     <xs:annotation>\r
  44       <xs:documentation>\r
  45         Request the group's incoming calling plan settings.\r
  46         The response is either a GroupIncomingCallingPlanGetListResponse or an ErrorResponse.\r
  47       </xs:documentation>\r
  48     </xs:annotation>\r
  49     <xs:complexContent>\r
  50       <xs:extension base="core:OCIRequest">\r
  51         <xs:sequence>\r
  52           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  53           <xs:element name="groupId" type="GroupId"/>\r
  54         </xs:sequence>\r
  55       </xs:extension>\r
  56     </xs:complexContent>\r
  57   </xs:complexType>    \r
  58     \r
  59   <xs:complexType name="GroupIncomingCallingPlanGetListResponse">\r
  60     <xs:annotation>\r
  61       <xs:documentation>\r
  62         Response to GroupIncomingCallingPlanGetListRequest.\r
  63       </xs:documentation>\r
  64     </xs:annotation>\r
  65     <xs:complexContent>\r
  66       <xs:extension base="core:OCIDataResponse">\r
  67         <xs:sequence>\r
  68           <xs:element name="groupPermissions" type="IncomingCallingPlanPermissions"/>\r
  69           <xs:element name="departmentPermissions" type="IncomingCallingPlanDepartmentPermissions" minOccurs="0" maxOccurs="unbounded"/>\r
  70         </xs:sequence>\r
  71       </xs:extension>\r
  72     </xs:complexContent>\r
  73   </xs:complexType>    \r
  74     \r
  75   <xs:complexType name="GroupIncomingCallingPlanModifyListRequest">\r
  76     <xs:annotation>\r
  77       <xs:documentation>\r
  78         Change the group's incoming calling plan settings.\r
  79         The response is either a SuccessResponse or an ErrorResponse.\r
  80       </xs:documentation>\r
  81     </xs:annotation>\r
  82     <xs:complexContent>\r
  83       <xs:extension base="core:OCIRequest">\r
  84         <xs:sequence>\r
  85           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  86           <xs:element name="groupId" type="GroupId"/>\r
  87           <xs:element name="groupPermissions" type="IncomingCallingPlanPermissionsModify" minOccurs="0"/>\r
  88           <xs:element name="departmentPermissions" type="IncomingCallingPlanDepartmentPermissionsModify" minOccurs="0" maxOccurs="unbounded"/>\r
  89         </xs:sequence>\r
  90       </xs:extension>\r
  91     </xs:complexContent>\r
  92   </xs:complexType>    \r
  93     \r
  94   <xs:complexType name="UserIncomingCallingPlanGetRequest">\r
  95     <xs:annotation>\r
  96       <xs:documentation>\r
  97         Request the user's incoming calling plan settings.\r
  98         The response is either a UserIncomingCallingPlanGetListResponse or an ErrorResponse.\r
  99       </xs:documentation>\r
 100     </xs:annotation>\r
 101     <xs:complexContent>\r
 102       <xs:extension base="core:OCIRequest">\r
 103         <xs:sequence>\r
 104           <xs:element name="userId" type="UserId"/>\r
 105         </xs:sequence>\r
 106       </xs:extension>\r
 107     </xs:complexContent>\r
 108   </xs:complexType>    \r
 109     \r
 110   <xs:complexType name="UserIncomingCallingPlanGetResponse">\r
 111     <xs:annotation>\r
 112       <xs:documentation>\r
 113         Response to UserIncomingCallingPlanGetRequest.\r
 114       </xs:documentation>\r
 115     </xs:annotation>\r
 116     <xs:complexContent>\r
 117       <xs:extension base="core:OCIDataResponse">\r
 118         <xs:sequence>\r
 119           <xs:element name="useCustomSettings" type="xs:boolean"/>\r
 120           <xs:element name="userPermissions" type="IncomingCallingPlanPermissions"/>\r
 121         </xs:sequence>\r
 122       </xs:extension>\r
 123     </xs:complexContent>\r
 124   </xs:complexType>    \r
 125     \r
 126   <xs:complexType name="UserIncomingCallingPlanModifyRequest">\r
 127     <xs:annotation>\r
 128       <xs:documentation>\r
 129         Change the user's incoming calling plan settings.\r
 130         The response is either a SuccessResponse or an ErrorResponse.\r
 131       </xs:documentation>\r
 132     </xs:annotation>\r
 133     <xs:complexContent>\r
 134       <xs:extension base="core:OCIRequest">\r
 135         <xs:sequence>\r
 136           <xs:element name="userId" type="UserId"/>\r
 137           <xs:element name="useCustomSettings" type="xs:boolean" minOccurs="0"/>\r
 138           <xs:element name="userPermissions" type="IncomingCallingPlanPermissionsModify" minOccurs="0"/>\r
 139         </xs:sequence>\r
 140       </xs:extension>\r
 141     </xs:complexContent>\r
 142   </xs:complexType>    \r
 143     \r
 144   <xs:complexType name="IncomingCallingPlanDepartmentPermissions">\r
 145     <xs:annotation>\r
 146       <xs:documentation>\r
 147         Allows or disallows various types of incoming calls for a specified department.\r
 148       </xs:documentation>\r
 149     </xs:annotation>\r
 150     <xs:sequence>\r
 151       <xs:element name="departmentKey" type="DepartmentKey"/>\r
 152       <xs:element name="departmentFullPathName" type="DepartmentFullPathName"/>\r
 153       <xs:element name="allowFromWithinGroup" type="xs:boolean"/>\r
 154       <xs:element name="allowFromOutsideGroup" type="IncomingCallingPlanOutsideCallPermission"/>\r
 155       <xs:element name="allowCollectCalls" type="xs:boolean"/>\r
 156       <xs:element name="digitPatternPermission" type="IncomingCallingPlanDigitPatternPermission" minOccurs="0" maxOccurs="unbounded"/>\r
 157     </xs:sequence>\r
 158   </xs:complexType>    \r
 159     \r
 160   <xs:complexType name="IncomingCallingPlanDepartmentPermissionsModify">\r
 161     <xs:annotation>\r
 162       <xs:documentation>\r
 163         Allows or disallows various types of incoming calls for a specified department.\r
 164         For use when modifing settings.\r
 165       </xs:documentation>\r
 166     </xs:annotation>\r
 167     <xs:sequence>\r
 168       <xs:element name="departmentKey" type="DepartmentKey"/>\r
 169       <xs:element name="allowFromWithinGroup" type="xs:boolean" minOccurs="0"/>\r
 170       <xs:element name="allowFromOutsideGroup" type="IncomingCallingPlanOutsideCallPermission" minOccurs="0"/>\r
 171       <xs:element name="allowCollectCalls" type="xs:boolean" minOccurs="0"/>\r
 172       <xs:element name="digitPatternPermission" type="IncomingCallingPlanDigitPatternPermission" minOccurs="0" maxOccurs="unbounded"/>\r
 173     </xs:sequence>\r
 174   </xs:complexType>    \r
 175     \r
 176   <xs:complexType name="IncomingCallingPlanDigitPatternPermission">\r
 177     <xs:annotation>\r
 178       <xs:documentation>\r
 179         Indicates whether calls from specified digit patterns are permitted.\r
 180       </xs:documentation>\r
 181     </xs:annotation>\r
 182     <xs:sequence>\r
 183       <xs:element name="digitPatternName" type="CallingPlanDigitPatternName"/>\r
 184       <xs:element name="allow" type="xs:boolean"/>\r
 185     </xs:sequence>\r
 186   </xs:complexType>    \r
 187     \r
 188   <xs:simpleType name="IncomingCallingPlanOutsideCallPermission">\r
 189     <xs:annotation>\r
 190       <xs:documentation>\r
 191         Indicates whether incoming outside calls are permitted.\r
 192       </xs:documentation>\r
 193     </xs:annotation>\r
 194     <xs:restriction base="xs:token">\r
 195       <xs:enumeration value="Allow"/>\r
 196       <xs:enumeration value="Allow Only If Redirected From Another User"/>\r
 197       <xs:enumeration value="Disallow"/>\r
 198     </xs:restriction>\r
 199   </xs:simpleType>    \r
 200     \r
 201   <xs:complexType name="IncomingCallingPlanPermissions">\r
 202     <xs:annotation>\r
 203       <xs:documentation>\r
 204         Allows or disallows various types of incoming calls for a user or group -- not any particular department.\r
 205       </xs:documentation>\r
 206     </xs:annotation>\r
 207     <xs:sequence>\r
 208       <xs:element name="allowFromWithinGroup" type="xs:boolean"/>\r
 209       <xs:element name="allowFromOutsideGroup" type="IncomingCallingPlanOutsideCallPermission"/>\r
 210       <xs:element name="allowCollectCalls" type="xs:boolean"/>\r
 211       <xs:element name="digitPatternPermission" type="IncomingCallingPlanDigitPatternPermission" minOccurs="0" maxOccurs="unbounded"/>\r
 212     </xs:sequence>\r
 213   </xs:complexType>    \r
 214     \r
 215   <xs:complexType name="IncomingCallingPlanPermissionsModify">\r
 216     <xs:annotation>\r
 217       <xs:documentation>\r
 218         Allows or disallows various types of incoming calls for a user or group -- not any particular department.\r
 219         For use when modifing settings.\r
 220       </xs:documentation>\r
 221     </xs:annotation>\r
 222     <xs:sequence>\r
 223       <xs:element name="allowFromWithinGroup" type="xs:boolean" minOccurs="0"/>\r
 224       <xs:element name="allowFromOutsideGroup" type="IncomingCallingPlanOutsideCallPermission" minOccurs="0"/>\r
 225       <xs:element name="allowCollectCalls" type="xs:boolean" minOccurs="0"/>\r
 226       <xs:element name="digitPatternPermission" type="IncomingCallingPlanDigitPatternPermission" minOccurs="0" maxOccurs="unbounded"/>\r
 227     </xs:sequence>\r
 228   </xs:complexType>    \r
 229     \r
 230 </xs:schema>\r