share/OCISchemaAS/Services/OCISchemaServiceInstantGroupCall.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 <!-- I N S T A N T   G R O U P   C A L 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   <!-- I N S T A N T   G R O U P   C A L L    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     GroupInstantGroupCallAddInstanceRequest14    \r
  35     GroupInstantGroupCallDeleteInstanceRequest    \r
  36     GroupInstantGroupCallGetInstanceListRequest    \r
  37     GroupInstantGroupCallGetInstanceRequest19sp1    \r
  38     GroupInstantGroupCallModifyActiveInstanceListRequest    \r
  39     GroupInstantGroupCallModifyInstanceRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="GroupInstantGroupCallAddInstanceRequest14">\r
  44     <xs:annotation>\r
  45       <xs:documentation>\r
  46         Request to add an Instant Group Call service instance to a group.\r
  47         The domain is required in the serviceUserId.\r
  48         The response is either SuccessResponse or ErrorResponse.\r
  49       </xs:documentation>\r
  50     </xs:annotation>\r
  51     <xs:complexContent>\r
  52       <xs:extension base="core:OCIRequest">\r
  53         <xs:sequence>\r
  54           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  55           <xs:element name="groupId" type="GroupId"/>\r
  56           <xs:element name="serviceUserId" type="UserId"/>\r
  57           <xs:element name="serviceInstanceProfile" type="ServiceInstanceAddProfile"/>\r
  58           <xs:element name="destinationPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0" maxOccurs="unbounded"/>\r
  59           <xs:element name="isAnswerTimeoutEnabled" type="xs:boolean"/>\r
  60           <xs:element name="answerTimeoutMinutes" type="InstantGroupCallAnswerTimeoutMinutes" minOccurs="0"/>\r
  61           <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" 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="GroupInstantGroupCallDeleteInstanceRequest">\r
  68     <xs:annotation>\r
  69       <xs:documentation>\r
  70         Request to delete an Instant Group Call service 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="GroupInstantGroupCallGetInstanceListRequest">\r
  84     <xs:annotation>\r
  85       <xs:documentation>\r
  86         Request to get a list of Instant Group Call service instances within a group.\r
  87         The response is either GroupInstantGroupCallGetInstanceListResponse or ErrorResponse.\r
  88         It is possible to get the service 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="GroupInstantGroupCallGetInstanceListResponse">\r
 103     <xs:annotation>\r
 104       <xs:documentation>\r
 105         Response to the GroupInstantGroupCallGetInstanceListRequest.\r
 106         Contains a 6 column 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="instantGroupCallTable" 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="GroupInstantGroupCallGetInstanceRequest19sp1">\r
 121     <xs:annotation>\r
 122       <xs:documentation>\r
 123         Request to get all the information of an Instant Group Call service instance.\r
 124         The response is either GroupInstantGroupCallGetInstanceResponse19sp1 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="GroupInstantGroupCallGetInstanceResponse19sp1">\r
 137     <xs:annotation>\r
 138       <xs:documentation>\r
 139         Response to GroupInstantGroupCallGetInstanceRequest19sp1.\r
 140         Contains the service profile information and a list of phone numbers.\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="destinationPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0" maxOccurs="unbounded"/>\r
 148           <xs:element name="isAnswerTimeoutEnabled" type="xs:boolean"/>\r
 149           <xs:element name="answerTimeoutMinutes" type="InstantGroupCallAnswerTimeoutMinutes" minOccurs="0"/>\r
 150           <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>\r
 151         </xs:sequence>\r
 152       </xs:extension>\r
 153     </xs:complexContent>\r
 154   </xs:complexType>    \r
 155     \r
 156   <xs:complexType name="GroupInstantGroupCallModifyActiveInstanceListRequest">\r
 157     <xs:annotation>\r
 158       <xs:documentation>\r
 159         Request to set the active status of Instant Group Call service instances.\r
 160         The response is either SuccessResponse or ErrorResponse.\r
 161       </xs:documentation>\r
 162     </xs:annotation>\r
 163     <xs:complexContent>\r
 164       <xs:extension base="core:OCIRequest">\r
 165         <xs:sequence>\r
 166           <xs:element name="serviceActivation" type="ServiceActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 167         </xs:sequence>\r
 168       </xs:extension>\r
 169     </xs:complexContent>\r
 170   </xs:complexType>    \r
 171     \r
 172   <xs:complexType name="GroupInstantGroupCallModifyInstanceRequest">\r
 173     <xs:annotation>\r
 174       <xs:documentation>\r
 175         Request to modify an Instant Group Call service instance.\r
 176         The response is either SuccessResponse or ErrorResponse.\r
 177       </xs:documentation>\r
 178     </xs:annotation>\r
 179     <xs:complexContent>\r
 180       <xs:extension base="core:OCIRequest">\r
 181         <xs:sequence>\r
 182           <xs:element name="serviceUserId" type="UserId"/>\r
 183           <xs:element name="serviceInstanceProfile" type="ServiceInstanceModifyProfile" minOccurs="0"/>\r
 184           <xs:element name="destinationPhoneNumberList" type="ReplacementOutgoingDNorSIPURIList" nillable="true" minOccurs="0"/>\r
 185           <xs:element name="isAnswerTimeoutEnabled" type="xs:boolean" minOccurs="0"/>\r
 186           <xs:element name="answerTimeoutMinutes" type="InstantGroupCallAnswerTimeoutMinutes" nillable="true" minOccurs="0"/>\r
 187           <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>\r
 188         </xs:sequence>\r
 189       </xs:extension>\r
 190     </xs:complexContent>\r
 191   </xs:complexType>    \r
 192     \r
 193   <xs:simpleType name="InstantGroupCallAnswerTimeoutMinutes">\r
 194     <xs:annotation>\r
 195       <xs:documentation>\r
 196         The maximum duration for unanswered call.\r
 197       </xs:documentation>\r
 198     </xs:annotation>\r
 199     <xs:restriction base="xs:int">\r
 200       <xs:minInclusive value="1"/>\r
 201       <xs:maxInclusive value="60"/>\r
 202     </xs:restriction>\r
 203   </xs:simpleType>    \r
 204     \r
 205 </xs:schema>\r