share/OCISchemaAS/Services/OCISchemaServiceIntegratedIMP.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 T E G R A T E D   I   M   P  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 T E G R A T E D   I   M   P    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     GroupIntegratedIMPGetRequest    \r
  35     GroupIntegratedIMPModifyRequest    \r
  36     ServiceProviderIntegratedIMPGetRequest21    \r
  37     ServiceProviderIntegratedIMPModifyRequest    \r
  38     SystemIntegratedIMPGetRequest21    \r
  39     SystemIntegratedIMPModifyRequest    \r
  40     UserIntegratedIMPGetRequest    \r
  41     UserIntegratedIMPModifyRequest    \r
  42     UserIntegratedIMPGeneratePasswordRequest    \r
  43     \r
  44   --> \r
  45   \r
  46   <xs:complexType name="GroupIntegratedIMPGetRequest">\r
  47     <xs:annotation>\r
  48       <xs:appinfo>\r
  49         <asDataModeSupported>true</asDataModeSupported>\r
  50         <hssDataModeSupported>false</hssDataModeSupported>\r
  51       </xs:appinfo>\r
  52       <xs:documentation>\r
  53         Get the Integrated IMP service attributes for the group.\r
  54         The response is either GroupIntegratedIMPGetResponse or 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:element name="serviceProviderId" type="ServiceProviderId"/>\r
  61           <xs:element name="groupId" type="GroupId"/>\r
  62         </xs:sequence>\r
  63       </xs:extension>\r
  64     </xs:complexContent>\r
  65   </xs:complexType>    \r
  66     \r
  67   <xs:complexType name="GroupIntegratedIMPGetResponse">\r
  68     <xs:annotation>\r
  69       <xs:documentation>\r
  70         Response to the GroupIntegratedIMPGetRequest.\r
  71         The response contains the group Integrated IMP service attributes.\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="useServiceProviderSetting" type="xs:boolean"/>\r
  78           <xs:element name="serviceDomain" type="DomainName" minOccurs="0"/>\r
  79         </xs:sequence>\r
  80       </xs:extension>\r
  81     </xs:complexContent>\r
  82   </xs:complexType>    \r
  83     \r
  84   <xs:complexType name="GroupIntegratedIMPModifyRequest">\r
  85     <xs:annotation>\r
  86       <xs:appinfo>\r
  87         <asDataModeSupported>true</asDataModeSupported>\r
  88         <hssDataModeSupported>false</hssDataModeSupported>\r
  89       </xs:appinfo>\r
  90       <xs:documentation>\r
  91         Modify the Integrated IMP service attributes for the group.\r
  92         The response is either a SuccessResponse or an ErrorResponse.\r
  93       </xs:documentation>\r
  94     </xs:annotation>\r
  95     <xs:complexContent>\r
  96       <xs:extension base="core:OCIRequest">\r
  97         <xs:sequence>\r
  98           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  99           <xs:element name="groupId" type="GroupId"/>\r
 100           <xs:element name="useServiceProviderSetting" type="xs:boolean" minOccurs="0"/>\r
 101           <xs:element name="serviceDomain" type="DomainName" minOccurs="0" nillable="true"/>\r
 102         </xs:sequence>\r
 103       </xs:extension>\r
 104     </xs:complexContent>\r
 105   </xs:complexType>    \r
 106     \r
 107   <xs:complexType name="ServiceProviderIntegratedIMPGetRequest21">\r
 108     <xs:annotation>\r
 109       <xs:documentation>\r
 110         Get the Integrated IMP service attributes for the service provider.\r
 111         The response is either ServiceProviderIntegratedIMPGetResponse21 or ErrorResponse.\r
 112       </xs:documentation>\r
 113     </xs:annotation>\r
 114     <xs:complexContent>\r
 115       <xs:extension base="core:OCIRequest">\r
 116         <xs:sequence>\r
 117           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 118         </xs:sequence>\r
 119       </xs:extension>\r
 120     </xs:complexContent>\r
 121   </xs:complexType>    \r
 122     \r
 123   <xs:complexType name="ServiceProviderIntegratedIMPGetResponse21">\r
 124     <xs:annotation>\r
 125       <xs:documentation>\r
 126         Response to the ServiceProviderIntegratedIMPGetRequest21.\r
 127         The response contains the service provider Integrated IMP service attributes.\r
 128       </xs:documentation>\r
 129     </xs:annotation>\r
 130     <xs:complexContent>\r
 131       <xs:extension base="core:OCIDataResponse">\r
 132         <xs:sequence>\r
 133           <xs:element name="useSystemServiceDomain" type="xs:boolean"/>\r
 134           <xs:element name="serviceDomain" type="DomainName" minOccurs="0"/>\r
 135           <xs:element name="servicePort" type="Port" minOccurs="0"/>\r
 136           <xs:element name="useSystemMessagingServer" type="xs:boolean"/>\r
 137           <xs:element name="provisioningUrl" type="URL" minOccurs="0"/>\r
 138           <xs:element name="provisioningUserId" type="ProvisioningBroadCloudAuthenticationUserName" minOccurs="0"/>\r
 139           <xs:element name="boshURL" type="URL" minOccurs="0"/>\r
 140         </xs:sequence>\r
 141       </xs:extension>\r
 142     </xs:complexContent>\r
 143   </xs:complexType>    \r
 144     \r
 145   <xs:complexType name="ServiceProviderIntegratedIMPModifyRequest">\r
 146     <xs:annotation>\r
 147       <xs:documentation>\r
 148         Modify the Integrated IMP service attributes for the service provider.\r
 149         The response is either a SuccessResponse or an ErrorResponse.\r
 150       </xs:documentation>\r
 151     </xs:annotation>\r
 152     <xs:complexContent>\r
 153       <xs:extension base="core:OCIRequest">\r
 154         <xs:sequence>\r
 155           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 156           <xs:element name="useSystemServiceDomain" type="xs:boolean" minOccurs="0"/>\r
 157           <xs:element name="serviceDomain" type="DomainName" minOccurs="0" nillable="true"/>\r
 158           <xs:element name="servicePort" type="Port" minOccurs="0" nillable="true"/>\r
 159           <xs:element name="useSystemMessagingServer" type="xs:boolean" minOccurs="0"/>\r
 160           <xs:element name="provisioningUrl" type="URL" minOccurs="0" nillable="true"/>\r
 161           <xs:element name="provisioningUserId" type="ProvisioningBroadCloudAuthenticationUserName" minOccurs="0" nillable="true"/>\r
 162           <xs:element name="provisioningPassword" type="ProvisioningBroadCloudAuthenticationPassword" minOccurs="0" nillable="true"/>\r
 163           <xs:element name="boshURL" type="URL" minOccurs="0" nillable="true"/>\r
 164         </xs:sequence>\r
 165       </xs:extension>\r
 166     </xs:complexContent>\r
 167   </xs:complexType>    \r
 168     \r
 169   <xs:complexType name="SystemIntegratedIMPGetRequest21">\r
 170     <xs:annotation>\r
 171       <xs:documentation>\r
 172         Get the system Integrated IMP service attributes.\r
 173         The response is either SystemIntegratedIMPGetResponse19 or ErrorResponse.\r
 174       </xs:documentation>\r
 175     </xs:annotation>\r
 176     <xs:complexContent>\r
 177       <xs:extension base="core:OCIRequest"/>\r
 178     </xs:complexContent>\r
 179   </xs:complexType>    \r
 180     \r
 181   <xs:complexType name="SystemIntegratedIMPGetResponse21">\r
 182     <xs:annotation>\r
 183       <xs:documentation>\r
 184         Response to the SystemIntegratedIMPGetRequest21.\r
 185         The response contains the system Integrated IMP service attributes.\r
 186         \r
 187         The following elements are only used in AS data mode:\r
 188           boshURL\r
 189       </xs:documentation>\r
 190     </xs:annotation>\r
 191     <xs:complexContent>\r
 192       <xs:extension base="core:OCIDataResponse">\r
 193         <xs:sequence>\r
 194           <xs:element name="serviceDomain" type="DomainName" minOccurs="0"/>\r
 195           <xs:element name="servicePort" type="Port" minOccurs="0"/>\r
 196           <xs:element name="addServiceProviderInIMPUserId" type="xs:boolean"/>\r
 197           <xs:element name="boshURL" type="URL" minOccurs="0"/>\r
 198           <xs:element name="allowImpPasswordRetrieval" type="xs:boolean"/>\r
 199         </xs:sequence>\r
 200       </xs:extension>\r
 201     </xs:complexContent>\r
 202   </xs:complexType>    \r
 203     \r
 204   <xs:complexType name="SystemIntegratedIMPModifyRequest">\r
 205     <xs:annotation>\r
 206       <xs:documentation>\r
 207         Modify the system Integrated IMP service attributes.\r
 208         The response is either a SuccessResponse or an ErrorResponse.\r
 209         \r
 210         The following elements are only used in AS data mode:\r
 211           boshURL\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="serviceDomain" type="DomainName" minOccurs="0" nillable="true"/>\r
 218           <xs:element name="servicePort" type="Port" minOccurs="0" nillable="true"/>\r
 219           <xs:element name="addServiceProviderInIMPUserId" type="xs:boolean" minOccurs="0"/>\r
 220           <xs:element name="boshURL" type="URL" minOccurs="0" nillable="true"/>\r
 221           <xs:element name="allowImpPasswordRetrieval" type="xs:boolean" minOccurs="0"/>\r
 222         </xs:sequence>\r
 223       </xs:extension>\r
 224     </xs:complexContent>\r
 225   </xs:complexType>    \r
 226     \r
 227   <xs:complexType name="UserIntegratedIMPGetRequest">\r
 228     <xs:annotation>\r
 229       <xs:documentation>\r
 230         Get the Integrated IMP specific service attribute for the user.\r
 231         The response is either UserIMPGetResponse or ErrorResponse.\r
 232       </xs:documentation>\r
 233     </xs:annotation>\r
 234     <xs:complexContent>\r
 235       <xs:extension base="core:OCIRequest">\r
 236         <xs:sequence>\r
 237           <xs:element name="userId" type="UserId"/>\r
 238         </xs:sequence>\r
 239       </xs:extension>\r
 240     </xs:complexContent>\r
 241   </xs:complexType>    \r
 242     \r
 243   <xs:complexType name="UserIntegratedIMPGetResponse">\r
 244     <xs:annotation>\r
 245       <xs:documentation>\r
 246         Response to the UserIntegratedIMPGetRequest.\r
 247         The response contains the Integrated IMP specific service attributes for the user.\r
 248       </xs:documentation>\r
 249     </xs:annotation>\r
 250     <xs:complexContent>\r
 251       <xs:extension base="core:OCIDataResponse">\r
 252         <xs:sequence>\r
 253           <xs:element name="isActive" type="xs:boolean"/>\r
 254         </xs:sequence>\r
 255       </xs:extension>\r
 256     </xs:complexContent>\r
 257   </xs:complexType>    \r
 258     \r
 259   <xs:complexType name="UserIntegratedIMPModifyRequest">\r
 260     <xs:annotation>\r
 261       <xs:documentation>\r
 262         Modifies the Integrated IMP specific service attribute for the user.\r
 263         The response is either a SuccessResponse or an ErrorResponse.\r
 264       </xs:documentation>\r
 265     </xs:annotation>\r
 266     <xs:complexContent>\r
 267       <xs:extension base="core:OCIRequest">\r
 268         <xs:sequence>\r
 269           <xs:element name="userId" type="UserId"/>\r
 270           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 271         </xs:sequence>\r
 272       </xs:extension>\r
 273     </xs:complexContent>\r
 274   </xs:complexType>    \r
 275     \r
 276   <xs:complexType name="UserIntegratedIMPGeneratePasswordRequest">\r
 277     <xs:annotation>\r
 278       <xs:documentation>\r
 279         Generate a new IMP password for the user. The new generated password is synchronized to the service Messaging Server.\r
 280         The response is either a SuccessResponse or an ErrorResponse.\r
 281       </xs:documentation>\r
 282     </xs:annotation>\r
 283     <xs:complexContent>\r
 284       <xs:extension base="core:OCIRequest">\r
 285         <xs:sequence>\r
 286           <xs:element name="userId" type="UserId"/>\r
 287         </xs:sequence>\r
 288       </xs:extension>\r
 289     </xs:complexContent>\r
 290   </xs:complexType>    \r
 291     \r
 292 </xs:schema>\r