share/OCISchemaAS/Services/OCISchemaServiceOutlookIntegration.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 <!-- O U T L O O K   I N T E G R A 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   \r
  25   <!-- ********************************************************************************** -->\r
  26   <!-- O U T L O O K   I N T E G R A 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
  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     UserOutlookIntegrationGetRequest    \r
  35     UserOutlookIntegrationModifyRequest    \r
  36     \r
  37   --> \r
  38   \r
  39   <xs:complexType name="UserOutlookIntegrationGetRequest">\r
  40     <xs:annotation>\r
  41       <xs:documentation>\r
  42         Request the user level data associated with Outlook Integration.\r
  43         The response is either a UserOutlookIntegrationGetResponse or an\r
  44         ErrorResponse.\r
  45       </xs:documentation>\r
  46     </xs:annotation>\r
  47     <xs:complexContent>\r
  48       <xs:extension base="core:OCIRequest">\r
  49         <xs:sequence>\r
  50           <xs:element name="userId" type="UserId"/>\r
  51         </xs:sequence>\r
  52       </xs:extension>\r
  53     </xs:complexContent>\r
  54   </xs:complexType>    \r
  55     \r
  56   <xs:complexType name="UserOutlookIntegrationGetResponse">\r
  57     <xs:annotation>\r
  58       <xs:documentation>\r
  59         Response to UserOutlookIntegrationGetRequest.\r
  60       </xs:documentation>\r
  61     </xs:annotation>\r
  62     <xs:complexContent>\r
  63       <xs:extension base="core:OCIDataResponse">\r
  64         <xs:sequence>\r
  65           <xs:element name="isActive" type="xs:boolean"/>\r
  66           <xs:element name="contactRetrievalSelection" type="OutlookIntegrationContactRetrievalSelection"/>\r
  67         </xs:sequence>\r
  68       </xs:extension>\r
  69     </xs:complexContent>\r
  70   </xs:complexType>    \r
  71     \r
  72   <xs:complexType name="UserOutlookIntegrationModifyRequest">\r
  73     <xs:annotation>\r
  74       <xs:documentation>\r
  75         Modify the user level data associated with Outlook Integration.\r
  76         The response is either a SuccessResponse or an ErrorResponse.\r
  77       </xs:documentation>\r
  78     </xs:annotation>\r
  79     <xs:complexContent>\r
  80       <xs:extension base="core:OCIRequest">\r
  81         <xs:sequence>\r
  82           <xs:element name="userId" type="UserId"/>\r
  83           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
  84           <xs:element name="contactRetrievalSelection" type="OutlookIntegrationContactRetrievalSelection" minOccurs="0"/>\r
  85         </xs:sequence>\r
  86       </xs:extension>\r
  87     </xs:complexContent>\r
  88   </xs:complexType>    \r
  89     \r
  90   <xs:simpleType name="OutlookIntegrationContactRetrievalSelection">\r
  91     <xs:annotation>\r
  92       <xs:documentation>\r
  93         Microsoft Outlook contact database search option.\r
  94         Controls which contacts are retrieved from outlook.\r
  95       </xs:documentation>\r
  96     </xs:annotation>\r
  97     <xs:restriction base="xs:token">\r
  98       <xs:enumeration value="Retrieve Default Contact Folder Only"/>\r
  99       <xs:enumeration value="Retrieve All Contacts"/>\r
 100     </xs:restriction>\r
 101   </xs:simpleType>    \r
 102     \r
 103 </xs:schema>\r