share/OCISchemaAS/Services/OCISchemaServiceCallingPartyCategory.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   P A R T Y   C A T E G O R Y  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   P A R T Y   C A T E G O R Y                                        -->\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     SystemCallingPartyCategoryAddRequest    \r
  36     SystemCallingPartyCategoryDeleteRequest    \r
  37     SystemCallingPartyCategoryGetListRequest    \r
  38     SystemCallingPartyCategoryGetRequest    \r
  39     SystemCallingPartyCategoryModifyRequest    \r
  40     UserCallingPartyCategoryGetRequest16    \r
  41     UserCallingPartyCategoryModifyRequest16    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="SystemCallingPartyCategoryAddRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Add a Calling Party Category to system.\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="category" type="CallingPartyCategoryName"/>\r
  56           <xs:element name="cpcValue" type="CallingPartyCategoryValue" minOccurs="0"/>\r
  57           <xs:element name="isupOliValue" type="ISDNUserPartOriginatingLineInformationValue" minOccurs="0"/>\r
  58           <xs:element name="gtdOliValue" type="ISDNGenericTransparencyDescriptorOliValue" minOccurs="0"/>\r
  59           <xs:element name="userCategory" type="xs:boolean"/>\r
  60           <xs:element name="payPhone" type="xs:boolean"/>\r
  61           <xs:element name="operator" type="xs:boolean"/>\r
  62           <xs:element name="default" type="xs:boolean"/>\r
  63           <xs:element name="collectCall" type="xs:boolean"/>\r
  64           <xs:element name="webDisplayKey" type="WebDisplayKey" minOccurs="0"/>\r
  65         </xs:sequence>\r
  66       </xs:extension>\r
  67     </xs:complexContent>\r
  68   </xs:complexType>    \r
  69     \r
  70   <xs:complexType name="SystemCallingPartyCategoryDeleteRequest">\r
  71     <xs:annotation>\r
  72       <xs:documentation>\r
  73         Delete a Calling Party Category from system. The category cannot be deleted if it is the default or is in use by any users.\r
  74         The response is either a SuccessResponse or an ErrorResponse.\r
  75       </xs:documentation>\r
  76     </xs:annotation>\r
  77     <xs:complexContent>\r
  78       <xs:extension base="core:OCIRequest">\r
  79         <xs:sequence>\r
  80           <xs:element name="category" type="CallingPartyCategoryName"/>\r
  81         </xs:sequence>\r
  82       </xs:extension>\r
  83     </xs:complexContent>\r
  84   </xs:complexType>    \r
  85     \r
  86   <xs:complexType name="SystemCallingPartyCategoryGetListRequest">\r
  87     <xs:annotation>\r
  88       <xs:documentation>\r
  89         Get the list of all Calling Party Category in system.\r
  90         The response is either a SystemCallingPartyCategoryGetListResponse or an ErrorResponse.\r
  91       </xs:documentation>\r
  92     </xs:annotation>\r
  93     <xs:complexContent>\r
  94       <xs:extension base="core:OCIRequest">\r
  95         <xs:sequence/>\r
  96       </xs:extension>\r
  97     </xs:complexContent>\r
  98   </xs:complexType>    \r
  99     \r
 100   <xs:complexType name="SystemCallingPartyCategoryGetListResponse">\r
 101     <xs:annotation>\r
 102       <xs:documentation>\r
 103         Response to SystemCallingPartyCategoryGetListRequest.\r
 104         Contains a table of Calling Party Category defined in system.\r
 105         The column headings are: "Category Name", "User Category", "Collect Call", "Default" and "Web Display Key". \r
 106       </xs:documentation>\r
 107     </xs:annotation>\r
 108     <xs:complexContent>\r
 109       <xs:extension base="core:OCIDataResponse">\r
 110         <xs:sequence>\r
 111           <xs:element name="callingPartyCategoryTable" type="core:OCITable"/>\r
 112         </xs:sequence>\r
 113       </xs:extension>\r
 114     </xs:complexContent>\r
 115   </xs:complexType>    \r
 116     \r
 117   <xs:complexType name="SystemCallingPartyCategoryGetRequest">\r
 118     <xs:annotation>\r
 119       <xs:documentation>\r
 120         Get an existing Calling Party Category in system.\r
 121         The response is either a SystemCallingPartyCategoryGetResponse or an ErrorResponse.\r
 122       </xs:documentation>\r
 123     </xs:annotation>\r
 124     <xs:complexContent>\r
 125       <xs:extension base="core:OCIRequest">\r
 126         <xs:sequence>\r
 127           <xs:element name="category" type="CallingPartyCategoryName"/>\r
 128         </xs:sequence>\r
 129       </xs:extension>\r
 130     </xs:complexContent>\r
 131   </xs:complexType>    \r
 132     \r
 133   <xs:complexType name="SystemCallingPartyCategoryGetResponse">\r
 134     <xs:annotation>\r
 135       <xs:documentation>\r
 136         Response to SystemCallingPartyCategoryGetRequest.\r
 137         Contains information of a Calling Party Category defined in system.\r
 138       </xs:documentation>\r
 139     </xs:annotation>\r
 140     <xs:complexContent>\r
 141       <xs:extension base="core:OCIDataResponse">\r
 142         <xs:sequence>\r
 143           <xs:element name="cpcValue" type="CallingPartyCategoryValue" minOccurs="0"/>\r
 144           <xs:element name="isupOliValue" type="ISDNUserPartOriginatingLineInformationValue" minOccurs="0"/>\r
 145           <xs:element name="gtdOliValue" type="ISDNGenericTransparencyDescriptorOliValue" minOccurs="0"/>\r
 146           <xs:element name="userCategory" type="xs:boolean"/>\r
 147           <xs:element name="payPhone" type="xs:boolean"/>\r
 148           <xs:element name="operator" type="xs:boolean"/>\r
 149           <xs:element name="default" type="xs:boolean"/>\r
 150           <xs:element name="collectCall" type="xs:boolean"/>\r
 151           <xs:element name="webDisplayKey" type="WebDisplayKey" minOccurs="0"/>\r
 152         </xs:sequence>\r
 153       </xs:extension>\r
 154     </xs:complexContent>\r
 155   </xs:complexType>    \r
 156     \r
 157   <xs:complexType name="SystemCallingPartyCategoryModifyRequest">\r
 158     <xs:annotation>\r
 159       <xs:documentation>\r
 160         Modify a Calling Party Category in system.\r
 161         The response is either a SuccessResponse or an ErrorResponse.\r
 162       </xs:documentation>\r
 163     </xs:annotation>\r
 164     <xs:complexContent>\r
 165       <xs:extension base="core:OCIRequest">\r
 166         <xs:sequence>\r
 167           <xs:element name="category" type="CallingPartyCategoryName"/>\r
 168           <xs:element name="cpcValue" type="CallingPartyCategoryValue" nillable="true" minOccurs="0"/>\r
 169           <xs:element name="isupOliValue" type="ISDNUserPartOriginatingLineInformationValue" nillable="true" minOccurs="0"/>\r
 170           <xs:element name="gtdOliValue" type="ISDNGenericTransparencyDescriptorOliValue" nillable="true" minOccurs="0"/>\r
 171           <xs:element name="userCategory" type="xs:boolean" minOccurs="0"/>\r
 172           <xs:element name="payPhone" type="xs:boolean" minOccurs="0"/>\r
 173           <xs:element name="operator" type="xs:boolean" minOccurs="0"/>\r
 174           <xs:element name="becomeDefault" type="xs:boolean" fixed="true" minOccurs="0"/>\r
 175           <xs:element name="collectCall" type="xs:boolean" minOccurs="0"/>\r
 176           <xs:element name="webDisplayKey" type="WebDisplayKey" nillable="true" minOccurs="0"/>\r
 177         </xs:sequence>\r
 178       </xs:extension>\r
 179     </xs:complexContent>\r
 180   </xs:complexType>    \r
 181     \r
 182   <xs:complexType name="UserCallingPartyCategoryGetRequest16">\r
 183     <xs:annotation>\r
 184       <xs:documentation>\r
 185         Request the user level data associated with Calling Party Category.\r
 186         The response is either a UserCallingPartyCategoryGetResponse16 or an\r
 187         ErrorResponse.\r
 188       </xs:documentation>\r
 189     </xs:annotation>\r
 190     <xs:complexContent>\r
 191       <xs:extension base="core:OCIRequest">\r
 192         <xs:sequence>\r
 193           <xs:element name="userId" type="UserId"/>\r
 194         </xs:sequence>\r
 195       </xs:extension>\r
 196     </xs:complexContent>\r
 197   </xs:complexType>    \r
 198     \r
 199   <xs:complexType name="UserCallingPartyCategoryGetResponse16">\r
 200     <xs:annotation>\r
 201       <xs:documentation>\r
 202         Response to UserCallingPartyCategoryGetRequest16.\r
 203       </xs:documentation>\r
 204     </xs:annotation>\r
 205     <xs:complexContent>\r
 206       <xs:extension base="core:OCIDataResponse">\r
 207         <xs:sequence>\r
 208           <xs:element name="category" type="CallingPartyCategoryName"/>\r
 209         </xs:sequence>\r
 210       </xs:extension>\r
 211     </xs:complexContent>\r
 212   </xs:complexType>    \r
 213     \r
 214   <xs:complexType name="UserCallingPartyCategoryModifyRequest16">\r
 215     <xs:annotation>\r
 216       <xs:documentation>\r
 217         Modify the user level data associated with Calling Party Category.\r
 218         The response is either a SuccessResponse or an ErrorResponse.\r
 219       </xs:documentation>\r
 220     </xs:annotation>\r
 221     <xs:complexContent>\r
 222       <xs:extension base="core:OCIRequest">\r
 223         <xs:sequence>\r
 224           <xs:element name="userId" type="UserId"/>\r
 225           <xs:element name="category" type="CallingPartyCategoryName" minOccurs="0"/>\r
 226         </xs:sequence>\r
 227       </xs:extension>\r
 228     </xs:complexContent>\r
 229   </xs:complexType>    \r
 230     \r
 231   <xs:simpleType name="CallingPartyCategoryName">\r
 232     <xs:annotation>\r
 233       <xs:documentation>\r
 234         Name for the Calling Party Category.\r
 235       </xs:documentation>\r
 236     </xs:annotation>\r
 237     <xs:restriction base="xs:token">\r
 238       <xs:minLength value="1"/>\r
 239       <xs:maxLength value="20"/>\r
 240     </xs:restriction>\r
 241   </xs:simpleType>    \r
 242     \r
 243   <xs:simpleType name="CallingPartyCategoryValue">\r
 244     <xs:annotation>\r
 245       <xs:documentation>\r
 246         Value for the Calling Party Category used in signaling.\r
 247       </xs:documentation>\r
 248     </xs:annotation>\r
 249     <xs:restriction base="xs:token">\r
 250       <xs:minLength value="1"/>\r
 251       <xs:maxLength value="20"/>\r
 252     </xs:restriction>\r
 253   </xs:simpleType>    \r
 254     \r
 255   <xs:simpleType name="ISDNGenericTransparencyDescriptorOliValue">\r
 256     <xs:annotation>\r
 257       <xs:documentation>\r
 258         ISDN generic transparency descriptor OLI value for the Calling Party Category.\r
 259       </xs:documentation>\r
 260     </xs:annotation>\r
 261     <xs:restriction base="xs:token">\r
 262       <xs:minLength value="1"/>\r
 263       <xs:maxLength value="3"/>\r
 264     </xs:restriction>\r
 265   </xs:simpleType>    \r
 266     \r
 267   <xs:simpleType name="ISDNUserPartOriginatingLineInformationValue">\r
 268     <xs:annotation>\r
 269       <xs:documentation>\r
 270         ISDN user part originating line information value for the Calling Party Category.\r
 271       </xs:documentation>\r
 272     </xs:annotation>\r
 273     <xs:restriction base="xs:int">\r
 274       <xs:minInclusive value="0"/>\r
 275       <xs:maxInclusive value="255"/>\r
 276     </xs:restriction>\r
 277   </xs:simpleType>    \r
 278     \r
 279 </xs:schema>\r