share/OCISchemaAS/Services/OCISchemaServiceMaliciousCallTrace.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 <!-- M A L I C I O U S   C A L L   T R A 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   <!-- M A L I C I O U S   C A L L   T R A 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     ServiceProviderMaliciousCallTraceGetRequest    \r
  36     ServiceProviderMaliciousCallTraceModifyRequest    \r
  37     SystemMaliciousCallTraceGetRequest    \r
  38     SystemMaliciousCallTraceModifyRequest    \r
  39     UserMaliciousCallTraceGetRequest    \r
  40     UserMaliciousCallTraceModifyRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="ServiceProviderMaliciousCallTraceGetRequest">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47         Get the service provider's Malicious Call Trace settings.\r
  48         The response is either a ServiceProviderMaliciousCallTraceGetResponse \r
  49         or an ErrorResponse.\r
  50       </xs:documentation>\r
  51     </xs:annotation>\r
  52     <xs:complexContent>\r
  53       <xs:extension base="core:OCIRequest">\r
  54         <xs:sequence>\r
  55           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  56         </xs:sequence>\r
  57       </xs:extension>\r
  58     </xs:complexContent>\r
  59   </xs:complexType>    \r
  60     \r
  61   <xs:complexType name="ServiceProviderMaliciousCallTraceGetResponse">\r
  62     <xs:annotation>\r
  63       <xs:documentation>\r
  64         Response to the ServiceProviderMaliciousCallTraceGetRequest.\r
  65         The response contains the service provider Malicious Call Trace \r
  66         settings. \r
  67       </xs:documentation>\r
  68     </xs:annotation>\r
  69     <xs:complexContent>\r
  70       <xs:extension base="core:OCIDataResponse">\r
  71         <xs:sequence>\r
  72           <xs:element name="useSystemPlayMCTWarningAnnouncement" type="xs:boolean"/>\r
  73           <xs:element name="playMCTWarningAnnouncement" type="xs:boolean"/>\r
  74         </xs:sequence>\r
  75       </xs:extension>\r
  76     </xs:complexContent>\r
  77   </xs:complexType>    \r
  78     \r
  79   <xs:complexType name="ServiceProviderMaliciousCallTraceModifyRequest">\r
  80     <xs:annotation>\r
  81       <xs:documentation>\r
  82         Modify the service provider's Malicious Call Trace settings.\r
  83         The response is either a SuccessResponse or an ErrorResponse.\r
  84       </xs:documentation>\r
  85     </xs:annotation>\r
  86     <xs:complexContent>\r
  87       <xs:extension base="core:OCIRequest">\r
  88         <xs:sequence>\r
  89           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  90           <xs:element name="useSystemPlayMCTWarningAnnouncement" type="xs:boolean" minOccurs="0"/>\r
  91           <xs:element name="playMCTWarningAnnouncement" type="xs:boolean" minOccurs="0"/>\r
  92         </xs:sequence>\r
  93       </xs:extension>\r
  94     </xs:complexContent>\r
  95   </xs:complexType>    \r
  96     \r
  97   <xs:complexType name="SystemMaliciousCallTraceGetRequest">\r
  98     <xs:annotation>\r
  99       <xs:appinfo>\r
 100         <asDataModeSupported>true</asDataModeSupported>\r
 101         <hssDataModeSupported>false</hssDataModeSupported>\r
 102       </xs:appinfo>\r
 103       <xs:documentation>\r
 104         Get Malicious Call Trace system parameters and the list of users that use the \r
 105         Malicious Call Trace feature.\r
 106         The response is either a SystemMaliciousCallTraceGetResponse or \r
 107         an ErrorResponse.\r
 108       </xs:documentation>\r
 109     </xs:annotation>\r
 110     <xs:complexContent>\r
 111       <xs:extension base="core:OCIRequest">\r
 112         <xs:sequence/>\r
 113       </xs:extension>\r
 114     </xs:complexContent>\r
 115   </xs:complexType>    \r
 116     \r
 117   <xs:complexType name="SystemMaliciousCallTraceGetResponse">\r
 118     <xs:annotation>\r
 119       <xs:appinfo>\r
 120         <asDataModeSupported>true</asDataModeSupported>\r
 121         <hssDataModeSupported>false</hssDataModeSupported>\r
 122       </xs:appinfo>\r
 123       <xs:documentation>\r
 124         Response to the SystemMaliciousCallTraceGetRequest.\r
 125         The response contains the Malicious Call Trace system parameters and the list of users\r
 126         that use the Malicious Call Trace feature.\r
 127 \r
 128         The column headings are "Service Provider Id",\r
 129         "Group Id", "User Id", "Last Name", "First Name", "Phone Number", "Trace Type", "Status",\r
 130         "Hiragana Last Name" and "Hiragana First Name", "Extension", "Department", "Email Address".\r
 131       </xs:documentation>\r
 132     </xs:annotation>\r
 133     <xs:complexContent>\r
 134       <xs:extension base="core:OCIDataResponse">\r
 135         <xs:sequence>\r
 136           <xs:element name="playMCTWarningAnnouncement" type="xs:boolean"/>\r
 137           <xs:element name="userTable" type="core:OCITable"/>\r
 138         </xs:sequence>\r
 139       </xs:extension>\r
 140     </xs:complexContent>\r
 141   </xs:complexType>    \r
 142     \r
 143   <xs:complexType name="SystemMaliciousCallTraceModifyRequest">\r
 144     <xs:annotation>\r
 145       <xs:appinfo>\r
 146         <asDataModeSupported>true</asDataModeSupported>\r
 147         <hssDataModeSupported>false</hssDataModeSupported>\r
 148       </xs:appinfo>\r
 149       <xs:documentation>\r
 150         Modify a Malicious Call Trace system parameter.\r
 151         The response is either a SuccessResponse or an ErrorResponse.\r
 152       </xs:documentation>\r
 153     </xs:annotation>\r
 154     <xs:complexContent>\r
 155       <xs:extension base="core:OCIRequest">\r
 156         <xs:sequence>\r
 157           <xs:element name="playMCTWarningAnnouncement" type="xs:boolean" minOccurs="0"/>\r
 158         </xs:sequence>\r
 159       </xs:extension>\r
 160     </xs:complexContent>\r
 161   </xs:complexType>    \r
 162     \r
 163   <xs:complexType name="UserMaliciousCallTraceGetRequest">\r
 164     <xs:annotation>\r
 165       <xs:documentation>\r
 166         Request the user level data associated with Malicious Call Trace.\r
 167         The response is either a UserMaliciousCallTraceGetResponse or an\r
 168         ErrorResponse.\r
 169       </xs:documentation>\r
 170     </xs:annotation>\r
 171     <xs:complexContent>\r
 172       <xs:extension base="core:OCIRequest">\r
 173         <xs:sequence>\r
 174           <xs:element name="userId" type="UserId"/>\r
 175         </xs:sequence>\r
 176       </xs:extension>\r
 177     </xs:complexContent>\r
 178   </xs:complexType>    \r
 179     \r
 180   <xs:complexType name="UserMaliciousCallTraceGetResponse">\r
 181     <xs:annotation>\r
 182       <xs:documentation>\r
 183         Response to UserMaliciousCallTraceGetRequest.\r
 184       </xs:documentation>\r
 185     </xs:annotation>\r
 186     <xs:complexContent>\r
 187       <xs:extension base="core:OCIDataResponse">\r
 188         <xs:sequence>\r
 189           <xs:element name="isActive" type="xs:boolean"/>\r
 190           <xs:element name="traceTypeSelection" type="MaliciousCallTraceCallTypeSelection"/>\r
 191           <xs:element name="traceForTimePeriod" type="xs:boolean"/>\r
 192           <xs:element name="traceTimePeriod" type="MaliciousCallTraceTimePeriod" minOccurs="0"/>\r
 193         </xs:sequence>\r
 194       </xs:extension>\r
 195     </xs:complexContent>\r
 196   </xs:complexType>    \r
 197     \r
 198   <xs:complexType name="UserMaliciousCallTraceModifyRequest">\r
 199     <xs:annotation>\r
 200       <xs:documentation>\r
 201         Modify the user level data associated with Malicious Call Trace.\r
 202         The response is either a SuccessResponse or an ErrorResponse.\r
 203       </xs:documentation>\r
 204     </xs:annotation>\r
 205     <xs:complexContent>\r
 206       <xs:extension base="core:OCIRequest">\r
 207         <xs:sequence>\r
 208           <xs:element name="userId" type="UserId"/>\r
 209           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 210           <xs:element name="traceTypeSelection" type="MaliciousCallTraceCallTypeSelection" minOccurs="0"/>\r
 211           <xs:element name="traceForTimePeriod" type="xs:boolean" minOccurs="0"/>\r
 212           <xs:element name="traceTimePeriod" type="MaliciousCallTraceTimePeriod" nillable="true" minOccurs="0"/>\r
 213         </xs:sequence>\r
 214       </xs:extension>\r
 215     </xs:complexContent>\r
 216   </xs:complexType>    \r
 217     \r
 218   <xs:simpleType name="MaliciousCallTraceCallTypeSelection">\r
 219     <xs:annotation>\r
 220       <xs:documentation>\r
 221         Call Types that are traced for malicious calls\r
 222       </xs:documentation>\r
 223     </xs:annotation>\r
 224     <xs:restriction base="xs:token">\r
 225       <xs:enumeration value="All Incoming"/>\r
 226       <xs:enumeration value="Answered Incoming"/>\r
 227       <xs:enumeration value="All Incoming And Outgoing"/>\r
 228     </xs:restriction>\r
 229   </xs:simpleType>    \r
 230     \r
 231   <xs:complexType name="MaliciousCallTraceTimePeriod">\r
 232     <xs:annotation>\r
 233       <xs:documentation>\r
 234         Modify the user level data associated with Malicious Call Trace.\r
 235         The response is either a SuccessResponse or an ErrorResponse.\r
 236       </xs:documentation>\r
 237     </xs:annotation>\r
 238     <xs:sequence>\r
 239       <xs:element name="startDateTime" type="xs:dateTime"/>\r
 240       <xs:element name="stopDateTime" type="xs:dateTime"/>\r
 241     </xs:sequence>\r
 242   </xs:complexType>    \r
 243     \r
 244 </xs:schema>\r