share/OCISchemaAS/Services/OCISchemaServiceSharedCallAppearance.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 <!-- S H A R E D   C A L L   A P P E A R A N C E  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   <!-- S H A R E D   C A L L   A P P E A R A N C E                                        -->\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     UserSharedCallAppearanceAddEndpointRequest14sp2    \r
  36     UserSharedCallAppearanceDeleteEndpointListRequest14    \r
  37     UserSharedCallAppearanceGetEndpointRequest    \r
  38     UserSharedCallAppearanceGetRequest16sp2    \r
  39     UserSharedCallAppearanceModifyEndpointRequest    \r
  40     UserSharedCallAppearanceModifyRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="UserSharedCallAppearanceAddEndpointRequest14sp2">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47         Associate an access device instance to the user's Shared Call Appearance.\r
  48         The response is either a SuccessResponse 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:element name="accessDeviceEndpoint" type="AccessDeviceEndpointAdd"/>\r
  56           <xs:element name="isActive" type="xs:boolean"/>\r
  57           <xs:element name="allowOrigination" type="xs:boolean"/>\r
  58           <xs:element name="allowTermination" type="xs:boolean"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="UserSharedCallAppearanceDeleteEndpointListRequest14">\r
  65     <xs:annotation>\r
  66       <xs:documentation>\r
  67         Disassociate one or more of a user's Shared Call Appearance endpoints.\r
  68         The response is either a SuccessResponse or an ErrorResponse.\r
  69       </xs:documentation>\r
  70     </xs:annotation>\r
  71     <xs:complexContent>\r
  72       <xs:extension base="core:OCIRequest">\r
  73         <xs:sequence>\r
  74           <xs:element name="userId" type="UserId"/>\r
  75           <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointKey" minOccurs="1" maxOccurs="unbounded"/>\r
  76         </xs:sequence>\r
  77       </xs:extension>\r
  78     </xs:complexContent>\r
  79   </xs:complexType>    \r
  80     \r
  81   <xs:complexType name="UserSharedCallAppearanceGetEndpointRequest">\r
  82     <xs:annotation>\r
  83       <xs:documentation>\r
  84         Get the user's Shared Call Appearance endpoint setting.\r
  85         The response is either a UserSharedCallAppearanceGetEndpointResponse or an ErrorResponse.\r
  86       </xs:documentation>\r
  87     </xs:annotation>\r
  88     <xs:complexContent>\r
  89       <xs:extension base="core:OCIRequest">\r
  90         <xs:sequence>\r
  91           <xs:element name="userId" type="UserId"/>\r
  92           <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointKey"/>\r
  93         </xs:sequence>\r
  94       </xs:extension>\r
  95     </xs:complexContent>\r
  96   </xs:complexType>    \r
  97     \r
  98   <xs:complexType name="UserSharedCallAppearanceGetEndpointResponse">\r
  99     <xs:annotation>\r
 100       <xs:documentation>\r
 101         Response to the UserSharedCallAppearanceGetEndpointRequest.\r
 102       </xs:documentation>\r
 103     </xs:annotation>\r
 104     <xs:complexContent>\r
 105       <xs:extension base="core:OCIDataResponse">\r
 106         <xs:sequence>\r
 107           <xs:element name="isActive" type="xs:boolean"/>\r
 108           <xs:element name="allowOrigination" type="xs:boolean"/>\r
 109           <xs:element name="allowTermination" type="xs:boolean"/>\r
 110         </xs:sequence>\r
 111       </xs:extension>\r
 112     </xs:complexContent>\r
 113   </xs:complexType>    \r
 114     \r
 115   <xs:complexType name="UserSharedCallAppearanceGetRequest16sp2">\r
 116     <xs:annotation>\r
 117       <xs:documentation>\r
 118         Get the user's Shared Call Appearance service setting.\r
 119         The response is either a UserSharedCallAppearanceGetResponse16sp2 or an ErrorResponse.\r
 120       </xs:documentation>\r
 121     </xs:annotation>\r
 122     <xs:complexContent>\r
 123       <xs:extension base="core:OCIRequest">\r
 124         <xs:sequence>\r
 125           <xs:element name="userId" type="UserId"/>\r
 126         </xs:sequence>\r
 127       </xs:extension>\r
 128     </xs:complexContent>\r
 129   </xs:complexType>    \r
 130     \r
 131   <xs:complexType name="UserSharedCallAppearanceGetResponse16sp2">\r
 132     <xs:annotation>\r
 133       <xs:documentation>\r
 134         Response to the UserSharedCallAppearanceGetRequest16sp2.\r
 135         The endpointTable contains columns:\r
 136           "Device Level", "Device Name", "Device Type", "Line/Port", "SIP Contact", "Port Number", "Device Support Visual Device Management".\r
 137         The "Device Level" column contains one of the AccessDeviceLevel enumerated constants.\r
 138         Port numbers are only used by devices with static line ordering.\r
 139 \r
 140         The following elements are only used in AS data mode:\r
 141          enableCallParkNotification\r
 142       </xs:documentation>\r
 143     </xs:annotation>\r
 144     <xs:complexContent>\r
 145       <xs:extension base="core:OCIDataResponse">\r
 146         <xs:sequence>\r
 147           <xs:element name="alertAllAppearancesForClickToDialCalls" type="xs:boolean"/>\r
 148           <xs:element name="alertAllAppearancesForGroupPagingCalls" type="xs:boolean"/>\r
 149           <xs:element name="maxAppearances" type="SharedCallAppearanceMaximumAppearances"/>\r
 150           <xs:element name="allowSCACallRetrieve" type="xs:boolean"/>\r
 151           <xs:element name="enableMultipleCallArrangement" type="xs:boolean"/>\r
 152           <xs:element name="multipleCallArrangementIsActive" type="xs:boolean"/>\r
 153           <xs:element name="endpointTable" type="core:OCITable"/>\r
 154           <xs:element name="allowBridgingBetweenLocations" type="xs:boolean"/>\r
 155           <xs:element name="bridgeWarningTone" type="SharedCallAppearanceBridgeWarningTone"/>\r
 156           <xs:element name="enableCallParkNotification" type="xs:boolean"/>\r
 157         </xs:sequence>\r
 158       </xs:extension>\r
 159     </xs:complexContent>\r
 160   </xs:complexType>    \r
 161     \r
 162   <xs:complexType name="UserSharedCallAppearanceModifyEndpointRequest">\r
 163     <xs:annotation>\r
 164       <xs:documentation>\r
 165          Associate/Disassociate an access device instance to the user's Shared Call Appearance.\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="userId" type="UserId"/>\r
 173           <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointKey"/>\r
 174           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 175           <xs:element name="allowOrigination" type="xs:boolean" minOccurs="0"/>\r
 176           <xs:element name="allowTermination" type="xs:boolean" minOccurs="0"/>\r
 177         </xs:sequence>\r
 178       </xs:extension>\r
 179     </xs:complexContent>\r
 180   </xs:complexType>    \r
 181     \r
 182   <xs:complexType name="UserSharedCallAppearanceModifyRequest">\r
 183     <xs:annotation>\r
 184       <xs:documentation>\r
 185         Modify the user's Shared Call Appearance service setting.\r
 186         The response is either a SuccessResponse or an ErrorResponse.\r
 187         \r
 188         The following elements are only used in AS data mode:\r
 189          enableCallParkNotification\r
 190       </xs:documentation>\r
 191     </xs:annotation>\r
 192     <xs:complexContent>\r
 193       <xs:extension base="core:OCIRequest">\r
 194         <xs:sequence>\r
 195           <xs:element name="userId" type="UserId"/>\r
 196           <xs:element name="alertAllAppearancesForClickToDialCalls" type="xs:boolean" minOccurs="0"/>\r
 197           <xs:element name="alertAllAppearancesForGroupPagingCalls" type="xs:boolean" minOccurs="0"/>\r
 198           <xs:element name="allowSCACallRetrieve" type="xs:boolean" minOccurs="0"/>\r
 199           <xs:element name="multipleCallArrangementIsActive" type="xs:boolean" minOccurs="0"/>\r
 200           <xs:element name="allowBridgingBetweenLocations" type="xs:boolean" minOccurs="0"/>\r
 201           <xs:element name="bridgeWarningTone" type="SharedCallAppearanceBridgeWarningTone" minOccurs="0"/>\r
 202           <xs:element name="enableCallParkNotification" type="xs:boolean" minOccurs="0"/>\r
 203         </xs:sequence>\r
 204       </xs:extension>\r
 205     </xs:complexContent>\r
 206   </xs:complexType>    \r
 207     \r
 208 </xs:schema>\r