share/OCISchemaAS/Services/OCISchemaServiceCallingNameRetrieval.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 <!-- C A L L I N G   N A M E   R E T R I E V A L  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   <!-- C A L L I N G   N A M E   R E T R I E V A L                                        -->\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     SystemCallingNameRetrievalGetRequest20    \r
  36     SystemCallingNameRetrievalModifyRequest20    \r
  37     UserCallingNameRetrievalGetRequest    \r
  38     UserCallingNameRetrievalModifyRequest    \r
  39     \r
  40   --> \r
  41   \r
  42   <xs:complexType name="SystemCallingNameRetrievalGetRequest20">\r
  43     <xs:annotation>\r
  44       <xs:appinfo>\r
  45         <asDataModeSupported>true</asDataModeSupported>\r
  46         <hssDataModeSupported>false</hssDataModeSupported>\r
  47       </xs:appinfo>\r
  48       <xs:documentation>\r
  49         Request the system's calling name retrieval attributes.\r
  50         The response is either a SystemCallingNameRetrievalGetResponse20 or an ErrorResponse.\r
  51       </xs:documentation>\r
  52     </xs:annotation>\r
  53     <xs:complexContent>\r
  54       <xs:extension base="core:OCIRequest">\r
  55         <xs:sequence/>\r
  56       </xs:extension>\r
  57     </xs:complexContent>\r
  58   </xs:complexType>    \r
  59     \r
  60   <xs:complexType name="SystemCallingNameRetrievalGetResponse20">\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 SystemCallingNameRetrievalGetRequest20.\r
  68       </xs:documentation>\r
  69     </xs:annotation>\r
  70     <xs:complexContent>\r
  71       <xs:extension base="core:OCIDataResponse">\r
  72         <xs:sequence>\r
  73           <xs:element name="triggerCNAMQueriesForAllNetworkCalls" type="xs:boolean"/>\r
  74           <xs:element name="triggerCNAMQueriesForGroupAndEnterpriseCalls" type="xs:boolean"/>\r
  75           <xs:element name="queryProtocol" type="CallingNameRetrievalQueryProtocol"/>\r
  76           <xs:element name="queryTimeoutMilliseconds" type="CallingNameRetrievalQueryTimeoutMilliseconds"/>\r
  77           <xs:element name="sipExternalDatabaseNetAddress" type="NetAddress" minOccurs="0"/>\r
  78           <xs:element name="sipExternalDatabasePort" type="Port1025" minOccurs="0"/>\r
  79           <xs:element name="sipExternalDatabaseTransport" type="TransportProtocol"/>\r
  80           <xs:element name="soapExternalDatabaseNetAddress" type="NetAddress" minOccurs="0"/>\r
  81           <xs:element name="callingNameSource" type="CallingNameRetrievalSourceIdentity"/>\r
  82           <xs:element name="routeAdvanceTimer" type="CallingNameRetrievalRouteAdvanceTimerMilliseconds"/>\r
  83           <xs:element name="retryFailedCNAMServerInterval" type="CallingNameRetrievalRetryFailedCNAMServerIntervalSeconds"/>\r
  84           <xs:element name="ignoreRestrictedPresentationIndicator" type="xs:boolean"/>\r
  85           <xs:element name="supportsDNSSRV" type="xs:boolean"/>\r
  86         </xs:sequence>\r
  87       </xs:extension>\r
  88     </xs:complexContent>\r
  89   </xs:complexType>    \r
  90     \r
  91   <xs:complexType name="SystemCallingNameRetrievalModifyRequest20">\r
  92     <xs:annotation>\r
  93       <xs:documentation>\r
  94         Modifies the system's calling name retrieval attributes.\r
  95         The response is either a SuccessResponse or an ErrorResponse.\r
  96       </xs:documentation>\r
  97     </xs:annotation>\r
  98     <xs:complexContent>\r
  99       <xs:extension base="core:OCIRequest">\r
 100         <xs:sequence>\r
 101           <xs:element name="triggerCNAMQueriesForAllNetworkCalls" type="xs:boolean" minOccurs="0"/>\r
 102           <xs:element name="triggerCNAMQueriesForGroupAndEnterpriseCalls" type="xs:boolean" minOccurs="0"/>\r
 103           <xs:element name="queryProtocol" type="CallingNameRetrievalQueryProtocol" minOccurs="0"/>\r
 104           <xs:element name="queryTimeoutMilliseconds" type="CallingNameRetrievalQueryTimeoutMilliseconds" minOccurs="0"/>\r
 105           <xs:element name="sipExternalDatabaseNetAddress" type="NetAddress" nillable="true" minOccurs="0"/>\r
 106           <xs:element name="sipExternalDatabasePort" type="Port1025" nillable="true" minOccurs="0"/>\r
 107           <xs:element name="sipExternalDatabaseTransport" type="TransportProtocol" minOccurs="0"/>\r
 108           <xs:element name="soapExternalDatabaseNetAddress" type="NetAddress" nillable="true" minOccurs="0"/>\r
 109           <xs:element name="callingNameSource" type="CallingNameRetrievalSourceIdentity" minOccurs="0"/>\r
 110           <xs:element name="routeAdvanceTimer" type="CallingNameRetrievalRouteAdvanceTimerMilliseconds" minOccurs="0"/>\r
 111           <xs:element name="retryFailedCNAMServerInterval" type="CallingNameRetrievalRetryFailedCNAMServerIntervalSeconds" minOccurs="0"/>\r
 112           <xs:element name="ignoreRestrictedPresentationIndicator" type="xs:boolean" minOccurs="0"/>\r
 113           <xs:element name="supportsDNSSRV" type="xs:boolean" minOccurs="0"/>\r
 114         </xs:sequence>\r
 115       </xs:extension>\r
 116     </xs:complexContent>\r
 117   </xs:complexType>    \r
 118     \r
 119   <xs:complexType name="UserCallingNameRetrievalGetRequest">\r
 120     <xs:annotation>\r
 121       <xs:documentation>\r
 122         Request the user level data associated with Calling Name Retrieval.\r
 123         The response is either a UserCallingNameRetrievalGetResponse or an\r
 124         ErrorResponse.\r
 125       </xs:documentation>\r
 126     </xs:annotation>\r
 127     <xs:complexContent>\r
 128       <xs:extension base="core:OCIRequest">\r
 129         <xs:sequence>\r
 130           <xs:element name="userId" type="UserId"/>\r
 131         </xs:sequence>\r
 132       </xs:extension>\r
 133     </xs:complexContent>\r
 134   </xs:complexType>    \r
 135     \r
 136   <xs:complexType name="UserCallingNameRetrievalGetResponse">\r
 137     <xs:annotation>\r
 138       <xs:documentation>\r
 139         Response to UserCallingNameRetrievalGetRequest.\r
 140       </xs:documentation>\r
 141     </xs:annotation>\r
 142     <xs:complexContent>\r
 143       <xs:extension base="core:OCIDataResponse">\r
 144         <xs:sequence>\r
 145           <xs:element name="isActive" type="xs:boolean"/>\r
 146         </xs:sequence>\r
 147       </xs:extension>\r
 148     </xs:complexContent>\r
 149   </xs:complexType>    \r
 150     \r
 151   <xs:complexType name="UserCallingNameRetrievalModifyRequest">\r
 152     <xs:annotation>\r
 153       <xs:documentation>\r
 154         Modify the user level data associated with Calling Name Retrieval.\r
 155         The response is either a SuccessResponse or an ErrorResponse.\r
 156       </xs:documentation>\r
 157     </xs:annotation>\r
 158     <xs:complexContent>\r
 159       <xs:extension base="core:OCIRequest">\r
 160         <xs:sequence>\r
 161           <xs:element name="userId" type="UserId"/>\r
 162           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 163         </xs:sequence>\r
 164       </xs:extension>\r
 165     </xs:complexContent>\r
 166   </xs:complexType>    \r
 167     \r
 168   <xs:simpleType name="CallingNameRetrievalQueryProtocol">\r
 169     <xs:annotation>\r
 170       <xs:documentation>\r
 171         Query Protocol.\r
 172       </xs:documentation>\r
 173     </xs:annotation>\r
 174     <xs:restriction base="xs:token">\r
 175       <xs:enumeration value="Sip"/>\r
 176       <xs:enumeration value="Soap"/>\r
 177     </xs:restriction>\r
 178   </xs:simpleType>    \r
 179     \r
 180   <xs:simpleType name="CallingNameRetrievalQueryTimeoutMilliseconds">\r
 181     <xs:annotation>\r
 182       <xs:documentation>\r
 183         Query time out milli-seconds.\r
 184       </xs:documentation>\r
 185     </xs:annotation>\r
 186     <xs:restriction base="xs:int">\r
 187       <xs:minInclusive value="100"/>\r
 188       <xs:maxInclusive value="10000"/>\r
 189     </xs:restriction>\r
 190   </xs:simpleType>    \r
 191     \r
 192   <xs:simpleType name="CallingNameRetrievalSourceIdentity">\r
 193     <xs:annotation>\r
 194       <xs:documentation>\r
 195         Query Protocol.\r
 196       </xs:documentation>\r
 197     </xs:annotation>\r
 198     <xs:restriction base="xs:token">\r
 199       <xs:enumeration value="Presentation Identity"/>\r
 200       <xs:enumeration value="Asserted Identity"/>\r
 201     </xs:restriction>\r
 202   </xs:simpleType>    \r
 203     \r
 204   <xs:simpleType name="CallingNameRetrievalRetryFailedCNAMServerIntervalSeconds">\r
 205     <xs:annotation>\r
 206       <xs:documentation>\r
 207         Seconds to wait before querying a failed CNAM server.\r
 208       </xs:documentation>\r
 209     </xs:annotation>\r
 210     <xs:restriction base="xs:int">\r
 211       <xs:minInclusive value="0"/>\r
 212       <xs:maxInclusive value="604800"/>\r
 213     </xs:restriction>\r
 214   </xs:simpleType>    \r
 215     \r
 216   <xs:simpleType name="CallingNameRetrievalRouteAdvanceTimerMilliseconds">\r
 217     <xs:annotation>\r
 218       <xs:documentation>\r
 219         Route Advance Query time out milli-seconds.\r
 220       </xs:documentation>\r
 221     </xs:annotation>\r
 222     <xs:restriction base="xs:int">\r
 223       <xs:minInclusive value="100"/>\r
 224       <xs:maxInclusive value="2000"/>\r
 225     </xs:restriction>\r
 226   </xs:simpleType>    \r
 227     \r
 228 </xs:schema>\r