share/OCISchemaAS/Services/OCISchemaServiceAdviceOfCharge.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 <!-- A D V I C E   O F   C H A R G E  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   <!-- A D V I C E   O F   C H A R G E    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     SystemAdviceOfChargeGetRequest19sp1    \r
  35     SystemAdviceOfChargeModifyRequest19sp1    \r
  36     SystemAdviceOfChargeCostInformationSourceAddRequest    \r
  37     SystemAdviceOfChargeCostInformationSourceDeleteRequest    \r
  38     SystemAdviceOfChargeCostInformationSourceGetListRequest    \r
  39     SystemAdviceOfChargeCostInformationSourceModifyRequest    \r
  40     UserAdviceOfChargeGetRequest    \r
  41     ServiceProviderAdviceOfChargeGetRequest    \r
  42     ServiceProviderAdviceOfChargeModifyRequest    \r
  43     GroupAdviceOfChargeGetRequest    \r
  44     GroupAdviceOfChargeModifyRequest    \r
  45     UserAdviceOfChargeModifyRequest    \r
  46     \r
  47   --> \r
  48   \r
  49   <xs:complexType name="SystemAdviceOfChargeGetRequest19sp1">\r
  50     <xs:annotation>\r
  51       <xs:appinfo>\r
  52         <asDataModeSupported>true</asDataModeSupported>\r
  53         <hssDataModeSupported>false</hssDataModeSupported>\r
  54       </xs:appinfo>\r
  55       <xs:documentation>\r
  56         Request to get the list of Advice of Charge system parameters.\r
  57         The response is either SystemAdviceOfChargeGetResponse19sp1 or ErrorResponse.\r
  58       </xs:documentation>\r
  59     </xs:annotation>\r
  60     <xs:complexContent>\r
  61       <xs:extension base="core:OCIRequest">\r
  62         <xs:sequence/>\r
  63       </xs:extension>\r
  64     </xs:complexContent>\r
  65   </xs:complexType>    \r
  66     \r
  67   <xs:complexType name="SystemAdviceOfChargeGetResponse19sp1">\r
  68     <xs:annotation>\r
  69       <xs:appinfo>\r
  70         <asDataModeSupported>true</asDataModeSupported>\r
  71         <hssDataModeSupported>false</hssDataModeSupported>\r
  72       </xs:appinfo>\r
  73       <xs:documentation>\r
  74         Response to SystemAdviceOfChargeGetRequest.\r
  75         Contains a list of system Advice of Charge parameters.\r
  76       </xs:documentation>\r
  77     </xs:annotation>\r
  78     <xs:complexContent>\r
  79       <xs:extension base="core:OCIDataResponse">\r
  80         <xs:sequence>\r
  81           <xs:element name="delayBetweenNotificationSeconds" type="AdviceOfChargeDelayBetweenNotificationSeconds"/>\r
  82           <xs:element name="incomingAocHandling" type="AdviceOfChargeIncomingAocHandling"/>\r
  83           <xs:element name="useOCSEnquiry" type="xs:boolean"/>\r
  84           <xs:element name="OCSEnquiryType" type="AdviceOfChargeOCSEnquiryType"/>\r
  85         </xs:sequence>\r
  86       </xs:extension>\r
  87     </xs:complexContent>\r
  88   </xs:complexType>    \r
  89     \r
  90   <xs:complexType name="SystemAdviceOfChargeModifyRequest19sp1">\r
  91     <xs:annotation>\r
  92       <xs:appinfo>\r
  93         <asDataModeSupported>true</asDataModeSupported>\r
  94         <hssDataModeSupported>false</hssDataModeSupported>\r
  95       </xs:appinfo>\r
  96       <xs:documentation>\r
  97         Request to modify Advice of Charge system parameters.\r
  98         The response is either SuccessResponse or ErrorResponse.\r
  99       </xs:documentation>\r
 100     </xs:annotation>\r
 101     <xs:complexContent>\r
 102       <xs:extension base="core:OCIRequest">\r
 103         <xs:sequence>\r
 104           <xs:element name="delayBetweenNotificationSeconds" type="AdviceOfChargeDelayBetweenNotificationSeconds" minOccurs="0"/>\r
 105           <xs:element name="incomingAocHandling" type="AdviceOfChargeIncomingAocHandling" minOccurs="0"/>\r
 106           <xs:element name="useOCSEnquiry" type="xs:boolean" minOccurs="0"/>\r
 107           <xs:element name="OCSEnquiryType" type="AdviceOfChargeOCSEnquiryType" minOccurs="0"/>\r
 108         </xs:sequence>\r
 109       </xs:extension>\r
 110     </xs:complexContent>\r
 111   </xs:complexType>    \r
 112     \r
 113   <xs:complexType name="SystemAdviceOfChargeCostInformationSourceAddRequest">\r
 114     <xs:annotation>\r
 115       <xs:appinfo>\r
 116         <asDataModeSupported>true</asDataModeSupported>\r
 117         <hssDataModeSupported>false</hssDataModeSupported>\r
 118       </xs:appinfo>\r
 119       <xs:documentation>\r
 120         Add a cost information source. The response is either SuccessResponse or ErrorResponse.\r
 121       </xs:documentation>\r
 122     </xs:annotation>\r
 123     <xs:complexContent>\r
 124       <xs:extension base="core:OCIRequest">\r
 125         <xs:sequence>\r
 126           <xs:element name="peerIdentity" type="NetAddress"/>\r
 127           <xs:element name="priority" type="AdviceOfChargeOCSPriority"/>\r
 128         </xs:sequence>\r
 129       </xs:extension>\r
 130     </xs:complexContent>\r
 131   </xs:complexType>    \r
 132     \r
 133   <xs:complexType name="SystemAdviceOfChargeCostInformationSourceDeleteRequest">\r
 134     <xs:annotation>\r
 135       <xs:appinfo>\r
 136         <asDataModeSupported>true</asDataModeSupported>\r
 137         <hssDataModeSupported>false</hssDataModeSupported>\r
 138       </xs:appinfo>\r
 139       <xs:documentation>\r
 140         Delete a cost information source.\r
 141         The response is either SuccessResponse or ErrorResponse.\r
 142       </xs:documentation>\r
 143     </xs:annotation>\r
 144     <xs:complexContent>\r
 145       <xs:extension base="core:OCIRequest">\r
 146         <xs:sequence>\r
 147           <xs:element name="peerIdentity" type="NetAddress"/>\r
 148         </xs:sequence>\r
 149       </xs:extension>\r
 150     </xs:complexContent>\r
 151   </xs:complexType>    \r
 152     \r
 153   <xs:complexType name="SystemAdviceOfChargeCostInformationSourceGetListRequest">\r
 154     <xs:annotation>\r
 155       <xs:appinfo>\r
 156         <asDataModeSupported>true</asDataModeSupported>\r
 157         <hssDataModeSupported>false</hssDataModeSupported>\r
 158       </xs:appinfo>\r
 159       <xs:documentation>\r
 160         Get a list of cost information sources.\r
 161         The response is either SystemAdviceOfChargeCostInformationSourceGetListResponse or 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:extension>\r
 168     </xs:complexContent>\r
 169   </xs:complexType>    \r
 170     \r
 171   <xs:complexType name="SystemAdviceOfChargeCostInformationSourceGetListResponse">\r
 172     <xs:annotation>\r
 173       <xs:appinfo>\r
 174         <asDataModeSupported>true</asDataModeSupported>\r
 175         <hssDataModeSupported>false</hssDataModeSupported>\r
 176       </xs:appinfo>\r
 177       <xs:documentation>\r
 178         Response to SystemAdviceOfChargeCostInformationSourceGetListRequest.\r
 179         Contains a table with column headings: "PeerIdentity", "Priority"\r
 180       </xs:documentation>\r
 181     </xs:annotation>\r
 182     <xs:complexContent>\r
 183       <xs:extension base="core:OCIDataResponse">\r
 184         <xs:sequence>\r
 185           <xs:element name="costInformationSourceTable" type="core:OCITable"/>\r
 186         </xs:sequence>\r
 187       </xs:extension>\r
 188     </xs:complexContent>\r
 189   </xs:complexType>    \r
 190     \r
 191   <xs:complexType name="SystemAdviceOfChargeCostInformationSourceModifyRequest">\r
 192     <xs:annotation>\r
 193       <xs:appinfo>\r
 194         <asDataModeSupported>true</asDataModeSupported>\r
 195         <hssDataModeSupported>false</hssDataModeSupported>\r
 196       </xs:appinfo>\r
 197       <xs:documentation>\r
 198         Modify a cost information source.\r
 199         The response is either SuccessResponse or ErrorResponse.\r
 200       </xs:documentation>\r
 201     </xs:annotation>\r
 202     <xs:complexContent>\r
 203       <xs:extension base="core:OCIRequest">\r
 204         <xs:sequence>\r
 205           <xs:element name="peerIdentity" type="NetAddress"/>\r
 206           <xs:element name="priority" type="AdviceOfChargeOCSPriority"/>\r
 207         </xs:sequence>\r
 208       </xs:extension>\r
 209     </xs:complexContent>\r
 210   </xs:complexType>    \r
 211     \r
 212   <xs:complexType name="UserAdviceOfChargeGetRequest">\r
 213     <xs:annotation>\r
 214       <xs:documentation>\r
 215         Request the user level data associated with Advice Of Charge.\r
 216         The response is either a UserAdviceOfChargeGetResponse or an\r
 217         ErrorResponse.\r
 218       </xs:documentation>\r
 219     </xs:annotation>\r
 220     <xs:complexContent>\r
 221       <xs:extension base="core:OCIRequest">\r
 222         <xs:sequence>\r
 223           <xs:element name="userId" type="UserId"/>\r
 224         </xs:sequence>\r
 225       </xs:extension>\r
 226     </xs:complexContent>\r
 227   </xs:complexType>    \r
 228     \r
 229   <xs:complexType name="ServiceProviderAdviceOfChargeGetRequest">\r
 230     <xs:annotation>\r
 231       <xs:appinfo>\r
 232         <asDataModeSupported>true</asDataModeSupported>\r
 233         <hssDataModeSupported>false</hssDataModeSupported>\r
 234       </xs:appinfo>\r
 235       <xs:documentation>\r
 236         Request to get the list of Advice of Charge service provider parameters.\r
 237         The response is either ServiceProviderAdviceOfChargeGetResponse or ErrorResponse.\r
 238       </xs:documentation>\r
 239     </xs:annotation>\r
 240     <xs:complexContent>\r
 241       <xs:extension base="core:OCIRequest">\r
 242         <xs:sequence>\r
 243           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 244         </xs:sequence>\r
 245       </xs:extension>\r
 246     </xs:complexContent>\r
 247   </xs:complexType>    \r
 248     \r
 249   <xs:complexType name="ServiceProviderAdviceOfChargeGetResponse">\r
 250     <xs:annotation>\r
 251       <xs:appinfo>\r
 252         <asDataModeSupported>true</asDataModeSupported>\r
 253         <hssDataModeSupported>false</hssDataModeSupported>\r
 254       </xs:appinfo>\r
 255       <xs:documentation>\r
 256         Response to ServiceProviderAdviceOfChargeGetRequest.\r
 257         Contains a list of Advice of Charge service provider parameters.\r
 258       </xs:documentation>\r
 259     </xs:annotation>\r
 260     <xs:complexContent>\r
 261       <xs:extension base="core:OCIDataResponse">\r
 262         <xs:sequence>\r
 263           <xs:element name="useSPLevelAoCSettings" type="xs:boolean"/>\r
 264           <xs:element name="delayBetweenNotificationSeconds" type="AdviceOfChargeDelayBetweenNotificationSeconds"/>\r
 265         </xs:sequence>\r
 266       </xs:extension>\r
 267     </xs:complexContent>\r
 268   </xs:complexType>    \r
 269     \r
 270   <xs:complexType name="ServiceProviderAdviceOfChargeModifyRequest">\r
 271     <xs:annotation>\r
 272       <xs:appinfo>\r
 273         <asDataModeSupported>true</asDataModeSupported>\r
 274         <hssDataModeSupported>false</hssDataModeSupported>\r
 275       </xs:appinfo>\r
 276       <xs:documentation>\r
 277         Modify the service provider level Advice Of Charge service provider settings.\r
 278         The response is either a SuccessResponse or an ErrorResponse.\r
 279       </xs:documentation>\r
 280     </xs:annotation>\r
 281     <xs:complexContent>\r
 282       <xs:extension base="core:OCIRequest">\r
 283         <xs:sequence>\r
 284           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 285           <xs:element name="useSPLevelAoCSettings" type="xs:boolean" minOccurs="0"/>\r
 286           <xs:element name="delayBetweenNotificationSeconds" type="AdviceOfChargeDelayBetweenNotificationSeconds" minOccurs="0"/>\r
 287         </xs:sequence>\r
 288       </xs:extension>\r
 289     </xs:complexContent>\r
 290   </xs:complexType>    \r
 291     \r
 292   <xs:complexType name="GroupAdviceOfChargeGetRequest">\r
 293     <xs:annotation>\r
 294       <xs:appinfo>\r
 295         <asDataModeSupported>true</asDataModeSupported>\r
 296         <hssDataModeSupported>false</hssDataModeSupported>\r
 297       </xs:appinfo>\r
 298       <xs:documentation>\r
 299         Request to get the list of Advice of Charge group parameters.\r
 300         The response is either GroupAdviceOfChargeGetResponse or ErrorResponse.\r
 301       </xs:documentation>\r
 302     </xs:annotation>\r
 303     <xs:complexContent>\r
 304       <xs:extension base="core:OCIRequest">\r
 305         <xs:sequence>\r
 306           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 307           <xs:element name="groupId" type="GroupId"/>\r
 308         </xs:sequence>\r
 309       </xs:extension>\r
 310     </xs:complexContent>\r
 311   </xs:complexType>    \r
 312     \r
 313   <xs:complexType name="GroupAdviceOfChargeGetResponse">\r
 314     <xs:annotation>\r
 315       <xs:appinfo>\r
 316         <asDataModeSupported>true</asDataModeSupported>\r
 317         <hssDataModeSupported>false</hssDataModeSupported>\r
 318       </xs:appinfo>\r
 319       <xs:documentation>\r
 320         Response to GroupAdviceOfChargeGetRequest.\r
 321         Contains a list of Advice of Charge group parameters.\r
 322       </xs:documentation>\r
 323     </xs:annotation>\r
 324     <xs:complexContent>\r
 325       <xs:extension base="core:OCIDataResponse">\r
 326         <xs:sequence>\r
 327           <xs:element name="useGroupLevelAoCSettings" type="xs:boolean"/>\r
 328           <xs:element name="delayBetweenNotificationSeconds" type="AdviceOfChargeDelayBetweenNotificationSeconds"/>\r
 329         </xs:sequence>\r
 330       </xs:extension>\r
 331     </xs:complexContent>\r
 332   </xs:complexType>    \r
 333     \r
 334   <xs:complexType name="GroupAdviceOfChargeModifyRequest">\r
 335     <xs:annotation>\r
 336       <xs:appinfo>\r
 337         <asDataModeSupported>true</asDataModeSupported>\r
 338         <hssDataModeSupported>false</hssDataModeSupported>\r
 339       </xs:appinfo>\r
 340       <xs:documentation>\r
 341         Modify the service provider level Advice Of Charge group settings.\r
 342         The response is either a SuccessResponse or an ErrorResponse.\r
 343       </xs:documentation>\r
 344     </xs:annotation>\r
 345     <xs:complexContent>\r
 346       <xs:extension base="core:OCIRequest">\r
 347         <xs:sequence>\r
 348           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 349           <xs:element name="groupId" type="GroupId"/>\r
 350           <xs:element name="useGroupLevelAoCSettings" type="xs:boolean" minOccurs="0"/>\r
 351           <xs:element name="delayBetweenNotificationSeconds" type="AdviceOfChargeDelayBetweenNotificationSeconds" minOccurs="0"/>\r
 352         </xs:sequence>\r
 353       </xs:extension>\r
 354     </xs:complexContent>\r
 355   </xs:complexType>    \r
 356     \r
 357   <xs:complexType name="UserAdviceOfChargeGetResponse">\r
 358     <xs:annotation>\r
 359       <xs:documentation>\r
 360         Response to UserAdviceOfChargeGetRequest.\r
 361       </xs:documentation>\r
 362     </xs:annotation>\r
 363     <xs:complexContent>\r
 364       <xs:extension base="core:OCIDataResponse">\r
 365         <xs:sequence>\r
 366           <xs:element name="isActive" type="xs:boolean"/>\r
 367           <xs:element name="aocType" type="AdviceOfChargeType"/>\r
 368         </xs:sequence>\r
 369       </xs:extension>\r
 370     </xs:complexContent>\r
 371   </xs:complexType>    \r
 372     \r
 373   <xs:complexType name="UserAdviceOfChargeModifyRequest">\r
 374     <xs:annotation>\r
 375       <xs:documentation>\r
 376         Modify the user level data associated with Advice of Charge.\r
 377         The response is either a SuccessResponse or an ErrorResponse.\r
 378       </xs:documentation>\r
 379     </xs:annotation>\r
 380     <xs:complexContent>\r
 381       <xs:extension base="core:OCIRequest">\r
 382         <xs:sequence>\r
 383           <xs:element name="userId" type="UserId"/>\r
 384           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 385           <xs:element name="aocType" type="AdviceOfChargeType" minOccurs="0"/>\r
 386         </xs:sequence>\r
 387       </xs:extension>\r
 388     </xs:complexContent>\r
 389   </xs:complexType>    \r
 390     \r
 391   <xs:simpleType name="AdviceOfChargeDelayBetweenNotificationSeconds">\r
 392     <xs:annotation>\r
 393       <xs:documentation>\r
 394         The time in seconds used for the interval for sending AoC-D information to the caller.\r
 395       </xs:documentation>\r
 396     </xs:annotation>\r
 397     <xs:restriction base="xs:int">\r
 398       <xs:minInclusive value="5"/>\r
 399       <xs:maxInclusive value="1800"/>\r
 400     </xs:restriction>\r
 401   </xs:simpleType>    \r
 402     \r
 403   <xs:simpleType name="AdviceOfChargeIncomingAocHandling">\r
 404     <xs:annotation>\r
 405       <xs:documentation>\r
 406         Choices for method of how the Advice of Charge is processed by the Application Server.\r
 407       </xs:documentation>\r
 408     </xs:annotation>\r
 409     <xs:restriction base="xs:token">\r
 410       <xs:enumeration value="Ignore"/>\r
 411       <xs:enumeration value="Charge"/>\r
 412     </xs:restriction>\r
 413   </xs:simpleType>    \r
 414     \r
 415   <xs:simpleType name="AdviceOfChargeType">\r
 416     <xs:annotation>\r
 417       <xs:documentation>\r
 418           Choices for Advice of Charge Type.\r
 419         </xs:documentation>\r
 420     </xs:annotation>\r
 421     <xs:restriction base="xs:token">\r
 422       <xs:enumeration value="During Call"/>\r
 423       <xs:enumeration value="End Of Call"/>\r
 424     </xs:restriction>\r
 425   </xs:simpleType>    \r
 426     \r
 427   <xs:simpleType name="AdviceOfChargeOCSEnquiryType">\r
 428     <xs:annotation>\r
 429       <xs:documentation>\r
 430         Choices for type of OCS enquiry that Advice Of Charge Services sends to OCS.\r
 431       </xs:documentation>\r
 432     </xs:annotation>\r
 433     <xs:restriction base="xs:token">\r
 434       <xs:enumeration value="Service Price"/>\r
 435       <xs:enumeration value="Advice Of Charge"/>\r
 436     </xs:restriction>\r
 437   </xs:simpleType>    \r
 438     \r
 439   <xs:simpleType name="AdviceOfChargeOCSPriority">\r
 440     <xs:annotation>\r
 441       <xs:documentation>\r
 442         The priority of the OCS in configurations with multiple cost informations. \r
 443         The lower the value the higher the priority.\r
 444       </xs:documentation>\r
 445     </xs:annotation>\r
 446     <xs:restriction base="xs:int">\r
 447       <xs:minInclusive value="0"/>\r
 448       <xs:maxInclusive value="9"/>\r
 449     </xs:restriction>\r
 450   </xs:simpleType>    \r
 451     \r
 452 </xs:schema>\r