share/OCISchemaAS/Services/OCISchemaServiceExecutiveAssistant.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 <!-- E X E C U T I V E   A S S I S T A N T  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="../OCISchemaSearchCriteria.xsd"/>\r
  24   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- E X E C U T I V E   A S S I S T A N T    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     UserExecutiveAssistantGetRequest    \r
  36     UserExecutiveAssistantModifyRequest    \r
  37     \r
  38   --> \r
  39   \r
  40   <xs:complexType name="UserExecutiveAssistantGetRequest">\r
  41     <xs:annotation>\r
  42       <xs:appinfo>\r
  43         <asDataModeSupported>true</asDataModeSupported>\r
  44         <hssDataModeSupported>false</hssDataModeSupported>\r
  45       </xs:appinfo>\r
  46       <xs:documentation>\r
  47         Get the setting of an executive assistant.\r
  48         The response is either UserExecutiveAssistantGetResponse or ErrorResponse.\r
  49       </xs:documentation>\r
  50     </xs:annotation>\r
  51     <xs:complexContent>\r
  52       <xs:extension base="core:OCIRequest">\r
  53         <xs:sequence>\r
  54           <xs:element name="userId" type="UserId"/>\r
  55         </xs:sequence>\r
  56       </xs:extension>\r
  57     </xs:complexContent>\r
  58   </xs:complexType>    \r
  59     \r
  60   <xs:complexType name="UserExecutiveAssistantGetResponse">\r
  61     <xs:annotation>\r
  62       <xs:appinfo>\r
  63         <asDataModeSupported>true</asDataModeSupported>\r
  64         <hssDataModeSupported>false</hssDataModeSupported>\r
  65       </xs:appinfo>\r
  66       <xs:documentation>\r
  67         Response to the UserExecutiveAssistantGetRequest.\r
  68         Contains the executive assistant setting and a table of executives this assistant has been assigned to.\r
  69         The criteria table's column headings are: "User Id", "Last Name", "First Name", ", "Hiragana Last Name", \r
  70         "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", \r
  71         "Assistant Opt-in Status" and "Executive Allow Opt-in".\r
  72         The possible values for "Assistant Opt-in Status" and "Executive Allow Opt-in" columns are "true" and "false".\r
  73       </xs:documentation>\r
  74     </xs:annotation>\r
  75     <xs:complexContent>\r
  76       <xs:extension base="core:OCIDataResponse">\r
  77         <xs:sequence>\r
  78           <xs:element name="enableDivert" type="xs:boolean"/>\r
  79           <xs:element name="divertToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
  80           <xs:element name="executiveTable" type="core:OCITable"/>\r
  81         </xs:sequence>\r
  82       </xs:extension>\r
  83     </xs:complexContent>\r
  84   </xs:complexType>    \r
  85     \r
  86   <xs:complexType name="UserExecutiveAssistantModifyRequest">\r
  87     <xs:annotation>\r
  88       <xs:appinfo>\r
  89         <asDataModeSupported>true</asDataModeSupported>\r
  90         <hssDataModeSupported>false</hssDataModeSupported>\r
  91       </xs:appinfo>\r
  92       <xs:documentation>\r
  93         Modify the setting for executive assistant.\r
  94         The response is either SuccessResponse or ErrorResponse.\r
  95       </xs:documentation>\r
  96     </xs:annotation>\r
  97     <xs:complexContent>\r
  98       <xs:extension base="core:OCIRequest">\r
  99         <xs:sequence>\r
 100           <xs:element name="userId" type="UserId"/>\r
 101           <xs:element name="enableDivert" type="xs:boolean" minOccurs="0"/>\r
 102           <xs:element name="divertToPhoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 103           <xs:element name="optInStatus" type="ExecutiveAssistantOptInStatus" 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="ExecutiveAssistantOptInStatus">\r
 110     <xs:annotation>\r
 111       <xs:documentation>\r
 112         Executive assistant Opt-in status with executive.\r
 113       </xs:documentation>\r
 114     </xs:annotation>\r
 115     <xs:sequence>\r
 116       <xs:element name="executiveUserId" type="UserId"/>\r
 117       <xs:element name="optIn" type="xs:boolean"/>\r
 118     </xs:sequence>\r
 119   </xs:complexType>    \r
 120     \r
 121 </xs:schema>\r