share/OCISchemaAS/Services/OCISchemaServiceVoiceXml.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 <!-- V O I C E   X M 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   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- V O I C E   X M L    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     GroupVoiceXmlAddInstanceRequest    \r
  36     GroupVoiceXmlDeleteInstanceRequest    \r
  37     GroupVoiceXmlGetInstanceListRequest    \r
  38     GroupVoiceXmlGetInstanceRequest19sp1    \r
  39     GroupVoiceXmlModifyActiveInstanceListRequest    \r
  40     GroupVoiceXmlModifyInstanceRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="GroupVoiceXmlAddInstanceRequest">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47         Add a VoiceXML instance to a group.\r
  48         The domain is required in the serviceUserId.  For a valid voiceXml instance to work properly,\r
  49         a device with Static Registration is expected with a valid contact.\r
  50         The response is either SuccessResponse or 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:element name="serviceProviderId" type="ServiceProviderId"/>\r
  57           <xs:element name="groupId" type="GroupId"/>\r
  58           <xs:element name="serviceUserId" type="UserId"/>\r
  59           <xs:element name="serviceInstanceProfile" type="ServiceInstanceAddProfile"/>\r
  60           <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>\r
  61           <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointAdd" minOccurs="0"/>\r
  62         </xs:sequence>\r
  63       </xs:extension>\r
  64     </xs:complexContent>\r
  65   </xs:complexType>    \r
  66     \r
  67   <xs:complexType name="GroupVoiceXmlDeleteInstanceRequest">\r
  68     <xs:annotation>\r
  69       <xs:documentation>\r
  70         Delete a VoiceXML instance from a group.\r
  71         The response is either SuccessResponse or ErrorResponse.\r
  72       </xs:documentation>\r
  73     </xs:annotation>\r
  74     <xs:complexContent>\r
  75       <xs:extension base="core:OCIRequest">\r
  76         <xs:sequence>\r
  77           <xs:element name="serviceUserId" type="UserId"/>\r
  78         </xs:sequence>\r
  79       </xs:extension>\r
  80     </xs:complexContent>\r
  81   </xs:complexType>    \r
  82     \r
  83   <xs:complexType name="GroupVoiceXmlGetInstanceListRequest">\r
  84     <xs:annotation>\r
  85       <xs:documentation>\r
  86         Get a list of VoiceXML instances within a group.\r
  87         The response is either GroupVoiceXmlGetInstanceListResponse or ErrorResponse.\r
  88         It is possible to get the instances within a specified department.\r
  89       </xs:documentation>\r
  90     </xs:annotation>\r
  91     <xs:complexContent>\r
  92       <xs:extension base="core:OCIRequest">\r
  93         <xs:sequence>\r
  94           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  95           <xs:element name="groupId" type="GroupId"/>\r
  96           <xs:element name="groupDepartmentName" type="DepartmentName" minOccurs="0"/>\r
  97         </xs:sequence>\r
  98       </xs:extension>\r
  99     </xs:complexContent>\r
 100   </xs:complexType>    \r
 101     \r
 102   <xs:complexType name="GroupVoiceXmlGetInstanceListResponse">\r
 103     <xs:annotation>\r
 104       <xs:documentation>\r
 105         Response to the GroupVoiceXmlGetInstanceListRequest.\r
 106         Contains a table with column headings:\r
 107         "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active".\r
 108         The column values for "Is Active" can either be true, or false.\r
 109       </xs:documentation>\r
 110     </xs:annotation>\r
 111     <xs:complexContent>\r
 112       <xs:extension base="core:OCIDataResponse">\r
 113         <xs:sequence>\r
 114           <xs:element name="voiceXmlTable" type="core:OCITable"/>\r
 115         </xs:sequence>\r
 116       </xs:extension>\r
 117     </xs:complexContent>\r
 118   </xs:complexType>    \r
 119     \r
 120   <xs:complexType name="GroupVoiceXmlGetInstanceRequest19sp1">\r
 121     <xs:annotation>\r
 122       <xs:documentation>\r
 123         Request to get all the information of a VoiceXML instance.\r
 124         The response is either GroupVoiceXmlGetInstanceResponse19sp1 or 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="serviceUserId" 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="GroupVoiceXmlGetInstanceResponse19sp1">\r
 137     <xs:annotation>\r
 138       <xs:documentation>\r
 139         Response to GroupVoiceXmlGetInstanceRequest19sp1.\r
 140         Contains the service profile information and possibly access device information.\r
 141       </xs:documentation>\r
 142     </xs:annotation>\r
 143     <xs:complexContent>\r
 144       <xs:extension base="core:OCIDataResponse">\r
 145         <xs:sequence>\r
 146           <xs:element name="serviceInstanceProfile" type="ServiceInstanceReadProfile19sp1"/>\r
 147           <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>\r
 148           <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointWithPortNumberRead" minOccurs="0"/>\r
 149         </xs:sequence>\r
 150       </xs:extension>\r
 151     </xs:complexContent>\r
 152   </xs:complexType>    \r
 153     \r
 154   <xs:complexType name="GroupVoiceXmlModifyActiveInstanceListRequest">\r
 155     <xs:annotation>\r
 156       <xs:documentation>\r
 157         Request to set the active status of VoiceXML instances.\r
 158         The response is either SuccessResponse or ErrorResponse.\r
 159       </xs:documentation>\r
 160     </xs:annotation>\r
 161     <xs:complexContent>\r
 162       <xs:extension base="core:OCIRequest">\r
 163         <xs:sequence>\r
 164           <xs:element name="serviceActivation" type="ServiceActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 165         </xs:sequence>\r
 166       </xs:extension>\r
 167     </xs:complexContent>\r
 168   </xs:complexType>    \r
 169     \r
 170   <xs:complexType name="GroupVoiceXmlModifyInstanceRequest">\r
 171     <xs:annotation>\r
 172       <xs:documentation>\r
 173         Request to modify a VoiceXML instance. For a valid voiceXml instance to work properly,\r
 174         a device with Static Registration is expected with a valid contact.\r
 175         The response is either SuccessResponse or ErrorResponse.\r
 176       </xs:documentation>\r
 177     </xs:annotation>\r
 178     <xs:complexContent>\r
 179       <xs:extension base="core:OCIRequest">\r
 180         <xs:sequence>\r
 181           <xs:element name="serviceUserId" type="UserId"/>\r
 182           <xs:element name="serviceInstanceProfile" type="ServiceInstanceModifyProfile" minOccurs="0"/>\r
 183           <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>\r
 184           <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointModify" nillable="true" minOccurs="0"/>\r
 185         </xs:sequence>\r
 186       </xs:extension>\r
 187     </xs:complexContent>\r
 188   </xs:complexType>    \r
 189     \r
 190 </xs:schema>\r