share/OCISchemaAS/Services/OCISchemaServiceAccountAuthorizationCodes.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 <!-- A C C O U N T   A U T H O R I Z A T I O N   C O D E 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   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- A C C O U N T   A U T H O R I Z A T I O N   C O D E S                              -->\r
  28   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  29   <!-- ********************************************************************************** -->\r
  30   <!--\r
  31   Requests and responses are listed here in alphabetical order.\r
  32   The non-primitive attributes inside the commands are defined in another\r
  33   section of the schema.\r
  34 \r
  35   Requests in this schema file:\r
  36     GroupAccountAuthorizationCodesAddListRequest    \r
  37     GroupAccountAuthorizationCodesDeleteListRequest    \r
  38     GroupAccountAuthorizationCodesGetAvailableUserListRequest    \r
  39     GroupAccountAuthorizationCodesGetListRequest    \r
  40     GroupAccountAuthorizationCodesGetRequest    \r
  41     GroupAccountAuthorizationCodesModifyRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="GroupAccountAuthorizationCodesAddListRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Add a list of account/authorization codes to a group.\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:element name="codeEntry" type="AccountAuthorizationCodeEntry" maxOccurs="unbounded"/>\r
  58         </xs:sequence>\r
  59       </xs:extension>\r
  60     </xs:complexContent>\r
  61   </xs:complexType>    \r
  62     \r
  63   <xs:complexType name="GroupAccountAuthorizationCodesDeleteListRequest">\r
  64     <xs:annotation>\r
  65       <xs:documentation>\r
  66         Delete a list of account/authorization codes from a group.\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="serviceProviderId" type="ServiceProviderId"/>\r
  74           <xs:element name="groupId" type="GroupId"/>\r
  75           <xs:element name="code" type="AccountAuthorizationCode" 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="GroupAccountAuthorizationCodesGetAvailableUserListRequest">\r
  82     <xs:annotation>\r
  83       <xs:documentation>\r
  84         Get a list of non restricted users for the account/authorization codes service.\r
  85         The response is either GroupAccountAuthorizationCodesGetAvailableUserListResponse or 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="serviceProviderId" type="ServiceProviderId"/>\r
  92           <xs:element name="groupId" type="GroupId"/>\r
  93           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
  94           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
  95           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
  96           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
  97           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
  98           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
  99           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 100         </xs:sequence>\r
 101       </xs:extension>\r
 102     </xs:complexContent>\r
 103   </xs:complexType>    \r
 104     \r
 105   <xs:complexType name="GroupAccountAuthorizationCodesGetAvailableUserListResponse">\r
 106     <xs:annotation>\r
 107       <xs:documentation>\r
 108         Response to the GroupAccountAuthorizationCodesGetAvailableUserListRequest.\r
 109         The column headings are: "User Id", "Last Name", "First Name", "Hiragana Last Name" and\r
 110         "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".\r
 111       </xs:documentation>\r
 112     </xs:annotation>\r
 113     <xs:complexContent>\r
 114       <xs:extension base="core:OCIDataResponse">\r
 115         <xs:sequence>\r
 116           <xs:element name="userTable" type="core:OCITable"/>\r
 117         </xs:sequence>\r
 118       </xs:extension>\r
 119     </xs:complexContent>\r
 120   </xs:complexType>    \r
 121     \r
 122   <xs:complexType name="GroupAccountAuthorizationCodesGetListRequest">\r
 123     <xs:annotation>\r
 124       <xs:documentation>\r
 125         Request the list of account/authorization codes for a group.\r
 126         The response is either a GroupAccountAuthorizationCodesGetListResponse or an ErrorResponse.\r
 127       </xs:documentation>\r
 128     </xs:annotation>\r
 129     <xs:complexContent>\r
 130       <xs:extension base="core:OCIRequest">\r
 131         <xs:sequence>\r
 132           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 133           <xs:element name="groupId" type="GroupId"/>\r
 134         </xs:sequence>\r
 135       </xs:extension>\r
 136     </xs:complexContent>\r
 137   </xs:complexType>    \r
 138     \r
 139   <xs:complexType name="GroupAccountAuthorizationCodesGetListResponse">\r
 140     <xs:annotation>\r
 141       <xs:documentation>\r
 142         Response to GroupAccountAuthorizationCodesGetListRequest.\r
 143       </xs:documentation>\r
 144     </xs:annotation>\r
 145     <xs:complexContent>\r
 146       <xs:extension base="core:OCIDataResponse">\r
 147         <xs:sequence>\r
 148           <xs:element name="codeEntry" type="AccountAuthorizationCodeEntry" minOccurs="0" maxOccurs="unbounded"/>\r
 149         </xs:sequence>\r
 150       </xs:extension>\r
 151     </xs:complexContent>\r
 152   </xs:complexType>    \r
 153     \r
 154   <xs:complexType name="GroupAccountAuthorizationCodesGetRequest">\r
 155     <xs:annotation>\r
 156       <xs:documentation>\r
 157         Request the group's account/authorization codes setting.\r
 158         The response is either a GroupAccountAuthorizationCodesGetResponse or an ErrorResponse.\r
 159       </xs:documentation>\r
 160     </xs:annotation>\r
 161     <xs:complexContent>\r
 162       <xs:extension base="core:OCIRequest">\r
 163         <xs:sequence>\r
 164           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 165           <xs:element name="groupId" type="GroupId"/>\r
 166         </xs:sequence>\r
 167       </xs:extension>\r
 168     </xs:complexContent>\r
 169   </xs:complexType>    \r
 170     \r
 171   <xs:complexType name="GroupAccountAuthorizationCodesGetResponse">\r
 172     <xs:annotation>\r
 173       <xs:documentation>\r
 174         Response to GroupAccountAuthorizationCodesGetRequest.\r
 175         The tables has the following column headings:\r
 176         "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 177         "Phone Number", "Extension", "Department", "Email Address".\r
 178       </xs:documentation>\r
 179     </xs:annotation>\r
 180     <xs:complexContent>\r
 181       <xs:extension base="core:OCIDataResponse">\r
 182         <xs:sequence>\r
 183           <xs:element name="type" type="AccountAuthorizationCodeType"/>\r
 184           <xs:element name="numberOfDigits" type="AccountAuthorizationCodeNumberOfDigits"/>\r
 185           <xs:element name="allowLocalAndTollFreeCalls" type="xs:boolean"/>\r
 186           <xs:element name="mandatoryUsageUserTable" type="core:OCITable"/>\r
 187           <xs:element name="optionalUsageUserTable" 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="GroupAccountAuthorizationCodesModifyRequest">\r
 194     <xs:annotation>\r
 195       <xs:documentation>\r
 196         Change the group's account/authorization codes setting.\r
 197         The response is either a SuccessResponse or an 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="codeType" type="AccountAuthorizationCodeType" minOccurs="0"/>\r
 206           <xs:element name="numberOfDigits" type="AccountAuthorizationCodeNumberOfDigits" minOccurs="0"/>\r
 207           <xs:element name="allowLocalAndTollFreeCalls" type="xs:boolean" minOccurs="0"/>\r
 208           <xs:element name="mandatoryUsageUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 209           <xs:element name="optionalUsageUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 210         </xs:sequence>\r
 211       </xs:extension>\r
 212     </xs:complexContent>\r
 213   </xs:complexType>    \r
 214     \r
 215   <xs:simpleType name="AccountAuthorizationCode">\r
 216     <xs:annotation>\r
 217       <xs:documentation>\r
 218         Account/Authorization Code.\r
 219       </xs:documentation>\r
 220     </xs:annotation>\r
 221     <xs:restriction base="xs:token">\r
 222       <xs:minLength value="2"/>\r
 223       <xs:maxLength value="14"/>\r
 224     </xs:restriction>\r
 225   </xs:simpleType>    \r
 226     \r
 227   <xs:simpleType name="AccountAuthorizationCodeDescription">\r
 228     <xs:annotation>\r
 229       <xs:documentation>\r
 230         Account/Authorization Code Description.\r
 231       </xs:documentation>\r
 232     </xs:annotation>\r
 233     <xs:restriction base="xs:token">\r
 234       <xs:minLength value="1"/>\r
 235       <xs:maxLength value="80"/>\r
 236     </xs:restriction>\r
 237   </xs:simpleType>    \r
 238     \r
 239   <xs:complexType name="AccountAuthorizationCodeEntry">\r
 240     <xs:annotation>\r
 241       <xs:documentation>\r
 242         Account/Authorization Code.\r
 243       </xs:documentation>\r
 244     </xs:annotation>\r
 245     <xs:sequence>\r
 246       <xs:element name="code" type="AccountAuthorizationCode"/>\r
 247       <xs:element name="description" type="AccountAuthorizationCodeDescription" minOccurs="0"/>\r
 248     </xs:sequence>\r
 249   </xs:complexType>    \r
 250     \r
 251   <xs:simpleType name="AccountAuthorizationCodeType">\r
 252     <xs:annotation>\r
 253       <xs:documentation>\r
 254         Account/Authorization Code Type.\r
 255       </xs:documentation>\r
 256     </xs:annotation>\r
 257     <xs:restriction base="xs:token">\r
 258       <xs:enumeration value="Account Code"/>\r
 259       <xs:enumeration value="Authorization Code"/>\r
 260       <xs:enumeration value="Deactivated"/>\r
 261     </xs:restriction>\r
 262   </xs:simpleType>    \r
 263     \r
 264   <xs:simpleType name="AccountAuthorizationCodeNumberOfDigits">\r
 265     <xs:annotation>\r
 266       <xs:documentation>\r
 267         Number of Account/Authorization Code Digits.\r
 268       </xs:documentation>\r
 269     </xs:annotation>\r
 270     <xs:restriction base="xs:int">\r
 271       <xs:minInclusive value="2"/>\r
 272       <xs:maxInclusive value="14"/>\r
 273     </xs:restriction>\r
 274   </xs:simpleType>    \r
 275     \r
 276 </xs:schema>\r