share/OCISchemaAS/Services/OCISchemaServiceCallingPlan.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 L A 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   <!-- C A L L I N G   P L A 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     GroupCallingPlanAddDigitPatternRequest    \r
  35     GroupCallingPlanDeleteDigitPatternListRequest    \r
  36     GroupCallingPlanGetDigitPatternListRequest    \r
  37     GroupCallingPlanModifyDigitPatternRequest    \r
  38     \r
  39   --> \r
  40   \r
  41   <xs:complexType name="GroupCallingPlanAddDigitPatternRequest">\r
  42     <xs:annotation>\r
  43       <xs:documentation>\r
  44         Add a new calling plan digit string.\r
  45         The response is either a SuccessResponse or an ErrorResponse.\r
  46       </xs:documentation>\r
  47     </xs:annotation>\r
  48     <xs:complexContent>\r
  49       <xs:extension base="core:OCIRequest">\r
  50         <xs:sequence>\r
  51           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  52           <xs:element name="groupId" type="GroupId"/>\r
  53           <xs:element name="name" type="CallingPlanDigitPatternName"/>\r
  54           <xs:element name="digitPattern" type="CallingPlanDigitPattern"/>\r
  55         </xs:sequence>\r
  56       </xs:extension>\r
  57     </xs:complexContent>\r
  58   </xs:complexType>    \r
  59     \r
  60   <xs:complexType name="GroupCallingPlanDeleteDigitPatternListRequest">\r
  61     <xs:annotation>\r
  62       <xs:documentation>\r
  63         Delete one or more calling plan digit strings.\r
  64         The response is either a SuccessResponse or an ErrorResponse.\r
  65       </xs:documentation>\r
  66     </xs:annotation>\r
  67     <xs:complexContent>\r
  68       <xs:extension base="core:OCIRequest">\r
  69         <xs:sequence>\r
  70           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  71           <xs:element name="groupId" type="GroupId"/>\r
  72           <xs:element name="name" type="CallingPlanDigitPatternName" minOccurs="1" maxOccurs="unbounded"/>\r
  73         </xs:sequence>\r
  74       </xs:extension>\r
  75     </xs:complexContent>\r
  76   </xs:complexType>    \r
  77     \r
  78   <xs:complexType name="GroupCallingPlanGetDigitPatternListRequest">\r
  79     <xs:annotation>\r
  80       <xs:documentation>\r
  81         Get the list of calling plan digit strings for a group.\r
  82         The response is either a GroupCallingPlanGetDigitPatternListResponse or an ErrorResponse.\r
  83       </xs:documentation>\r
  84     </xs:annotation>\r
  85     <xs:complexContent>\r
  86       <xs:extension base="core:OCIRequest">\r
  87         <xs:sequence>\r
  88           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  89           <xs:element name="groupId" type="GroupId"/>\r
  90         </xs:sequence>\r
  91       </xs:extension>\r
  92     </xs:complexContent>\r
  93   </xs:complexType>    \r
  94     \r
  95   <xs:complexType name="GroupCallingPlanGetDigitPatternListResponse">\r
  96     <xs:annotation>\r
  97       <xs:documentation>\r
  98         Response to GroupCallingPlanGetDigitPatternListRequest.\r
  99         Contains a table with column headings: "Name", "Digit Pattern".\r
 100       </xs:documentation>\r
 101     </xs:annotation>\r
 102     <xs:complexContent>\r
 103       <xs:extension base="core:OCIDataResponse">\r
 104         <xs:sequence>\r
 105           <xs:element name="digitPatternTable" type="core:OCITable"/>\r
 106         </xs:sequence>\r
 107       </xs:extension>\r
 108     </xs:complexContent>\r
 109   </xs:complexType>    \r
 110     \r
 111   <xs:complexType name="GroupCallingPlanModifyDigitPatternRequest">\r
 112     <xs:annotation>\r
 113       <xs:documentation>\r
 114         Modify a calling plan digit string. The name is a key; it cannot be changed.\r
 115         The response is either a SuccessResponse or an ErrorResponse.\r
 116       </xs:documentation>\r
 117     </xs:annotation>\r
 118     <xs:complexContent>\r
 119       <xs:extension base="core:OCIRequest">\r
 120         <xs:sequence>\r
 121           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 122           <xs:element name="groupId" type="GroupId"/>\r
 123           <xs:element name="name" type="CallingPlanDigitPatternName"/>\r
 124           <xs:element name="digitPattern" type="CallingPlanDigitPattern" minOccurs="0"/>\r
 125         </xs:sequence>\r
 126       </xs:extension>\r
 127     </xs:complexContent>\r
 128   </xs:complexType>    \r
 129     \r
 130   <xs:simpleType name="CallingPlanDigitPattern">\r
 131     <xs:annotation>\r
 132       <xs:documentation>\r
 133         Digit patterns that are used to restrict calls in the Incoming Calling Plan and Outgoing Calling Plan.\r
 134         The digit pattern may contain digits 0-9,+,?, and trailing * digit.\r
 135         Starting in Rel.14.sp4 digit patterns can also contain '#', and '*' digits anywhere in the string. To distinguish between a '*' as a digit from '*' as a wildcard character, a back-slash character shall be used as an escape in front of '*' being a digit. Note that '*' as a wildcard is still only allowed at the end of string.\r
 136         Starting in Rel.17.sp3, the range syntax [n1-n2] is also supported, where n1 and n2 denotes a digit in the range 0 to 9. Also the maximum length is increased to 160.\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:restriction base="xs:token">\r
 140       <xs:minLength value="1"/>\r
 141       <xs:maxLength value="160"/>\r
 142     </xs:restriction>\r
 143   </xs:simpleType>    \r
 144     \r
 145 </xs:schema>\r