share/OCISchemaAS/Services/OCISchemaServiceSeriesCompletion.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 I E S   C O M P L E T I O N  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   <!-- S E R I E S   C O M P L E T I O N    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     GroupSeriesCompletionAddInstanceRequest    \r
  36     GroupSeriesCompletionDeleteInstanceRequest    \r
  37     GroupSeriesCompletionGetAvailableUserListRequest    \r
  38     GroupSeriesCompletionGetInstanceListRequest    \r
  39     GroupSeriesCompletionGetInstanceRequest    \r
  40     GroupSeriesCompletionModifyInstanceRequest    \r
  41     UserSeriesCompletionGetRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="GroupSeriesCompletionAddInstanceRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Adds a Series Completion group.\r
  49         The response is either SuccessResponse or 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:element name="name" type="ServiceInstanceName"/>\r
  58           <xs:element name="userId" type="UserId" minOccurs="0" maxOccurs="unbounded"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="GroupSeriesCompletionDeleteInstanceRequest">\r
  65     <xs:annotation>\r
  66       <xs:documentation>\r
  67         Deletes a Series Completion group.\r
  68         The response is either SuccessResponse or 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="serviceProviderId" type="ServiceProviderId"/>\r
  75           <xs:element name="groupId" type="GroupId"/>\r
  76           <xs:element name="name" type="ServiceInstanceName"/>\r
  77         </xs:sequence>\r
  78       </xs:extension>\r
  79     </xs:complexContent>\r
  80   </xs:complexType>    \r
  81     \r
  82   <xs:complexType name="GroupSeriesCompletionGetAvailableUserListRequest">\r
  83     <xs:annotation>\r
  84       <xs:documentation>\r
  85         Get a list of users that can be assigned to a Series Completion group.\r
  86         The available user list for a new Series Completion group can be obtained\r
  87         by not setting the name.\r
  88         The response is either GroupSeriesCompletionGetAvailableUserListResponse or ErrorResponse.\r
  89       </xs:documentation>\r
  90     </xs:annotation>\r
  91     <xs:complexContent>\r
  92       <xs:extension base="core:OCIRequest">\r
  93         <xs:sequence>\r
  94           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  95           <xs:element name="groupId" type="GroupId"/>\r
  96           <xs:element name="name" type="ServiceInstanceName" minOccurs="0"/>\r
  97           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
  98           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
  99           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 100           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
 101           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 102           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 103           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 104         </xs:sequence>\r
 105       </xs:extension>\r
 106     </xs:complexContent>\r
 107   </xs:complexType>    \r
 108     \r
 109   <xs:complexType name="GroupSeriesCompletionGetAvailableUserListResponse">\r
 110     <xs:annotation>\r
 111       <xs:documentation>\r
 112         Response to the GroupSeriesCompletionGetAvailableUserListRequest.\r
 113         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 114         "Phone Number", "Extension", "Department", "Email Address".\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="userTable" type="core:OCITable"/>\r
 121         </xs:sequence>\r
 122       </xs:extension>\r
 123     </xs:complexContent>\r
 124   </xs:complexType>    \r
 125     \r
 126   <xs:complexType name="GroupSeriesCompletionGetInstanceListRequest">\r
 127     <xs:annotation>\r
 128       <xs:documentation>\r
 129         Request to get a list of Series Completion instances within a group.\r
 130         The response is either GroupSeriesCompletionGetInstanceListResponse or ErrorResponse.\r
 131       </xs:documentation>\r
 132     </xs:annotation>\r
 133     <xs:complexContent>\r
 134       <xs:extension base="core:OCIRequest">\r
 135         <xs:sequence>\r
 136           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 137           <xs:element name="groupId" type="GroupId"/>\r
 138         </xs:sequence>\r
 139       </xs:extension>\r
 140     </xs:complexContent>\r
 141   </xs:complexType>    \r
 142     \r
 143   <xs:complexType name="GroupSeriesCompletionGetInstanceListResponse">\r
 144     <xs:annotation>\r
 145       <xs:documentation>\r
 146         Response to the GroupSeriesCompletionGetInstanceListRequest.\r
 147       </xs:documentation>\r
 148     </xs:annotation>\r
 149     <xs:complexContent>\r
 150       <xs:extension base="core:OCIDataResponse">\r
 151         <xs:sequence>\r
 152           <xs:element name="name" type="ServiceInstanceName" minOccurs="0" maxOccurs="unbounded"/>\r
 153         </xs:sequence>\r
 154       </xs:extension>\r
 155     </xs:complexContent>\r
 156   </xs:complexType>    \r
 157     \r
 158   <xs:complexType name="GroupSeriesCompletionGetInstanceRequest">\r
 159     <xs:annotation>\r
 160       <xs:documentation>\r
 161         Gets a Series Completion group.\r
 162         The response is either GroupSeriesCompletionGetInstanceResponse or ErrorResponse.\r
 163       </xs:documentation>\r
 164     </xs:annotation>\r
 165     <xs:complexContent>\r
 166       <xs:extension base="core:OCIRequest">\r
 167         <xs:sequence>\r
 168           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 169           <xs:element name="groupId" type="GroupId"/>\r
 170           <xs:element name="name" type="ServiceInstanceName"/>\r
 171         </xs:sequence>\r
 172       </xs:extension>\r
 173     </xs:complexContent>\r
 174   </xs:complexType>    \r
 175     \r
 176   <xs:complexType name="GroupSeriesCompletionGetInstanceResponse">\r
 177     <xs:annotation>\r
 178       <xs:documentation>\r
 179         Response to the GroupSeriesCompletionGetInstanceRequest.\r
 180         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 181         "Phone Number", "Extension", "Department", "Email Address".\r
 182       </xs:documentation>\r
 183     </xs:annotation>\r
 184     <xs:complexContent>\r
 185       <xs:extension base="core:OCIDataResponse">\r
 186         <xs:sequence>\r
 187           <xs:element name="userTable" type="core:OCITable"/>\r
 188         </xs:sequence>\r
 189       </xs:extension>\r
 190     </xs:complexContent>\r
 191   </xs:complexType>    \r
 192     \r
 193   <xs:complexType name="GroupSeriesCompletionModifyInstanceRequest">\r
 194     <xs:annotation>\r
 195       <xs:documentation>\r
 196         Modifies a Series Completion group. Replaces the entire list of users in the group.\r
 197         The response is either SuccessResponse or ErrorResponse.\r
 198       </xs:documentation>\r
 199     </xs:annotation>\r
 200     <xs:complexContent>\r
 201       <xs:extension base="core:OCIRequest">\r
 202         <xs:sequence>\r
 203           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 204           <xs:element name="groupId" type="GroupId"/>\r
 205           <xs:element name="name" type="ServiceInstanceName"/>\r
 206           <xs:element name="newName" type="ServiceInstanceName" minOccurs="0"/>\r
 207           <xs:element name="userIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 208         </xs:sequence>\r
 209       </xs:extension>\r
 210     </xs:complexContent>\r
 211   </xs:complexType>    \r
 212     \r
 213   <xs:complexType name="UserSeriesCompletionGetRequest">\r
 214     <xs:annotation>\r
 215       <xs:documentation>\r
 216         Gets the details of the Series Completion group that a user belongs to (if any).\r
 217         Any user can only belong to one Series Completion group.\r
 218         The response is either UserSeriesCompletionGetResponse or ErrorResponse.\r
 219       </xs:documentation>\r
 220     </xs:annotation>\r
 221     <xs:complexContent>\r
 222       <xs:extension base="core:OCIRequest">\r
 223         <xs:sequence>\r
 224           <xs:element name="userId" type="UserId"/>\r
 225         </xs:sequence>\r
 226       </xs:extension>\r
 227     </xs:complexContent>\r
 228   </xs:complexType>    \r
 229     \r
 230   <xs:complexType name="UserSeriesCompletionGetResponse">\r
 231     <xs:annotation>\r
 232       <xs:documentation>\r
 233         Response to the UserSeriesCompletionGetRequest.\r
 234         Identifies which Series Completion group the user belongs to and the list of users in the group.\r
 235         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", \r
 236         "Hiragana First Name", "Department", "Phone Number", "Extension", "Email Address".\r
 237       </xs:documentation>\r
 238     </xs:annotation>\r
 239     <xs:complexContent>\r
 240       <xs:extension base="core:OCIDataResponse">\r
 241         <xs:sequence>\r
 242           <xs:element name="name" type="ServiceInstanceName" minOccurs="0"/>\r
 243           <xs:element name="userTable" type="core:OCITable"/>\r
 244         </xs:sequence>\r
 245       </xs:extension>\r
 246     </xs:complexContent>\r
 247   </xs:complexType>    \r
 248     \r
 249 </xs:schema>\r