share/OCISchemaAS/Services/OCISchemaServiceVirtualOnNetEnterpriseExtensions.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 <!-- V I R T U A L   O N   N E T   E N T E R P R I S E                      -->\r
   9 <!-- E X T E N S I O N S  S E R V I C E                                     -->\r
  10 <!--                                                                        -->\r
  11 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
  12 <!-- Open Client Interface (OCI).                                           -->\r
  13 <!-- ********************************************************************** -->\r
  14 \r
  15 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
  16            xmlns:core           = "C"\r
  17            xmlns                = ""\r
  18            attributeFormDefault = "qualified"\r
  19            elementFormDefault   = "qualified">\r
  20   \r
  21   <xs:import namespace      = "C"\r
  22              schemaLocation = "../OCISchemaBASE.xsd"/>\r
  23   \r
  24   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  25   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  26   \r
  27   <!-- ********************************************************************************** -->\r
  28   <!-- V I R T U A L   O N   N E T   E N T E R P R I S E   E X T E N S I O N S            -->\r
  29   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  30   <!-- ********************************************************************************** -->\r
  31   <!--\r
  32   Requests and responses are listed here in alphabetical order.\r
  33   The non-primitive attributes inside the commands are defined in another\r
  34   section of the schema.\r
  35 \r
  36   Requests in this schema file:\r
  37     EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest    \r
  38     GroupVirtualOnNetEnterpriseExtensionsAddUserRequest    \r
  39     GroupVirtualOnNetEnterpriseExtensionsDeleteUserRequest    \r
  40     GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest    \r
  41     GroupVirtualOnNetEnterpriseExtensionsGetUserRequest    \r
  42     GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest    \r
  43     SystemVirtualOnNetCallTypeAddRequest    \r
  44     SystemVirtualOnNetCallTypeDeleteRequest    \r
  45     SystemVirtualOnNetCallTypeGetListRequest    \r
  46     SystemVirtualOnNetCallTypeModifyRequest    \r
  47     \r
  48   --> \r
  49   \r
  50   <xs:complexType name="EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest">\r
  51     <xs:annotation>\r
  52       <xs:documentation>\r
  53         Request the list of Virtual On-Net users in an Enterprise.\r
  54         It is possible to search by various criteria to restrict the number of rows returned.\r
  55         Multiple search criteria are logically ANDed together.\r
  56         The response is either a  EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse or \r
  57         an ErrorResponse.\r
  58       </xs:documentation>\r
  59     </xs:annotation>\r
  60     <xs:complexContent>\r
  61       <xs:extension base="core:OCIRequest">\r
  62         <xs:sequence>\r
  63           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  64           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
  65           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
  66           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
  67           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
  68           <xs:element name="searchCriteriaGroupLocationCode" type="SearchCriteriaGroupLocationCode" minOccurs="0" maxOccurs="unbounded"/>\r
  69           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
  70           <xs:element name="searchCriteriaExactVirtualOnNetCallTypeName" type="SearchCriteriaExactVirtualOnNetCallTypeName" minOccurs="0" maxOccurs="1"/>\r
  71         </xs:sequence>\r
  72       </xs:extension>\r
  73     </xs:complexContent>\r
  74   </xs:complexType>    \r
  75     \r
  76   <xs:complexType name="EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse">\r
  77     <xs:annotation>\r
  78       <xs:documentation>\r
  79         Response to   EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest.\r
  80         Contains a table with column headings : "Group Id", "Last Name", "First Name", "Phone Number", "Extension", \r
  81         "Virtual On-Net Call Type" in a row for each user.\r
  82       </xs:documentation>\r
  83     </xs:annotation>\r
  84     <xs:complexContent>\r
  85       <xs:extension base="core:OCIDataResponse">\r
  86         <xs:sequence>\r
  87           <xs:element name="userTable" type="core:OCITable"/>\r
  88         </xs:sequence>\r
  89       </xs:extension>\r
  90     </xs:complexContent>\r
  91   </xs:complexType>    \r
  92     \r
  93   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsAddUserRequest">\r
  94     <xs:annotation>\r
  95       <xs:documentation>\r
  96         Adds Virtual On-Net users to a Group. It is possible to add \r
  97         either: a single user,  or a list of users, or a range of users, \r
  98         or any combination thereof.\r
  99         The response is either a SuccessResponse or an ErrorResponse.\r
 100       </xs:documentation>\r
 101     </xs:annotation>\r
 102     <xs:complexContent>\r
 103       <xs:extension base="core:OCIRequest">\r
 104         <xs:sequence>\r
 105           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 106           <xs:element name="groupId" type="GroupId"/>\r
 107           <xs:element name="virtualOnNetUser" type="VirtualOnNetUser" minOccurs="0" maxOccurs="100"/>\r
 108           <xs:element name="virtualOnNetUserRange" type="VirtualOnNetUserRange" minOccurs="0" maxOccurs="1"/>\r
 109         </xs:sequence>\r
 110       </xs:extension>\r
 111     </xs:complexContent>\r
 112   </xs:complexType>    \r
 113     \r
 114   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsDeleteUserRequest">\r
 115     <xs:annotation>\r
 116       <xs:documentation>\r
 117         Delete an existing Virtual On-Net user from a Group.\r
 118         The response is either a SuccessResponse or an ErrorResponse.\r
 119       </xs:documentation>\r
 120     </xs:annotation>\r
 121     <xs:complexContent>\r
 122       <xs:extension base="core:OCIRequest">\r
 123         <xs:sequence>\r
 124           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 125           <xs:element name="groupId" type="GroupId"/>\r
 126           <xs:element name="phoneNumber" type="DN"/>\r
 127         </xs:sequence>\r
 128       </xs:extension>\r
 129     </xs:complexContent>\r
 130   </xs:complexType>    \r
 131     \r
 132   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest">\r
 133     <xs:annotation>\r
 134       <xs:documentation>\r
 135         Request the list of Virtual On-Net users in a Group.\r
 136         It is possible to search by various criteria to restrict the number \r
 137         of rows returned.\r
 138         Multiple search criteria are logically ANDed together.\r
 139         The response is either a \r
 140         GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse or an \r
 141         ErrorResponse.\r
 142       </xs:documentation>\r
 143     </xs:annotation>\r
 144     <xs:complexContent>\r
 145       <xs:extension base="core:OCIRequest">\r
 146         <xs:sequence>\r
 147           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 148           <xs:element name="groupId" type="GroupId"/>\r
 149           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 150           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 151           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 152           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 153           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 154           <xs:element name="searchCriteriaExactVirtualOnNetCallTypeName" type="SearchCriteriaExactVirtualOnNetCallTypeName" minOccurs="0" maxOccurs="1"/>\r
 155         </xs:sequence>\r
 156       </xs:extension>\r
 157     </xs:complexContent>\r
 158   </xs:complexType>    \r
 159     \r
 160   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse">\r
 161     <xs:annotation>\r
 162       <xs:documentation>\r
 163         Response to GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest.\r
 164         Contains a table with column headings: "Last Name", \r
 165         "First Name", "Phone Number", "Extension", \r
 166         "Virtual On-Net Call Type Name"\r
 167         in a row for each user.\r
 168       </xs:documentation>\r
 169     </xs:annotation>\r
 170     <xs:complexContent>\r
 171       <xs:extension base="core:OCIDataResponse">\r
 172         <xs:sequence>\r
 173           <xs:element name="userTable" type="core:OCITable"/>\r
 174         </xs:sequence>\r
 175       </xs:extension>\r
 176     </xs:complexContent>\r
 177   </xs:complexType>    \r
 178     \r
 179   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsGetUserRequest">\r
 180     <xs:annotation>\r
 181       <xs:documentation>\r
 182         Get an existing Virtual On-Net user from a Group.\r
 183         The response is either a \r
 184         GroupVirtualOnNetEnterpriseExtensionsGetUserResponse\r
 185         or an ErrorResponse.\r
 186       </xs:documentation>\r
 187     </xs:annotation>\r
 188     <xs:complexContent>\r
 189       <xs:extension base="core:OCIRequest">\r
 190         <xs:sequence>\r
 191           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 192           <xs:element name="groupId" type="GroupId"/>\r
 193           <xs:element name="phoneNumber" type="DN"/>\r
 194         </xs:sequence>\r
 195       </xs:extension>\r
 196     </xs:complexContent>\r
 197   </xs:complexType>    \r
 198     \r
 199   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsGetUserResponse">\r
 200     <xs:annotation>\r
 201       <xs:documentation>\r
 202         Response to GroupVirtualOnNetEnterpriseExtensionsGetUserRequest.\r
 203       </xs:documentation>\r
 204     </xs:annotation>\r
 205     <xs:complexContent>\r
 206       <xs:extension base="core:OCIDataResponse">\r
 207         <xs:sequence>\r
 208           <xs:element name="extension" type="Extension17"/>\r
 209           <xs:element name="firstName" type="FirstName"/>\r
 210           <xs:element name="lastName" type="LastName"/>\r
 211           <xs:element name="callingLineIdFirstName" type="CallingLineIdFirstName"/>\r
 212           <xs:element name="callingLineIdLastName" type="CallingLineIdLastName"/>\r
 213           <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName"/>\r
 214         </xs:sequence>\r
 215       </xs:extension>\r
 216     </xs:complexContent>\r
 217   </xs:complexType>    \r
 218     \r
 219   <xs:complexType name="GroupVirtualOnNetEnterpriseExtensionsModifyUserRequest">\r
 220     <xs:annotation>\r
 221       <xs:documentation>\r
 222         Modify an existing Virtual On-Net user of a Group.\r
 223         The serviceProviderId, groupId and phoneNumber combination uniquely \r
 224         identifies a Virtual On-Net User. \r
 225         The response is either a SuccessResponse or an ErrorResponse.\r
 226       </xs:documentation>\r
 227     </xs:annotation>\r
 228     <xs:complexContent>\r
 229       <xs:extension base="core:OCIRequest">\r
 230         <xs:sequence>\r
 231           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 232           <xs:element name="groupId" type="GroupId"/>\r
 233           <xs:element name="phoneNumber" type="DN"/>\r
 234           <xs:element name="extension" type="Extension17" minOccurs="0"/>\r
 235           <xs:element name="firstName" type="FirstName" minOccurs="0"/>\r
 236           <xs:element name="lastName" type="LastName" minOccurs="0"/>\r
 237           <xs:element name="callingLineIdFirstName" type="CallingLineIdFirstName" minOccurs="0"/>\r
 238           <xs:element name="callingLineIdLastName" type="CallingLineIdLastName" minOccurs="0"/>\r
 239           <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName" minOccurs="0"/>\r
 240         </xs:sequence>\r
 241       </xs:extension>\r
 242     </xs:complexContent>\r
 243   </xs:complexType>    \r
 244     \r
 245   <xs:complexType name="SystemVirtualOnNetCallTypeAddRequest">\r
 246     <xs:annotation>\r
 247       <xs:documentation>\r
 248          Add a Virtual On-Net Call Type.\r
 249          The response is either a SuccessResponse or an ErrorResponse.\r
 250        </xs:documentation>\r
 251     </xs:annotation>\r
 252     <xs:complexContent>\r
 253       <xs:extension base="core:OCIRequest">\r
 254         <xs:sequence>\r
 255           <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName"/>\r
 256           <xs:element name="virtualOnNetCallTypeCdrValue" type="VirtualOnNetCallTypeCdrValue"/>\r
 257         </xs:sequence>\r
 258       </xs:extension>\r
 259     </xs:complexContent>\r
 260   </xs:complexType>    \r
 261     \r
 262   <xs:complexType name="SystemVirtualOnNetCallTypeDeleteRequest">\r
 263     <xs:annotation>\r
 264       <xs:documentation>\r
 265         Delete a Virtual On-Net Call Type.\r
 266         The response is either a SuccessResponse or an ErrorResponse.\r
 267       </xs:documentation>\r
 268     </xs:annotation>\r
 269     <xs:complexContent>\r
 270       <xs:extension base="core:OCIRequest">\r
 271         <xs:sequence>\r
 272           <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName"/>\r
 273         </xs:sequence>\r
 274       </xs:extension>\r
 275     </xs:complexContent>\r
 276   </xs:complexType>    \r
 277     \r
 278   <xs:complexType name="SystemVirtualOnNetCallTypeGetListRequest">\r
 279     <xs:annotation>\r
 280       <xs:documentation>\r
 281         Get the list Virtual On-Net Call Types in the system.\r
 282         The response is either a SystemVirtualOnNetCallTypeGetListResponse \r
 283         or an ErrorResponse.\r
 284       </xs:documentation>\r
 285     </xs:annotation>\r
 286     <xs:complexContent>\r
 287       <xs:extension base="core:OCIRequest">\r
 288         <xs:sequence/>\r
 289       </xs:extension>\r
 290     </xs:complexContent>\r
 291   </xs:complexType>    \r
 292     \r
 293   <xs:complexType name="SystemVirtualOnNetCallTypeGetListResponse">\r
 294     <xs:annotation>\r
 295       <xs:documentation>\r
 296         Response to SystemVirtualOnNetCallTypeGetListRequest.\r
 297         Contains a table with column headings: \r
 298         "Virtual On-Net Call Type Name", "Virtual On-Net Call Type CDR Value" \r
 299         in a row for each Virtual On-Net Call Type.\r
 300       </xs:documentation>\r
 301     </xs:annotation>\r
 302     <xs:complexContent>\r
 303       <xs:extension base="core:OCIDataResponse">\r
 304         <xs:sequence>\r
 305           <xs:element name="virtualOnNetCallTypeTable" type="core:OCITable"/>\r
 306         </xs:sequence>\r
 307       </xs:extension>\r
 308     </xs:complexContent>\r
 309   </xs:complexType>    \r
 310     \r
 311   <xs:complexType name="SystemVirtualOnNetCallTypeModifyRequest">\r
 312     <xs:annotation>\r
 313       <xs:documentation>\r
 314         Modify a Virtual On-Net Call Type.\r
 315         The response is either a SuccessResponse or an ErrorResponse.\r
 316       </xs:documentation>\r
 317     </xs:annotation>\r
 318     <xs:complexContent>\r
 319       <xs:extension base="core:OCIRequest">\r
 320         <xs:sequence>\r
 321           <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName"/>\r
 322           <xs:element name="virtualOnNetCallTypeCdrValue" type="VirtualOnNetCallTypeCdrValue" minOccurs="0"/>\r
 323         </xs:sequence>\r
 324       </xs:extension>\r
 325     </xs:complexContent>\r
 326   </xs:complexType>    \r
 327     \r
 328   <xs:complexType name="VirtualOnNetUser">\r
 329     <xs:annotation>\r
 330       <xs:documentation>\r
 331         Virtual On-Net User.\r
 332       </xs:documentation>\r
 333     </xs:annotation>\r
 334     <xs:sequence>\r
 335       <xs:element name="phoneNumber" type="DN"/>\r
 336       <xs:element name="extension" type="Extension17"/>\r
 337       <xs:element name="firstName" type="FirstName"/>\r
 338       <xs:element name="lastName" type="LastName"/>\r
 339       <xs:element name="callingLineIdFirstName" type="CallingLineIdFirstName"/>\r
 340       <xs:element name="callingLineIdLastName" type="CallingLineIdLastName"/>\r
 341       <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName"/>\r
 342     </xs:sequence>\r
 343   </xs:complexType>    \r
 344     \r
 345   <xs:complexType name="VirtualOnNetUserRange">\r
 346     <xs:annotation>\r
 347       <xs:documentation>\r
 348         Virtual On-Net User Range.\r
 349       </xs:documentation>\r
 350     </xs:annotation>\r
 351     <xs:sequence>\r
 352       <xs:element name="dnRange" type="DNRange"/>\r
 353       <xs:element name="extensionRange" type="ExtensionRange17"/>\r
 354       <xs:element name="firstName" type="FirstName"/>\r
 355       <xs:element name="lastName" type="LastName"/>\r
 356       <xs:element name="callingLineIdFirstName" type="CallingLineIdFirstName"/>\r
 357       <xs:element name="callingLineIdLastName" type="CallingLineIdLastName"/>\r
 358       <xs:element name="virtualOnNetCallTypeName" type="VirtualOnNetCallTypeName"/>\r
 359     </xs:sequence>\r
 360   </xs:complexType>    \r
 361     \r
 362 </xs:schema>\r