share/OCISchemaAS/Services/OCISchemaServiceClassMark.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 <!-- C L A S S   M A R K  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   <!-- C L A S S   M A R K    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     SystemClassmarkAddRequest    \r
  36     SystemClassmarkDeleteRequest    \r
  37     SystemClassmarkGetListRequest    \r
  38     SystemClassmarkModifyRequest    \r
  39     SystemClassmarkGetUtilizationListRequest    \r
  40     UserClassmarkGetRequest    \r
  41     UserClassmarkModifyRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="SystemClassmarkAddRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Add a Class Mark to system.\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="classmark" type="Classmark"/>\r
  56           <xs:element name="value" type="ClassmarkValue"/>\r
  57           <xs:element name="webDisplayKey" type="WebDisplayKey" minOccurs="0"/>\r
  58         </xs:sequence>\r
  59       </xs:extension>\r
  60     </xs:complexContent>\r
  61   </xs:complexType>    \r
  62     \r
  63   <xs:complexType name="SystemClassmarkDeleteRequest">\r
  64     <xs:annotation>\r
  65       <xs:documentation>\r
  66         Delete a Class Mark from system. It cannot be deleted if it is in use by any users.\r
  67         The response is either a SuccessResponse or an ErrorResponse.\r
  68       </xs:documentation>\r
  69     </xs:annotation>\r
  70     <xs:complexContent>\r
  71       <xs:extension base="core:OCIRequest">\r
  72         <xs:sequence>\r
  73           <xs:element name="classmark" type="Classmark"/>\r
  74         </xs:sequence>\r
  75       </xs:extension>\r
  76     </xs:complexContent>\r
  77   </xs:complexType>    \r
  78     \r
  79   <xs:complexType name="SystemClassmarkGetListRequest">\r
  80     <xs:annotation>\r
  81       <xs:documentation>\r
  82         Get the list of all Class Mark in system.\r
  83         The response is either a SystemClassmarkGetListResponse 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:extension>\r
  90     </xs:complexContent>\r
  91   </xs:complexType>    \r
  92     \r
  93   <xs:complexType name="SystemClassmarkGetListResponse">\r
  94     <xs:annotation>\r
  95       <xs:documentation>\r
  96         Response to SystemClassmarkGetListRequest. \r
  97         Contains a table of with the column headings: "Class Mark", "Value" and "Web Display Key". \r
  98       </xs:documentation>\r
  99     </xs:annotation>\r
 100     <xs:complexContent>\r
 101       <xs:extension base="core:OCIDataResponse">\r
 102         <xs:sequence>\r
 103           <xs:element name="classmarkTable" type="core:OCITable"/>\r
 104         </xs:sequence>\r
 105       </xs:extension>\r
 106     </xs:complexContent>\r
 107   </xs:complexType>    \r
 108     \r
 109   <xs:complexType name="SystemClassmarkModifyRequest">\r
 110     <xs:annotation>\r
 111       <xs:documentation>\r
 112         Modify a Class Mark in system.\r
 113         The response is either a SuccessResponse or an ErrorResponse.\r
 114       </xs:documentation>\r
 115     </xs:annotation>\r
 116     <xs:complexContent>\r
 117       <xs:extension base="core:OCIRequest">\r
 118         <xs:sequence>\r
 119           <xs:element name="classmark" type="Classmark"/>\r
 120           <xs:element name="value" type="ClassmarkValue" minOccurs="0"/>\r
 121           <xs:element name="webDisplayKey" type="WebDisplayKey" nillable="true" minOccurs="0"/>\r
 122         </xs:sequence>\r
 123       </xs:extension>\r
 124     </xs:complexContent>\r
 125   </xs:complexType>    \r
 126     \r
 127   <xs:complexType name="SystemClassmarkGetUtilizationListRequest">\r
 128     <xs:annotation>\r
 129       <xs:documentation>\r
 130         Get the list of all users associated with a Class Mark in system. It is possible to search by various criteria.\r
 131         Multiple search criteria are logically ANDed together.\r
 132         The response is either a SystemClassmarkGetUtilizationListResponse 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="classmark" type="Classmark"/>\r
 139           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 140           <xs:element name="searchCriteriaGroupId" type="SearchCriteriaGroupId" minOccurs="0" maxOccurs="unbounded"/>\r
 141           <xs:element name="searchCriteriaExactServiceProviderId" type="SearchCriteriaExactServiceProvider" minOccurs="0"/>\r
 142           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 143           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 144           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 145           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 146           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 147         </xs:sequence>\r
 148       </xs:extension>\r
 149     </xs:complexContent>\r
 150   </xs:complexType>    \r
 151     \r
 152   <xs:complexType name="SystemClassmarkGetUtilizationListResponse">\r
 153     <xs:annotation>\r
 154       <xs:documentation>\r
 155         Response to SystemClassmarkGetUtilizationListRequest. \r
 156         Contains a table with the column headings: "User Id", "Group Id", "Service Provider Id",\r
 157         "Last Name", "First Name", and "Phone Number", "Extension", "Department", "Email Address". \r
 158       </xs:documentation>\r
 159     </xs:annotation>\r
 160     <xs:complexContent>\r
 161       <xs:extension base="core:OCIDataResponse">\r
 162         <xs:sequence>\r
 163           <xs:element name="classmarkUserTable" type="core:OCITable"/>\r
 164         </xs:sequence>\r
 165       </xs:extension>\r
 166     </xs:complexContent>\r
 167   </xs:complexType>    \r
 168     \r
 169   <xs:complexType name="UserClassmarkGetRequest">\r
 170     <xs:annotation>\r
 171       <xs:documentation>\r
 172         Request the Class Mark data associated with User.\r
 173         The response is either a UserClassmarkGetResponse or an ErrorResponse.\r
 174       </xs:documentation>\r
 175     </xs:annotation>\r
 176     <xs:complexContent>\r
 177       <xs:extension base="core:OCIRequest">\r
 178         <xs:sequence>\r
 179           <xs:element name="userId" type="UserId"/>\r
 180         </xs:sequence>\r
 181       </xs:extension>\r
 182     </xs:complexContent>\r
 183   </xs:complexType>    \r
 184     \r
 185   <xs:complexType name="UserClassmarkGetResponse">\r
 186     <xs:annotation>\r
 187       <xs:documentation>\r
 188         Response to UserClassmarkGetRequest.\r
 189         Contains the Class Mark data\r
 190       </xs:documentation>\r
 191     </xs:annotation>\r
 192     <xs:complexContent>\r
 193       <xs:extension base="core:OCIDataResponse">\r
 194         <xs:sequence>\r
 195           <xs:element name="classmark" type="Classmark" minOccurs="0"/>\r
 196         </xs:sequence>\r
 197       </xs:extension>\r
 198     </xs:complexContent>\r
 199   </xs:complexType>    \r
 200     \r
 201   <xs:complexType name="UserClassmarkModifyRequest">\r
 202     <xs:annotation>\r
 203       <xs:documentation>\r
 204         Modify the user level data associated with Class Mark.\r
 205         The response is either a SuccessResponse or an ErrorResponse.\r
 206       </xs:documentation>\r
 207     </xs:annotation>\r
 208     <xs:complexContent>\r
 209       <xs:extension base="core:OCIRequest">\r
 210         <xs:sequence>\r
 211           <xs:element name="userId" type="UserId"/>\r
 212           <xs:element name="classmark" type="Classmark" 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="Classmark">\r
 219     <xs:annotation>\r
 220       <xs:documentation>\r
 221         Name for the Class Mark.\r
 222       </xs:documentation>\r
 223     </xs:annotation>\r
 224     <xs:restriction base="xs:token">\r
 225       <xs:minLength value="1"/>\r
 226       <xs:maxLength value="40"/>\r
 227     </xs:restriction>\r
 228   </xs:simpleType>    \r
 229     \r
 230   <xs:simpleType name="ClassmarkValue">\r
 231     <xs:annotation>\r
 232       <xs:documentation>\r
 233         Value for the Class Mark used in signaling.\r
 234       </xs:documentation>\r
 235     </xs:annotation>\r
 236     <xs:restriction base="xs:token">\r
 237       <xs:minLength value="1"/>\r
 238       <xs:maxLength value="32"/>\r
 239     </xs:restriction>\r
 240   </xs:simpleType>    \r
 241     \r
 242 </xs:schema>\r