share/OCISchemaAS/Services/OCISchemaServicePolycomPhoneServices.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 <!-- P O L Y C O M   P H O N E   S E R V I C 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   \r
  25   <!-- ********************************************************************************** -->\r
  26   <!-- P O L Y C O M   P H O N E   S E R V I C E S                                        -->\r
  27   <!-- 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     GroupPolycomPhoneServicesGetRequest    \r
  36     GroupPolycomPhoneServicesModifyRequest    \r
  37     UserPolycomPhoneServicesGetRequest    \r
  38     UserPolycomPhoneServicesModifyRequest    \r
  39     UserPolycomPhoneServicesGetPrimaryEndpointListRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="GroupPolycomPhoneServicesGetRequest">\r
  44     <xs:annotation>\r
  45       <xs:documentation>\r
  46         Request the group's Polycom Phone Services attributes.\r
  47         The response is either a GroupPolycomPhoneServicesGetResponse or an ErrorResponse.\r
  48       </xs:documentation>\r
  49     </xs:annotation>\r
  50     <xs:complexContent>\r
  51       <xs:extension base="core:OCIRequest">\r
  52         <xs:sequence>\r
  53           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  54           <xs:element name="groupId" type="GroupId"/>\r
  55         </xs:sequence>\r
  56       </xs:extension>\r
  57     </xs:complexContent>\r
  58   </xs:complexType>    \r
  59     \r
  60   <xs:complexType name="GroupPolycomPhoneServicesGetResponse">\r
  61     <xs:annotation>\r
  62       <xs:documentation>\r
  63         Response to GroupPolycomPhoneServicesGetRequest.\r
  64       </xs:documentation>\r
  65     </xs:annotation>\r
  66     <xs:complexContent>\r
  67       <xs:extension base="core:OCIDataResponse">\r
  68         <xs:sequence>\r
  69           <xs:element name="includeGroupCommonPhoneListInDirectory" type="xs:boolean"/>\r
  70           <xs:element name="includeGroupCustomContactDirectoryInDirectory" type="xs:boolean"/>\r
  71           <xs:element name="groupCustomContactDirectory" type="CustomContactDirectoryName" minOccurs="0"/>\r
  72         </xs:sequence>\r
  73       </xs:extension>\r
  74     </xs:complexContent>\r
  75   </xs:complexType>    \r
  76     \r
  77   <xs:complexType name="GroupPolycomPhoneServicesModifyRequest">\r
  78     <xs:annotation>\r
  79       <xs:documentation>\r
  80         Modify the group's Polycom Phone Services attributes.\r
  81         The response is either a SuccessResponse or an ErrorResponse.\r
  82       </xs:documentation>\r
  83     </xs:annotation>\r
  84     <xs:complexContent>\r
  85       <xs:extension base="core:OCIRequest">\r
  86         <xs:sequence>\r
  87           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  88           <xs:element name="groupId" type="GroupId"/>\r
  89           <xs:element name="includeGroupCommonPhoneListInDirectory" type="xs:boolean" minOccurs="0"/>\r
  90           <xs:element name="includeGroupCustomContactDirectoryInDirectory" type="xs:boolean" minOccurs="0"/>\r
  91           <xs:element name="groupCustomContactDirectory" type="CustomContactDirectoryName" minOccurs="0" nillable="true"/>\r
  92         </xs:sequence>\r
  93       </xs:extension>\r
  94     </xs:complexContent>\r
  95   </xs:complexType>    \r
  96     \r
  97   <xs:complexType name="UserPolycomPhoneServicesGetRequest">\r
  98     <xs:annotation>\r
  99       <xs:documentation>\r
 100         Request the user's Polycom Phone Services attributes.\r
 101         The response is either a UserPolycomPhoneServicesGetResponse or an ErrorResponse.\r
 102       </xs:documentation>\r
 103     </xs:annotation>\r
 104     <xs:complexContent>\r
 105       <xs:extension base="core:OCIRequest">\r
 106         <xs:sequence>\r
 107           <xs:element name="userId" type="UserId"/>\r
 108           <xs:element name="accessDevice" type="AccessDevice"/>\r
 109         </xs:sequence>\r
 110       </xs:extension>\r
 111     </xs:complexContent>\r
 112   </xs:complexType>    \r
 113     \r
 114   <xs:complexType name="UserPolycomPhoneServicesGetResponse">\r
 115     <xs:annotation>\r
 116       <xs:documentation>\r
 117         Response to UserPolycomPhoneServicesGetRequest.\r
 118       </xs:documentation>\r
 119     </xs:annotation>\r
 120     <xs:complexContent>\r
 121       <xs:extension base="core:OCIDataResponse">\r
 122         <xs:sequence>\r
 123           <xs:element name="integratePhoneDirectoryWithBroadWorks" type="xs:boolean"/>\r
 124           <xs:element name="includeUserPersonalPhoneListInDirectory" type="xs:boolean"/>\r
 125           <xs:element name="includeGroupCustomContactDirectoryInDirectory" type="xs:boolean"/>\r
 126           <xs:element name="groupCustomContactDirectory" type="CustomContactDirectoryName" minOccurs="0"/>\r
 127         </xs:sequence>\r
 128       </xs:extension>\r
 129     </xs:complexContent>\r
 130   </xs:complexType>    \r
 131     \r
 132   <xs:complexType name="UserPolycomPhoneServicesModifyRequest">\r
 133     <xs:annotation>\r
 134       <xs:documentation>\r
 135         Modify the user's Polycom Phone Services attributes.\r
 136         The response is either a SuccessResponse or an ErrorResponse.\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:complexContent>\r
 140       <xs:extension base="core:OCIRequest">\r
 141         <xs:sequence>\r
 142           <xs:element name="userId" type="UserId"/>\r
 143           <xs:element name="accessDevice" type="AccessDevice"/>\r
 144           <xs:element name="integratePhoneDirectoryWithBroadWorks" type="xs:boolean" minOccurs="0"/>\r
 145           <xs:element name="includeUserPersonalPhoneListInDirectory" type="xs:boolean" minOccurs="0"/>\r
 146           <xs:element name="includeGroupCustomContactDirectoryInDirectory" type="xs:boolean" minOccurs="0"/>\r
 147           <xs:element name="groupCustomContactDirectory" type="CustomContactDirectoryName" minOccurs="0" nillable="true"/>\r
 148         </xs:sequence>\r
 149       </xs:extension>\r
 150     </xs:complexContent>\r
 151   </xs:complexType>    \r
 152     \r
 153   <xs:complexType name="UserPolycomPhoneServicesGetPrimaryEndpointListRequest">\r
 154     <xs:annotation>\r
 155       <xs:documentation>\r
 156         Request the user's list of device profiles on which the user is the primary user.\r
 157         The response is either a UserPolycomPhoneServicesGetPrimaryEndpointListResponse or an ErrorResponse.\r
 158       </xs:documentation>\r
 159     </xs:annotation>\r
 160     <xs:complexContent>\r
 161       <xs:extension base="core:OCIRequest">\r
 162         <xs:sequence>\r
 163           <xs:element name="userId" type="UserId"/>\r
 164         </xs:sequence>\r
 165       </xs:extension>\r
 166     </xs:complexContent>\r
 167   </xs:complexType>    \r
 168     \r
 169   <xs:complexType name="UserPolycomPhoneServicesGetPrimaryEndpointListResponse">\r
 170     <xs:annotation>\r
 171       <xs:documentation>\r
 172         Response to UserPolycomPhoneServicesGetPrimaryEndpointListRequest.\r
 173         The column headings for the deviceUserTable are: "Device Level", "Device Name", "Line/Port",  "Private Identity".\r
 174         The Private Identity column is empty is AS mode.\r
 175       </xs:documentation>\r
 176     </xs:annotation>\r
 177     <xs:complexContent>\r
 178       <xs:extension base="core:OCIDataResponse">\r
 179         <xs:sequence>\r
 180           <xs:element name="deviceUserTable" type="core:OCITable"/>\r
 181         </xs:sequence>\r
 182       </xs:extension>\r
 183     </xs:complexContent>\r
 184   </xs:complexType>    \r
 185     \r
 186 </xs:schema>\r