share/OCISchemaAS/Services/OCISchemaServicePreferredCarrier.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 <!-- P R E F E R R E D   C A R R I E R  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   <!-- P R E F E R R E D   C A R R I E R    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     GroupPreferredCarrierGroupGetRequest    \r
  36     GroupPreferredCarrierGroupModifyRequest    \r
  37     ServiceProviderPreferredCarrierAddRequest    \r
  38     ServiceProviderPreferredCarrierDeleteRequest    \r
  39     ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest    \r
  40     ServiceProviderPreferredCarrierGetCarrierListRequest    \r
  41     ServiceProviderPreferredCarrierGetListRequest    \r
  42     ServiceProviderPreferredCarrierGetRequest    \r
  43     ServiceProviderPreferredCarrierModifyRequest    \r
  44     SystemPreferredCarrierAddRequest    \r
  45     SystemPreferredCarrierDeleteRequest    \r
  46     SystemPreferredCarrierGetGroupListRequest    \r
  47     SystemPreferredCarrierGetListRequest    \r
  48     SystemPreferredCarrierGetRequest    \r
  49     SystemPreferredCarrierGetUserListRequest    \r
  50     SystemPreferredCarrierModifyRequest    \r
  51     UserPreferredCarrierUserGetRequest    \r
  52     UserPreferredCarrierUserModifyRequest    \r
  53     \r
  54   --> \r
  55   \r
  56   <xs:complexType name="GroupPreferredCarrierGroupGetRequest">\r
  57     <xs:annotation>\r
  58       <xs:documentation>\r
  59         Requests the currently configured carriers for a group.\r
  60         The response is either a GroupPreferredCarrierGroupGetResponse or an ErrorResponse.\r
  61       </xs:documentation>\r
  62     </xs:annotation>\r
  63     <xs:complexContent>\r
  64       <xs:extension base="core:OCIRequest">\r
  65         <xs:sequence>\r
  66           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  67           <xs:element name="groupId" type="GroupId"/>\r
  68         </xs:sequence>\r
  69       </xs:extension>\r
  70     </xs:complexContent>\r
  71   </xs:complexType>    \r
  72     \r
  73   <xs:complexType name="GroupPreferredCarrierGroupGetResponse">\r
  74     <xs:annotation>\r
  75       <xs:documentation>\r
  76         Response to a GroupPreferredCarrierGroupGetRequest.\r
  77       </xs:documentation>\r
  78     </xs:annotation>\r
  79     <xs:complexContent>\r
  80       <xs:extension base="core:OCIDataResponse">\r
  81         <xs:sequence>\r
  82           <xs:element name="intraLataCarrier" type="GroupPreferredCarrierName"/>\r
  83           <xs:element name="interLataCarrier" type="GroupPreferredCarrierName"/>\r
  84           <xs:element name="internationalCarrier" type="GroupPreferredCarrierName"/>\r
  85         </xs:sequence>\r
  86       </xs:extension>\r
  87     </xs:complexContent>\r
  88   </xs:complexType>    \r
  89     \r
  90   <xs:complexType name="GroupPreferredCarrierGroupModifyRequest">\r
  91     <xs:annotation>\r
  92       <xs:documentation>\r
  93         Modifies the currently configured carriers for a group.\r
  94         The response is either SuccessResponse or ErrorResponse.\r
  95       </xs:documentation>\r
  96     </xs:annotation>\r
  97     <xs:complexContent>\r
  98       <xs:extension base="core:OCIRequest">\r
  99         <xs:sequence>\r
 100           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 101           <xs:element name="groupId" type="GroupId"/>\r
 102           <xs:element name="intraLataCarrier" type="GroupPreferredCarrierNameModify" minOccurs="0"/>\r
 103           <xs:element name="interLataCarrier" type="GroupPreferredCarrierNameModify" minOccurs="0"/>\r
 104           <xs:element name="internationalCarrier" type="GroupPreferredCarrierNameModify" minOccurs="0"/>\r
 105         </xs:sequence>\r
 106       </xs:extension>\r
 107     </xs:complexContent>\r
 108   </xs:complexType>    \r
 109     \r
 110   <xs:complexType name="ServiceProviderPreferredCarrierAddRequest">\r
 111     <xs:annotation>\r
 112       <xs:documentation>\r
 113         Add the country code preferred carriers for a service provider or enterprise. For each\r
 114         combination of service provider and country code, you can assign an intra-lata, inter-lata,\r
 115         and international carrier. Each of the three types of carriers is optional.\r
 116         The response is either a SuccessResponse or an ErrorResponse.\r
 117         Note: At the system level, more than one carrier may be assigned to each country code.\r
 118         At the service provider level, you must choose from the carriers assigned at the system level.\r
 119       </xs:documentation>\r
 120     </xs:annotation>\r
 121     <xs:complexContent>\r
 122       <xs:extension base="core:OCIRequest">\r
 123         <xs:sequence>\r
 124           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 125           <xs:element name="countryCode" type="CountryCode"/>\r
 126           <xs:element name="intraLataCarrier" type="PreferredCarrierName" minOccurs="0"/>\r
 127           <xs:element name="interLataCarrier" type="PreferredCarrierName" minOccurs="0"/>\r
 128           <xs:element name="internationalCarrier" type="PreferredCarrierName" minOccurs="0"/>\r
 129         </xs:sequence>\r
 130       </xs:extension>\r
 131     </xs:complexContent>\r
 132   </xs:complexType>    \r
 133     \r
 134   <xs:complexType name="ServiceProviderPreferredCarrierDeleteRequest">\r
 135     <xs:annotation>\r
 136       <xs:documentation>\r
 137         Delete the country code preferred carriers for a service provider or enterprise.\r
 138         Note that this is different from unassigning all 3 types of carriers with\r
 139         the ServiceProviderPreferredCarrierModifyRequest.\r
 140         The response is either a SuccessResponse or an ErrorResponse.\r
 141         An ErrorResponse will be returned if the country code preferred carriers were never added or\r
 142         were already deleted.\r
 143       </xs:documentation>\r
 144     </xs:annotation>\r
 145     <xs:complexContent>\r
 146       <xs:extension base="core:OCIRequest">\r
 147         <xs:sequence>\r
 148           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 149           <xs:element name="countryCode" type="CountryCode"/>\r
 150         </xs:sequence>\r
 151       </xs:extension>\r
 152     </xs:complexContent>\r
 153   </xs:complexType>    \r
 154     \r
 155   <xs:complexType name="ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest">\r
 156     <xs:annotation>\r
 157       <xs:documentation>\r
 158         Requests the default country code and the list of unused country codes for a service provider / enterprise.\r
 159         The response is either a ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse or an ErrorResponse.\r
 160       </xs:documentation>\r
 161     </xs:annotation>\r
 162     <xs:complexContent>\r
 163       <xs:extension base="core:OCIRequest">\r
 164         <xs:sequence>\r
 165           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 166         </xs:sequence>\r
 167       </xs:extension>\r
 168     </xs:complexContent>\r
 169   </xs:complexType>    \r
 170     \r
 171   <xs:complexType name="ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse">\r
 172     <xs:annotation>\r
 173       <xs:documentation>\r
 174         Response to a ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest.\r
 175         Contains the default country code and the list of unused country codes for a service provider / enterprise.\r
 176       </xs:documentation>\r
 177     </xs:annotation>\r
 178     <xs:complexContent>\r
 179       <xs:extension base="core:OCIDataResponse">\r
 180         <xs:sequence>\r
 181           <xs:element name="defaultCountryCode" type="CountryCode" minOccurs="0"/>\r
 182           <xs:element name="countryCode" type="CountryCode" minOccurs="0" maxOccurs="unbounded"/>\r
 183         </xs:sequence>\r
 184       </xs:extension>\r
 185     </xs:complexContent>\r
 186   </xs:complexType>    \r
 187     \r
 188   <xs:complexType name="ServiceProviderPreferredCarrierGetCarrierListRequest">\r
 189     <xs:annotation>\r
 190       <xs:documentation>\r
 191         Requests the lists of carriers for a specified country code for a service provider / enterprise.\r
 192         The response is either a ServiceProviderPreferredCarrierGetCarrierListResponse or an ErrorResponse.\r
 193       </xs:documentation>\r
 194     </xs:annotation>\r
 195     <xs:complexContent>\r
 196       <xs:extension base="core:OCIRequest">\r
 197         <xs:sequence>\r
 198           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 199           <xs:element name="countryCode" type="CountryCode"/>\r
 200         </xs:sequence>\r
 201       </xs:extension>\r
 202     </xs:complexContent>\r
 203   </xs:complexType>    \r
 204     \r
 205   <xs:complexType name="ServiceProviderPreferredCarrierGetCarrierListResponse">\r
 206     <xs:annotation>\r
 207       <xs:documentation>\r
 208         Response to a ServiceProviderPreferredCarrierGetCarrierListRequest.\r
 209         Contains the lists of carriers for a specified country code for a service provider / enterprise.\r
 210       </xs:documentation>\r
 211     </xs:annotation>\r
 212     <xs:complexContent>\r
 213       <xs:extension base="core:OCIDataResponse">\r
 214         <xs:sequence>\r
 215           <xs:element name="intraLataCarrier" type="PreferredCarrierName" minOccurs="0" maxOccurs="unbounded"/>\r
 216           <xs:element name="interLataCarrier" type="PreferredCarrierName" minOccurs="0" maxOccurs="unbounded"/>\r
 217           <xs:element name="internationalCarrier" type="PreferredCarrierName" minOccurs="0" maxOccurs="unbounded"/>\r
 218         </xs:sequence>\r
 219       </xs:extension>\r
 220     </xs:complexContent>\r
 221   </xs:complexType>    \r
 222     \r
 223   <xs:complexType name="ServiceProviderPreferredCarrierGetListRequest">\r
 224     <xs:annotation>\r
 225       <xs:documentation>\r
 226         Requests a table of all the carriers defined in a specified service provider or enterprise.\r
 227         The response is either a ServiceProviderPreferredCarrierGetListResponse or an ErrorResponse.\r
 228       </xs:documentation>\r
 229     </xs:annotation>\r
 230     <xs:complexContent>\r
 231       <xs:extension base="core:OCIRequest">\r
 232         <xs:sequence>\r
 233           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 234         </xs:sequence>\r
 235       </xs:extension>\r
 236     </xs:complexContent>\r
 237   </xs:complexType>    \r
 238     \r
 239   <xs:complexType name="ServiceProviderPreferredCarrierGetListResponse">\r
 240     <xs:annotation>\r
 241       <xs:documentation>\r
 242         Response to a ServiceProviderPreferredCarrierGetListRequest. Contains a table with one row per carrier.\r
 243         The table columns are: "Country Code", "Intra-Lata PIC", "Inter-Lata PIC", "International PIC".\r
 244       </xs:documentation>\r
 245     </xs:annotation>\r
 246     <xs:complexContent>\r
 247       <xs:extension base="core:OCIDataResponse">\r
 248         <xs:sequence>\r
 249           <xs:element name="serviceProviderCarrierTable" type="core:OCITable"/>\r
 250         </xs:sequence>\r
 251       </xs:extension>\r
 252     </xs:complexContent>\r
 253   </xs:complexType>    \r
 254     \r
 255   <xs:complexType name="ServiceProviderPreferredCarrierGetRequest">\r
 256     <xs:annotation>\r
 257       <xs:documentation>\r
 258         Requests the currently configured carriers for a specified country code for a service provider / enterprise.\r
 259         The response is either a ServiceProviderPreferredCarrierGetResponse or an ErrorResponse.\r
 260       </xs:documentation>\r
 261     </xs:annotation>\r
 262     <xs:complexContent>\r
 263       <xs:extension base="core:OCIRequest">\r
 264         <xs:sequence>\r
 265           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 266           <xs:element name="countryCode" type="CountryCode"/>\r
 267         </xs:sequence>\r
 268       </xs:extension>\r
 269     </xs:complexContent>\r
 270   </xs:complexType>    \r
 271     \r
 272   <xs:complexType name="ServiceProviderPreferredCarrierGetResponse">\r
 273     <xs:annotation>\r
 274       <xs:documentation>\r
 275         Response to a ServiceProviderPreferredCarrierGetRequest.\r
 276         Contains the currently configured carriers for a specified country code for a service provider / enterprise.\r
 277       </xs:documentation>\r
 278     </xs:annotation>\r
 279     <xs:complexContent>\r
 280       <xs:extension base="core:OCIDataResponse">\r
 281         <xs:sequence>\r
 282           <xs:element name="intraLataCarrier" type="PreferredCarrierName" minOccurs="0"/>\r
 283           <xs:element name="interLataCarrier" type="PreferredCarrierName" minOccurs="0"/>\r
 284           <xs:element name="internationalCarrier" type="PreferredCarrierName" minOccurs="0"/>\r
 285         </xs:sequence>\r
 286       </xs:extension>\r
 287     </xs:complexContent>\r
 288   </xs:complexType>    \r
 289     \r
 290   <xs:complexType name="ServiceProviderPreferredCarrierModifyRequest">\r
 291     <xs:annotation>\r
 292       <xs:documentation>\r
 293         Modify the country code preferred carriers for a service provider or enterprise. For each\r
 294         combination of service provider and country code, you can assign an intra-lata, inter-lata,\r
 295         and international carrier. Each of the 3 types of carriers is optional.\r
 296         If an optional carrier is not specified, the assignment will not change.\r
 297         To clear a preferred carrier, set the value to an empty string.\r
 298         The response is either a SuccessResponse or an ErrorResponse.\r
 299         Note: At the system level, more than one carrier may be assigned to each country code.\r
 300         At the service provider level, you must choose from the carriers assigned at the system level.\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="countryCode" type="CountryCode"/>\r
 308           <xs:element name="intraLataCarrier" type="PreferredCarrierName" nillable="true" minOccurs="0"/>\r
 309           <xs:element name="interLataCarrier" type="PreferredCarrierName" nillable="true" minOccurs="0"/>\r
 310           <xs:element name="internationalCarrier" type="PreferredCarrierName" nillable="true" minOccurs="0"/>\r
 311         </xs:sequence>\r
 312       </xs:extension>\r
 313     </xs:complexContent>\r
 314   </xs:complexType>    \r
 315     \r
 316   <xs:complexType name="SystemPreferredCarrierAddRequest">\r
 317     <xs:annotation>\r
 318       <xs:documentation>\r
 319         Add a carrier to the system.\r
 320         More than one carrier may be assigned to each country code.\r
 321         The response is either a SuccessResponse or an ErrorResponse.\r
 322       </xs:documentation>\r
 323     </xs:annotation>\r
 324     <xs:complexContent>\r
 325       <xs:extension base="core:OCIRequest">\r
 326         <xs:sequence>\r
 327           <xs:element name="carrier" type="PreferredCarrierName"/>\r
 328           <xs:element name="cic" type="PreferredCarrierIdCode"/>\r
 329           <xs:element name="countryCode" type="CountryCode"/>\r
 330           <xs:element name="isIntraLata" type="xs:boolean"/>\r
 331           <xs:element name="isInterLata" type="xs:boolean"/>\r
 332           <xs:element name="isInternational" type="xs:boolean"/>\r
 333         </xs:sequence>\r
 334       </xs:extension>\r
 335     </xs:complexContent>\r
 336   </xs:complexType>    \r
 337     \r
 338   <xs:complexType name="SystemPreferredCarrierDeleteRequest">\r
 339     <xs:annotation>\r
 340       <xs:documentation>\r
 341         Delete a carrier from the system.\r
 342         The response is either a SuccessResponse or an ErrorResponse.\r
 343         An ErrorResponse is returned if the carrier is in use, or if the carrier didn't exist prior to deletion..\r
 344       </xs:documentation>\r
 345     </xs:annotation>\r
 346     <xs:complexContent>\r
 347       <xs:extension base="core:OCIRequest">\r
 348         <xs:sequence>\r
 349           <xs:element name="carrier" type="PreferredCarrierName"/>\r
 350         </xs:sequence>\r
 351       </xs:extension>\r
 352     </xs:complexContent>\r
 353   </xs:complexType>    \r
 354     \r
 355   <xs:complexType name="SystemPreferredCarrierGetGroupListRequest">\r
 356     <xs:annotation>\r
 357       <xs:documentation>\r
 358         Requests a list of groups using the specified carrier.  It is possible to restrict the\r
 359         number of rows returned by specifying various search criteria. Multiple search criteria\r
 360         are logically ANDed together.\r
 361         The response is either a SystemPreferredCarrierGetGroupListResponse or an ErrorResponse.\r
 362       </xs:documentation>\r
 363     </xs:annotation>\r
 364     <xs:complexContent>\r
 365       <xs:extension base="core:OCIRequest">\r
 366         <xs:sequence>\r
 367           <xs:element name="carrier" type="PreferredCarrierName"/>\r
 368           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 369           <xs:element name="searchCriteriaGroupId" type="SearchCriteriaGroupId" minOccurs="0" maxOccurs="unbounded"/>\r
 370           <xs:element name="searchCriteriaGroupName" type="SearchCriteriaGroupName" minOccurs="0" maxOccurs="unbounded"/>\r
 371           <xs:element name="searchCriteriaExactServiceProvider" type="SearchCriteriaExactServiceProvider" minOccurs="0" maxOccurs="1"/>\r
 372         </xs:sequence>\r
 373       </xs:extension>\r
 374     </xs:complexContent>\r
 375   </xs:complexType>    \r
 376     \r
 377   <xs:complexType name="SystemPreferredCarrierGetGroupListResponse">\r
 378     <xs:annotation>\r
 379       <xs:documentation>\r
 380         Response to a SystemPreferredCarrierGetGroupListRequest.\r
 381         Contains a table with one row per group.\r
 382         The table columns are: "Group Id", "Group Name", "Organization Id", "Organization Type".\r
 383         The "Organization Id" column is populated with either a service provider Id or an enterprise Id.\r
 384         The "Organization Type" column is populated with one of the enumerated strings defined in the\r
 385         OrganizationType OCI data type.  Please see OCISchemaDataTypes.xsd for details on OrganizationType.\r
 386       </xs:documentation>\r
 387     </xs:annotation>\r
 388     <xs:complexContent>\r
 389       <xs:extension base="core:OCIDataResponse">\r
 390         <xs:sequence>\r
 391           <xs:element name="groupsUsingCarrierTable" type="core:OCITable"/>\r
 392         </xs:sequence>\r
 393       </xs:extension>\r
 394     </xs:complexContent>\r
 395   </xs:complexType>    \r
 396     \r
 397   <xs:complexType name="SystemPreferredCarrierGetListRequest">\r
 398     <xs:annotation>\r
 399       <xs:documentation>\r
 400         Requests a table of all the carriers defined in the system.\r
 401         The response is either a SystemPreferredCarrierGetListResponse\r
 402         or an ErrorResponse.\r
 403       </xs:documentation>\r
 404     </xs:annotation>\r
 405     <xs:complexContent>\r
 406       <xs:extension base="core:OCIRequest">\r
 407         <xs:sequence/>\r
 408       </xs:extension>\r
 409     </xs:complexContent>\r
 410   </xs:complexType>    \r
 411     \r
 412   <xs:complexType name="SystemPreferredCarrierGetListResponse">\r
 413     <xs:annotation>\r
 414       <xs:documentation>\r
 415         Response to a SystemPreferredCarrierGetListRequest. Contains a table with one row per carrier.\r
 416         The table columns are: "Carrier", "Country Code", "CIC", "Is Intra-Lata", "Is Inter-Lata", "Is International".\r
 417         The value in the "Is Intra-Lata", "Is Inter-Lata", and "Is International" columns is one of "true" or "false".\r
 418       </xs:documentation>\r
 419     </xs:annotation>\r
 420     <xs:complexContent>\r
 421       <xs:extension base="core:OCIDataResponse">\r
 422         <xs:sequence>\r
 423           <xs:element name="systemCarrierTable" type="core:OCITable"/>\r
 424         </xs:sequence>\r
 425       </xs:extension>\r
 426     </xs:complexContent>\r
 427   </xs:complexType>    \r
 428     \r
 429   <xs:complexType name="SystemPreferredCarrierGetRequest">\r
 430     <xs:annotation>\r
 431       <xs:documentation>\r
 432         Requests the attributes of carrier.\r
 433         The response is either a SystemPreferreredCarrierGetResponse or an ErrorResponse.\r
 434       </xs:documentation>\r
 435     </xs:annotation>\r
 436     <xs:complexContent>\r
 437       <xs:extension base="core:OCIRequest">\r
 438         <xs:sequence>\r
 439           <xs:element name="carrier" type="PreferredCarrierName"/>\r
 440         </xs:sequence>\r
 441       </xs:extension>\r
 442     </xs:complexContent>\r
 443   </xs:complexType>    \r
 444     \r
 445   <xs:complexType name="SystemPreferredCarrierGetResponse">\r
 446     <xs:annotation>\r
 447       <xs:documentation>\r
 448         Response to a SystemPreferredCarrierGetRequest.\r
 449         Contains the attributes of a carrier.\r
 450       </xs:documentation>\r
 451     </xs:annotation>\r
 452     <xs:complexContent>\r
 453       <xs:extension base="core:OCIDataResponse">\r
 454         <xs:sequence>\r
 455           <xs:element name="cic" type="PreferredCarrierIdCode"/>\r
 456           <xs:element name="countryCode" type="CountryCode"/>\r
 457           <xs:element name="isIntraLata" type="xs:boolean"/>\r
 458           <xs:element name="isInterLata" type="xs:boolean"/>\r
 459           <xs:element name="isInternational" type="xs:boolean"/>\r
 460         </xs:sequence>\r
 461       </xs:extension>\r
 462     </xs:complexContent>\r
 463   </xs:complexType>    \r
 464     \r
 465   <xs:complexType name="SystemPreferredCarrierGetUserListRequest">\r
 466     <xs:annotation>\r
 467       <xs:documentation>\r
 468         Requests a list of users using the specified carrier.  It is possible to restrict the\r
 469         number of rows returned by specifying various search criteria. Multiple search criteria\r
 470         are logically ANDed together.\r
 471         The response is either a SystemPreferreredCarrierGetUserListResponse\r
 472         or an ErrorResponse.\r
 473       </xs:documentation>\r
 474     </xs:annotation>\r
 475     <xs:complexContent>\r
 476       <xs:extension base="core:OCIRequest">\r
 477         <xs:sequence>\r
 478           <xs:element name="carrier" type="PreferredCarrierName"/>\r
 479           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 480           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 481           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 482           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 483           <xs:element name="searchCriteriaEmailAddress" type="SearchCriteriaEmailAddress" minOccurs="0" maxOccurs="unbounded"/>\r
 484           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 485           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 486         </xs:sequence>\r
 487       </xs:extension>\r
 488     </xs:complexContent>\r
 489   </xs:complexType>    \r
 490     \r
 491   <xs:complexType name="SystemPreferredCarrierGetUserListResponse">\r
 492     <xs:annotation>\r
 493       <xs:documentation>\r
 494         Response to a SystemPreferredCarrierGetUserListRequest.\r
 495         Contains a table with one row per user.\r
 496         The table columns are: "User Id", "Service Provider Id", "Group Id", "Last Name", "First Name", "Phone Number", "Email Address",\r
 497         "Hiragana Last Name", and "Hiragana First Name", "Extension", "Department".\r
 498       </xs:documentation>\r
 499     </xs:annotation>\r
 500     <xs:complexContent>\r
 501       <xs:extension base="core:OCIDataResponse">\r
 502         <xs:sequence>\r
 503           <xs:element name="usersUsingCarrierTable" type="core:OCITable"/>\r
 504         </xs:sequence>\r
 505       </xs:extension>\r
 506     </xs:complexContent>\r
 507   </xs:complexType>    \r
 508     \r
 509   <xs:complexType name="SystemPreferredCarrierModifyRequest">\r
 510     <xs:annotation>\r
 511       <xs:documentation>\r
 512         Modify the attributes of a carrier.\r
 513         The response is either a SuccessResponse or an ErrorResponse.\r
 514         An ErrorResponse is returned if countryCode modification is attempted while the carrier is assigned to a service provider.\r
 515         An ErrorResponse is returned if an attempt to set isIntraLata to false is made while the carrier is used as an intra-LATA carrier.\r
 516         An ErrorResponse is returned if an attempt to set isInternational to false is made while the carrier is used as an international carrier.\r
 517       </xs:documentation>\r
 518     </xs:annotation>\r
 519     <xs:complexContent>\r
 520       <xs:extension base="core:OCIRequest">\r
 521         <xs:sequence>\r
 522           <xs:element name="carrier" type="PreferredCarrierName"/>\r
 523           <xs:element name="cic" type="PreferredCarrierIdCode" minOccurs="0"/>\r
 524           <xs:element name="countryCode" type="CountryCode" minOccurs="0"/>\r
 525           <xs:element name="isIntraLata" type="xs:boolean" minOccurs="0"/>\r
 526           <xs:element name="isInterLata" type="xs:boolean" minOccurs="0"/>\r
 527           <xs:element name="isInternational" type="xs:boolean" minOccurs="0"/>\r
 528         </xs:sequence>\r
 529       </xs:extension>\r
 530     </xs:complexContent>\r
 531   </xs:complexType>    \r
 532     \r
 533   <xs:complexType name="UserPreferredCarrierUserGetRequest">\r
 534     <xs:annotation>\r
 535       <xs:documentation>\r
 536         Requests the currently configured preferred carriers for a user.\r
 537         The response is either a UserPreferredCarrierUserGetResponse or an ErrorResponse.\r
 538       </xs:documentation>\r
 539     </xs:annotation>\r
 540     <xs:complexContent>\r
 541       <xs:extension base="core:OCIRequest">\r
 542         <xs:sequence>\r
 543           <xs:element name="userId" type="UserId"/>\r
 544         </xs:sequence>\r
 545       </xs:extension>\r
 546     </xs:complexContent>\r
 547   </xs:complexType>    \r
 548     \r
 549   <xs:complexType name="UserPreferredCarrierUserGetResponse">\r
 550     <xs:annotation>\r
 551       <xs:documentation>\r
 552         Response to a UserPreferredCarrierUserGetRequest.\r
 553       </xs:documentation>\r
 554     </xs:annotation>\r
 555     <xs:complexContent>\r
 556       <xs:extension base="core:OCIDataResponse">\r
 557         <xs:sequence>\r
 558           <xs:element name="intraLataCarrier" type="UserPreferredCarrierName"/>\r
 559           <xs:element name="interLataCarrier" type="UserPreferredCarrierName"/>\r
 560           <xs:element name="internationalCarrier" type="UserPreferredCarrierName"/>\r
 561         </xs:sequence>\r
 562       </xs:extension>\r
 563     </xs:complexContent>\r
 564   </xs:complexType>    \r
 565     \r
 566   <xs:complexType name="UserPreferredCarrierUserModifyRequest">\r
 567     <xs:annotation>\r
 568       <xs:documentation>\r
 569         Modifies the currently configured preferred carriers for a user.\r
 570         The response is either SuccessResponse or ErrorResponse.\r
 571       </xs:documentation>\r
 572     </xs:annotation>\r
 573     <xs:complexContent>\r
 574       <xs:extension base="core:OCIRequest">\r
 575         <xs:sequence>\r
 576           <xs:element name="userId" type="UserId"/>\r
 577           <xs:element name="intraLataCarrier" type="UserPreferredCarrierNameModify" minOccurs="0"/>\r
 578           <xs:element name="interLataCarrier" type="UserPreferredCarrierNameModify" minOccurs="0"/>\r
 579           <xs:element name="internationalCarrier" type="UserPreferredCarrierNameModify" minOccurs="0"/>\r
 580         </xs:sequence>\r
 581       </xs:extension>\r
 582     </xs:complexContent>\r
 583   </xs:complexType>    \r
 584     \r
 585   <xs:complexType name="GroupPreferredCarrierName">\r
 586     <xs:annotation>\r
 587       <xs:documentation>\r
 588         Group can either use it's service provider/enterprise's preferred carrier or use it's own.\r
 589         The group carrier name is exposed if it was previously configured.\r
 590       </xs:documentation>\r
 591     </xs:annotation>\r
 592     <xs:sequence>\r
 593       <xs:element name="useServiceProviderPreferredCarrier" type="xs:boolean"/>\r
 594       <xs:element name="carrier" type="PreferredCarrierName" minOccurs="0"/>\r
 595     </xs:sequence>\r
 596   </xs:complexType>    \r
 597     \r
 598   <xs:complexType name="GroupPreferredCarrierNameModify">\r
 599     <xs:annotation>\r
 600       <xs:documentation>\r
 601         Group can either use it's service provider/enterprise's preferred carrier or use it's own.\r
 602         You can use the Service Provider preferred carrier without clearing the group\r
 603         carrier name -- in this case, the group carrier name is retained.\r
 604       </xs:documentation>\r
 605     </xs:annotation>\r
 606     <xs:sequence>\r
 607       <xs:element name="useServiceProviderPreferredCarrier" type="xs:boolean"/>\r
 608       <xs:element name="carrier" type="PreferredCarrierName" nillable="true" minOccurs="0"/>\r
 609     </xs:sequence>\r
 610   </xs:complexType>    \r
 611     \r
 612   <xs:simpleType name="PreferredCarrierIdCode">\r
 613     <xs:annotation>\r
 614       <xs:documentation>A digit code used by network signaling to identifiy a carrier.</xs:documentation>\r
 615     </xs:annotation>\r
 616     <xs:restriction base="xs:token">\r
 617       <xs:minLength value="1"/>\r
 618       <xs:maxLength value="6"/>\r
 619     </xs:restriction>\r
 620   </xs:simpleType>    \r
 621     \r
 622   <xs:simpleType name="PreferredCarrierName">\r
 623     <xs:annotation>\r
 624       <xs:documentation>Uniquely identifies a carrier.</xs:documentation>\r
 625     </xs:annotation>\r
 626     <xs:restriction base="xs:token">\r
 627       <xs:minLength value="1"/>\r
 628       <xs:maxLength value="80"/>\r
 629     </xs:restriction>\r
 630   </xs:simpleType>    \r
 631     \r
 632   <xs:complexType name="UserPreferredCarrierName">\r
 633     <xs:annotation>\r
 634       <xs:documentation>\r
 635         User can either use it's group's preferred carrier or use it's own.\r
 636         The user carrier name is exposed if it was previously configured.\r
 637       </xs:documentation>\r
 638     </xs:annotation>\r
 639     <xs:sequence>\r
 640       <xs:element name="useGroupPreferredCarrier" type="xs:boolean"/>\r
 641       <xs:element name="carrier" type="PreferredCarrierName" minOccurs="0"/>\r
 642     </xs:sequence>\r
 643   </xs:complexType>    \r
 644     \r
 645   <xs:complexType name="UserPreferredCarrierNameModify">\r
 646     <xs:annotation>\r
 647       <xs:documentation>\r
 648         User can either use it's group's preferred carrier or use it's own.\r
 649         You can use the group's preferred carrier without clearing the user carrier name --\r
 650         in this case, the user carrier name is retained.\r
 651       </xs:documentation>\r
 652     </xs:annotation>\r
 653     <xs:sequence>\r
 654       <xs:element name="useGroupPreferredCarrier" type="xs:boolean"/>\r
 655       <xs:element name="carrier" type="PreferredCarrierName" nillable="true" minOccurs="0"/>\r
 656     </xs:sequence>\r
 657   </xs:complexType>    \r
 658     \r
 659 </xs:schema>\r