share/OCISchemaAS/Services/OCISchemaServiceTwoStageDialing.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 <!-- T W O   S T A G E   D I A L 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   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- T W O   S T A G E   D I A L I N G    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     UserTwoStageDialingGetRequest13Mp20    \r
  36     UserTwoStageDialingModifyRequest    \r
  37     SystemTwoStageDialingAddDnRequest    \r
  38     SystemTwoStageDialingDeleteDnRequest    \r
  39     SystemTwoStageDialingGetDnListRequest    \r
  40     SystemTwoStageDialingModifyDnRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="UserTwoStageDialingGetRequest13Mp20">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47           Request the user level data associated with Two Stage Dialing.\r
  48           The response is either a UserTwoStageDialingGetResponse13Mp20 or an ErrorResponse.\r
  49         </xs:documentation>\r
  50     </xs:annotation>\r
  51     <xs:complexContent>\r
  52       <xs:extension base="core:OCIRequest">\r
  53         <xs:sequence>\r
  54           <xs:element name="userId" type="UserId"/>\r
  55         </xs:sequence>\r
  56       </xs:extension>\r
  57     </xs:complexContent>\r
  58   </xs:complexType>    \r
  59     \r
  60   <xs:complexType name="UserTwoStageDialingGetResponse13Mp20">\r
  61     <xs:annotation>\r
  62       <xs:documentation>\r
  63           Response to UserTwoStageDialingGetRequest13Mp20.\r
  64         </xs:documentation>\r
  65     </xs:annotation>\r
  66     <xs:complexContent>\r
  67       <xs:extension base="core:OCIDataResponse">\r
  68         <xs:sequence>\r
  69           <xs:element name="isActive" type="xs:boolean"/>\r
  70           <xs:element name="allowActivationWithUserAddresses" type="xs:boolean"/>\r
  71         </xs:sequence>\r
  72       </xs:extension>\r
  73     </xs:complexContent>\r
  74   </xs:complexType>    \r
  75     \r
  76   <xs:complexType name="UserTwoStageDialingModifyRequest">\r
  77     <xs:annotation>\r
  78       <xs:documentation>\r
  79           Modify the user level data associated with Two Stage Dialing.\r
  80           The response is either a SuccessResponse or an ErrorResponse.\r
  81         </xs:documentation>\r
  82     </xs:annotation>\r
  83     <xs:complexContent>\r
  84       <xs:extension base="core:OCIRequest">\r
  85         <xs:sequence>\r
  86           <xs:element name="userId" type="UserId"/>\r
  87           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
  88           <xs:element name="allowActivationWithUserAddresses" type="xs:boolean" minOccurs="0"/>\r
  89         </xs:sequence>\r
  90       </xs:extension>\r
  91     </xs:complexContent>\r
  92   </xs:complexType>    \r
  93     \r
  94   <xs:complexType name="SystemTwoStageDialingAddDnRequest">\r
  95     <xs:annotation>\r
  96       <xs:documentation>\r
  97              Request to add Two Stage Dialing number to the system.\r
  98              The response is either a SuccessResponse 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="phoneNumber" type="DN"/>\r
 105           <xs:element name="description" type="TwoStageDialingDescription" minOccurs="0"/>\r
 106         </xs:sequence>\r
 107       </xs:extension>\r
 108     </xs:complexContent>\r
 109   </xs:complexType>    \r
 110     \r
 111   <xs:complexType name="SystemTwoStageDialingDeleteDnRequest">\r
 112     <xs:annotation>\r
 113       <xs:documentation>\r
 114           Request to delete a Two Stage Dialing number from the system.\r
 115           The response is either a SuccessResponse or an ErrorResponse.\r
 116          </xs:documentation>\r
 117     </xs:annotation>\r
 118     <xs:complexContent>\r
 119       <xs:extension base="core:OCIRequest">\r
 120         <xs:sequence>\r
 121           <xs:element name="phoneNumber" type="DN"/>\r
 122         </xs:sequence>\r
 123       </xs:extension>\r
 124     </xs:complexContent>\r
 125   </xs:complexType>    \r
 126     \r
 127   <xs:complexType name="SystemTwoStageDialingGetDnListRequest">\r
 128     <xs:annotation>\r
 129       <xs:documentation>\r
 130           Request to get a list of Two Stage Dialing dns defined in the system.\r
 131           The response is either a SystemTwoStageDialingGetDnListResponse\r
 132           or an ErrorResponse.\r
 133         </xs:documentation>\r
 134     </xs:annotation>\r
 135     <xs:complexContent>\r
 136       <xs:extension base="core:OCIRequest">\r
 137         <xs:sequence>\r
 138           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 139           <xs:element name="searchCriteriaSystemServiceDn" type="SearchCriteriaSystemServiceDn" minOccurs="0" maxOccurs="unbounded"/>\r
 140         </xs:sequence>\r
 141       </xs:extension>\r
 142     </xs:complexContent>\r
 143   </xs:complexType>    \r
 144     \r
 145   <xs:complexType name="SystemTwoStageDialingGetDnListResponse">\r
 146     <xs:annotation>\r
 147       <xs:documentation>\r
 148           Response to SystemTwoStageDialingGetDnListRequest.\r
 149           The Two Stage Dialing DN List table column\r
 150           headings are: "Phone Number",  "Description".\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="phoneNumberTable" type="core:OCITable"/>\r
 157         </xs:sequence>\r
 158       </xs:extension>\r
 159     </xs:complexContent>\r
 160   </xs:complexType>    \r
 161     \r
 162   <xs:complexType name="SystemTwoStageDialingModifyDnRequest">\r
 163     <xs:annotation>\r
 164       <xs:documentation>\r
 165           Request to modify a Two Stage Dialing number's description in the system.\r
 166           The response is either a SuccessResponse or an ErrorResponse.\r
 167         </xs:documentation>\r
 168     </xs:annotation>\r
 169     <xs:complexContent>\r
 170       <xs:extension base="core:OCIRequest">\r
 171         <xs:sequence>\r
 172           <xs:element name="phoneNumber" type="DN"/>\r
 173           <xs:element name="description" type="TwoStageDialingDescription" nillable="true" minOccurs="0"/>\r
 174         </xs:sequence>\r
 175       </xs:extension>\r
 176     </xs:complexContent>\r
 177   </xs:complexType>    \r
 178     \r
 179   <xs:simpleType name="TwoStageDialingDescription">\r
 180     <xs:annotation>\r
 181       <xs:documentation>\r
 182           Two Stage Dialing phone number's description.\r
 183         </xs:documentation>\r
 184     </xs:annotation>\r
 185     <xs:restriction base="xs:token">\r
 186       <xs:minLength value="1"/>\r
 187       <xs:maxLength value="80"/>\r
 188     </xs:restriction>\r
 189   </xs:simpleType>    \r
 190     \r
 191 </xs:schema>\r