share/OCISchemaAS/Services/OCISchemaServiceServiceScripts.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 E R V I C E   S C R I P T S  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 E R V I C E   S C R I P T S    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     GroupServiceScriptsGroupClearLogRequest    \r
  35     GroupServiceScriptsGroupGetLogRequest    \r
  36     GroupServiceScriptsGroupGetRequest    \r
  37     GroupServiceScriptsGroupModifyRequest    \r
  38     UserServiceScriptsUserClearLogRequest    \r
  39     UserServiceScriptsUserGetLogRequest    \r
  40     UserServiceScriptsUserGetRequest    \r
  41     UserServiceScriptsUserModifyRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="GroupServiceScriptsGroupClearLogRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Clear the Service Script Group Log.\r
  49         The response is either a SuccessResponse 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:element name="groupId" type="GroupId"/>\r
  57         </xs:sequence>\r
  58       </xs:extension>\r
  59     </xs:complexContent>\r
  60   </xs:complexType>    \r
  61     \r
  62   <xs:complexType name="GroupServiceScriptsGroupGetLogRequest">\r
  63     <xs:annotation>\r
  64       <xs:documentation>\r
  65         Request the group level data associated with Service Scripts Group Log.\r
  66         The response is either a GroupServiceScriptsGroupGetLogResponse or an ErrorResponse.\r
  67       </xs:documentation>\r
  68     </xs:annotation>\r
  69     <xs:complexContent>\r
  70       <xs:extension base="core:OCIRequest">\r
  71         <xs:sequence>\r
  72           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  73           <xs:element name="groupId" type="GroupId"/>\r
  74         </xs:sequence>\r
  75       </xs:extension>\r
  76     </xs:complexContent>\r
  77   </xs:complexType>    \r
  78     \r
  79   <xs:complexType name="GroupServiceScriptsGroupGetLogResponse">\r
  80     <xs:annotation>\r
  81       <xs:documentation>\r
  82         Response to GroupServiceScriptsGroupGetLogRequest.\r
  83       </xs:documentation>\r
  84     </xs:annotation>\r
  85     <xs:complexContent>\r
  86       <xs:extension base="core:OCIDataResponse">\r
  87         <xs:sequence>\r
  88           <xs:element name="logContent" type="xs:base64Binary" 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="GroupServiceScriptsGroupGetRequest">\r
  95     <xs:annotation>\r
  96       <xs:documentation>\r
  97         Request the group level data associated with Service Scripts Group Configuration.\r
  98         The response is either a GroupServiceScriptsGroupGetResponse 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="serviceProviderId" type="ServiceProviderId"/>\r
 105           <xs:element name="groupId" type="GroupId"/>\r
 106         </xs:sequence>\r
 107       </xs:extension>\r
 108     </xs:complexContent>\r
 109   </xs:complexType>    \r
 110     \r
 111   <xs:complexType name="GroupServiceScriptsGroupGetResponse">\r
 112     <xs:annotation>\r
 113       <xs:documentation>\r
 114         Response to GroupServiceScriptsGroupGetRequest.\r
 115       </xs:documentation>\r
 116     </xs:annotation>\r
 117     <xs:complexContent>\r
 118       <xs:extension base="core:OCIDataResponse">\r
 119         <xs:sequence>\r
 120           <xs:element name="isActive" type="xs:boolean"/>\r
 121           <xs:element name="scriptName" type="ServiceScriptsName" minOccurs="0"/>\r
 122           <xs:element name="scriptContent" type="xs:base64Binary" minOccurs="0"/>\r
 123         </xs:sequence>\r
 124       </xs:extension>\r
 125     </xs:complexContent>\r
 126   </xs:complexType>    \r
 127     \r
 128   <xs:complexType name="GroupServiceScriptsGroupModifyRequest">\r
 129     <xs:annotation>\r
 130       <xs:documentation>\r
 131         Modify the group level data associated with Service Scripts Configuration.\r
 132         The response is either a SuccessResponse 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="serviceProviderId" type="ServiceProviderId"/>\r
 139           <xs:element name="groupId" type="GroupId"/>\r
 140           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 141           <xs:choice>\r
 142             <xs:element name="scriptFile" type="ServiceScriptsFileResource" minOccurs="0"/>\r
 143             <xs:element name="scriptUrl" type="URL" minOccurs="0"/>\r
 144           </xs:choice>\r
 145         </xs:sequence>\r
 146       </xs:extension>\r
 147     </xs:complexContent>\r
 148   </xs:complexType>    \r
 149     \r
 150   <xs:complexType name="UserServiceScriptsUserClearLogRequest">\r
 151     <xs:annotation>\r
 152       <xs:documentation>\r
 153         Clear the Service Script User Log.\r
 154         The response is either a SuccessResponse or an ErrorResponse.\r
 155       </xs:documentation>\r
 156     </xs:annotation>\r
 157     <xs:complexContent>\r
 158       <xs:extension base="core:OCIRequest">\r
 159         <xs:sequence>\r
 160           <xs:element name="userId" type="UserId"/>\r
 161         </xs:sequence>\r
 162       </xs:extension>\r
 163     </xs:complexContent>\r
 164   </xs:complexType>    \r
 165     \r
 166   <xs:complexType name="UserServiceScriptsUserGetLogRequest">\r
 167     <xs:annotation>\r
 168       <xs:documentation>\r
 169         Request the user level data associated Service Scripts User Log.\r
 170         The response is either a UserServiceScriptsGetUserLogResponse or an ErrorResponse.\r
 171       </xs:documentation>\r
 172     </xs:annotation>\r
 173     <xs:complexContent>\r
 174       <xs:extension base="core:OCIRequest">\r
 175         <xs:sequence>\r
 176           <xs:element name="userId" type="UserId"/>\r
 177         </xs:sequence>\r
 178       </xs:extension>\r
 179     </xs:complexContent>\r
 180   </xs:complexType>    \r
 181     \r
 182   <xs:complexType name="UserServiceScriptsUserGetLogResponse">\r
 183     <xs:annotation>\r
 184       <xs:documentation>\r
 185         Response to UserServiceScriptsUserGetLogRequest.\r
 186       </xs:documentation>\r
 187     </xs:annotation>\r
 188     <xs:complexContent>\r
 189       <xs:extension base="core:OCIDataResponse">\r
 190         <xs:sequence>\r
 191           <xs:element name="logContent" type="xs:base64Binary" minOccurs="0"/>\r
 192         </xs:sequence>\r
 193       </xs:extension>\r
 194     </xs:complexContent>\r
 195   </xs:complexType>    \r
 196     \r
 197   <xs:complexType name="UserServiceScriptsUserGetRequest">\r
 198     <xs:annotation>\r
 199       <xs:documentation>\r
 200         Request the user level data associated with Service Scripts User Configuration.\r
 201         The response is either a UserServiceScriptsUserGetResponse or an ErrorResponse.\r
 202       </xs:documentation>\r
 203     </xs:annotation>\r
 204     <xs:complexContent>\r
 205       <xs:extension base="core:OCIRequest">\r
 206         <xs:sequence>\r
 207           <xs:element name="userId" type="UserId"/>\r
 208         </xs:sequence>\r
 209       </xs:extension>\r
 210     </xs:complexContent>\r
 211   </xs:complexType>    \r
 212     \r
 213   <xs:complexType name="UserServiceScriptsUserGetResponse">\r
 214     <xs:annotation>\r
 215       <xs:documentation>\r
 216         Response to UserServiceScriptsUserGetRequest.\r
 217       </xs:documentation>\r
 218     </xs:annotation>\r
 219     <xs:complexContent>\r
 220       <xs:extension base="core:OCIDataResponse">\r
 221         <xs:sequence>\r
 222           <xs:element name="isActive" type="xs:boolean"/>\r
 223           <xs:element name="scriptName" type="ServiceScriptsName" minOccurs="0"/>\r
 224           <xs:element name="scriptContent" type="xs:base64Binary" minOccurs="0"/>\r
 225         </xs:sequence>\r
 226       </xs:extension>\r
 227     </xs:complexContent>\r
 228   </xs:complexType>    \r
 229     \r
 230   <xs:complexType name="UserServiceScriptsUserModifyRequest">\r
 231     <xs:annotation>\r
 232       <xs:documentation>\r
 233         Modify the user level data associated with Service Scripts User Configuration.\r
 234         The response is either a SuccessResponse or an ErrorResponse.\r
 235       </xs:documentation>\r
 236     </xs:annotation>\r
 237     <xs:complexContent>\r
 238       <xs:extension base="core:OCIRequest">\r
 239         <xs:sequence>\r
 240           <xs:element name="userId" type="UserId"/>\r
 241           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 242           <xs:choice>\r
 243             <xs:element name="scriptFile" type="ServiceScriptsFileResource" minOccurs="0"/>\r
 244             <xs:element name="scriptUrl" type="URL" minOccurs="0"/>\r
 245           </xs:choice>\r
 246         </xs:sequence>\r
 247       </xs:extension>\r
 248     </xs:complexContent>\r
 249   </xs:complexType>    \r
 250     \r
 251   <xs:simpleType name="ServiceScriptsProvisioningMode">\r
 252     <xs:annotation>\r
 253       <xs:documentation>\r
 254         Service Script supported provisioning mode.\r
 255       </xs:documentation>\r
 256     </xs:annotation>\r
 257     <xs:restriction base="xs:token">\r
 258       <xs:enumeration value="Group"/>\r
 259       <xs:enumeration value="User"/>\r
 260     </xs:restriction>\r
 261   </xs:simpleType>    \r
 262     \r
 263   <xs:simpleType name="ServiceScriptsName">\r
 264     <xs:annotation>\r
 265       <xs:documentation>\r
 266         Service Script name.\r
 267       </xs:documentation>\r
 268     </xs:annotation>\r
 269     <xs:restriction base="xs:string">\r
 270       <xs:minLength value="1"/>\r
 271       <xs:maxLength value="256"/>\r
 272     </xs:restriction>\r
 273   </xs:simpleType>    \r
 274     \r
 275   <xs:complexType name="ServiceScriptsFileResource">\r
 276     <xs:annotation>\r
 277       <xs:documentation>\r
 278         Service Scripts File Resource for uploading file content.\r
 279       </xs:documentation>\r
 280     </xs:annotation>\r
 281     <xs:sequence>\r
 282       <xs:element name="fileName" type="FileName"/>\r
 283       <xs:element name="scriptContent" type="xs:base64Binary"/>\r
 284     </xs:sequence>\r
 285   </xs:complexType>    \r
 286     \r
 287 </xs:schema>\r