XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations belong to this schema's target namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
Default namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
core C
Schema Component Representation
<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:import namespace="C" schemaLocation="../OCISchemaBASE.xsd"/>
<xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>
<xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: GroupPreferredCarrierGroupGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupPreferredCarrierGroupGetRequest
Abstract no
Documentation Requests the currently configured carriers for a group. The response is either a GroupPreferredCarrierGroupGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupPreferredCarrierGroupGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupPreferredCarrierGroupGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupPreferredCarrierGroupGetResponse
Abstract no
Documentation Response to a GroupPreferredCarrierGroupGetRequest.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<intraLataCarrier> GroupPreferredCarrierName </intraLataCarrier> [1]
<interLataCarrier> GroupPreferredCarrierName </interLataCarrier> [1]
<internationalCarrier> GroupPreferredCarrierName </internationalCarrier> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupPreferredCarrierGroupGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="intraLataCarrier" type=" GroupPreferredCarrierName "/>
<xs:element name="interLataCarrier" type=" GroupPreferredCarrierName "/>
<xs:element name="internationalCarrier" type=" GroupPreferredCarrierName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupPreferredCarrierGroupModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupPreferredCarrierGroupModifyRequest
Abstract no
Documentation Modifies the currently configured carriers for a group. The response is either SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
<intraLataCarrier> GroupPreferredCarrierNameModify </intraLataCarrier> [0..1]
<interLataCarrier> GroupPreferredCarrierNameModify </interLataCarrier> [0..1]
<internationalCarrier> GroupPreferredCarrierNameModify </internationalCarrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupPreferredCarrierGroupModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
<xs:element name="intraLataCarrier" type=" GroupPreferredCarrierNameModify " minOccurs="0"/>
<xs:element name="interLataCarrier" type=" GroupPreferredCarrierNameModify " minOccurs="0"/>
<xs:element name="internationalCarrier" type=" GroupPreferredCarrierNameModify " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupPreferredCarrierName

Parent type: None
Sub-types: None
Name GroupPreferredCarrierName
Abstract no
Documentation Group can either use it's service provider/enterprise's preferred carrier or use it's own. The group carrier name is exposed if it was previously configured.
XML Instance Representation
<...>
<useServiceProviderPreferredCarrier> xs:boolean </useServiceProviderPreferredCarrier> [1]
<carrier> PreferredCarrierName </carrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupPreferredCarrierName">
<xs:sequence>
<xs:element name="useServiceProviderPreferredCarrier" type=" xs:boolean "/>
<xs:element name="carrier" type=" PreferredCarrierName " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GroupPreferredCarrierNameModify

Parent type: None
Sub-types: None
Name GroupPreferredCarrierNameModify
Abstract no
Documentation Group can either use it's service provider/enterprise's preferred carrier or use it's own. You can use the Service Provider preferred carrier without clearing the group carrier name -- in this case, the group carrier name is retained.
XML Instance Representation
<...>
<useServiceProviderPreferredCarrier> xs:boolean </useServiceProviderPreferredCarrier> [1]
<carrier> PreferredCarrierName </carrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupPreferredCarrierNameModify">
<xs:sequence>
<xs:element name="useServiceProviderPreferredCarrier" type=" xs:boolean "/>
<xs:element name="carrier" type=" PreferredCarrierName " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierAddRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierAddRequest
Abstract no
Documentation Add the country code preferred carriers for a service provider or enterprise. For each combination of service provider and country code, you can assign an intra-lata, inter-lata, and international carrier. Each of the three types of carriers is optional. The response is either a SuccessResponse or an ErrorResponse. Note: At the system level, more than one carrier may be assigned to each country code. At the service provider level, you must choose from the carriers assigned at the system level.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<countryCode> CountryCode </countryCode> [1]
<intraLataCarrier> PreferredCarrierName </intraLataCarrier> [0..1]
<interLataCarrier> PreferredCarrierName </interLataCarrier> [0..1]
<internationalCarrier> PreferredCarrierName </internationalCarrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierAddRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="countryCode" type=" CountryCode "/>
<xs:element name="intraLataCarrier" type=" PreferredCarrierName " minOccurs="0"/>
<xs:element name="interLataCarrier" type=" PreferredCarrierName " minOccurs="0"/>
<xs:element name="internationalCarrier" type=" PreferredCarrierName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierDeleteRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierDeleteRequest
Abstract no
Documentation Delete the country code preferred carriers for a service provider or enterprise. Note that this is different from unassigning all 3 types of carriers with the ServiceProviderPreferredCarrierModifyRequest. The response is either a SuccessResponse or an ErrorResponse. An ErrorResponse will be returned if the country code preferred carriers were never added or were already deleted.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<countryCode> CountryCode </countryCode> [1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierDeleteRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="countryCode" type=" CountryCode "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest
Abstract no
Documentation Requests the default country code and the list of unused country codes for a service provider / enterprise. The response is either a ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse
Abstract no
Documentation Response to a ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest. Contains the default country code and the list of unused country codes for a service provider / enterprise.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<defaultCountryCode> CountryCode </defaultCountryCode> [0..1]
<countryCode> CountryCode </countryCode> [0..*]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="defaultCountryCode" type=" CountryCode " minOccurs="0"/>
<xs:element name="countryCode" type=" CountryCode " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetCarrierListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetCarrierListRequest
Abstract no
Documentation Requests the lists of carriers for a specified country code for a service provider / enterprise. The response is either a ServiceProviderPreferredCarrierGetCarrierListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<countryCode> CountryCode </countryCode> [1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetCarrierListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="countryCode" type=" CountryCode "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetCarrierListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetCarrierListResponse
Abstract no
Documentation Response to a ServiceProviderPreferredCarrierGetCarrierListRequest. Contains the lists of carriers for a specified country code for a service provider / enterprise.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<intraLataCarrier> PreferredCarrierName </intraLataCarrier> [0..*]
<interLataCarrier> PreferredCarrierName </interLataCarrier> [0..*]
<internationalCarrier> PreferredCarrierName </internationalCarrier> [0..*]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetCarrierListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="intraLataCarrier" type=" PreferredCarrierName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="interLataCarrier" type=" PreferredCarrierName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="internationalCarrier" type=" PreferredCarrierName " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetListRequest
Abstract no
Documentation Requests a table of all the carriers defined in a specified service provider or enterprise. The response is either a ServiceProviderPreferredCarrierGetListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetListResponse
Abstract no
Documentation Response to a ServiceProviderPreferredCarrierGetListRequest. Contains a table with one row per carrier. The table columns are: "Country Code", "Intra-Lata PIC", "Inter-Lata PIC", "International PIC".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderCarrierTable> core:OCITable </serviceProviderCarrierTable> [1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="serviceProviderCarrierTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetRequest
Abstract no
Documentation Requests the currently configured carriers for a specified country code for a service provider / enterprise. The response is either a ServiceProviderPreferredCarrierGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<countryCode> CountryCode </countryCode> [1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="countryCode" type=" CountryCode "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierGetResponse
Abstract no
Documentation Response to a ServiceProviderPreferredCarrierGetRequest. Contains the currently configured carriers for a specified country code for a service provider / enterprise.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<intraLataCarrier> PreferredCarrierName </intraLataCarrier> [0..1]
<interLataCarrier> PreferredCarrierName </interLataCarrier> [0..1]
<internationalCarrier> PreferredCarrierName </internationalCarrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="intraLataCarrier" type=" PreferredCarrierName " minOccurs="0"/>
<xs:element name="interLataCarrier" type=" PreferredCarrierName " minOccurs="0"/>
<xs:element name="internationalCarrier" type=" PreferredCarrierName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServiceProviderPreferredCarrierModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name ServiceProviderPreferredCarrierModifyRequest
Abstract no
Documentation Modify the country code preferred carriers for a service provider or enterprise. For each combination of service provider and country code, you can assign an intra-lata, inter-lata, and international carrier. Each of the 3 types of carriers is optional. If an optional carrier is not specified, the assignment will not change. To clear a preferred carrier, set the value to an empty string. The response is either a SuccessResponse or an ErrorResponse. Note: At the system level, more than one carrier may be assigned to each country code. At the service provider level, you must choose from the carriers assigned at the system level.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<countryCode> CountryCode </countryCode> [1]
<intraLataCarrier> PreferredCarrierName </intraLataCarrier> [0..1]
<interLataCarrier> PreferredCarrierName </interLataCarrier> [0..1]
<internationalCarrier> PreferredCarrierName </internationalCarrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="ServiceProviderPreferredCarrierModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="countryCode" type=" CountryCode "/>
<xs:element name="intraLataCarrier" type=" PreferredCarrierName " nillable="true" minOccurs="0"/>
<xs:element name="interLataCarrier" type=" PreferredCarrierName " nillable="true" minOccurs="0"/>
<xs:element name="internationalCarrier" type=" PreferredCarrierName " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierAddRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierAddRequest
Abstract no
Documentation Add a carrier to the system. More than one carrier may be assigned to each country code. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<carrier> PreferredCarrierName </carrier> [1]
<cic> PreferredCarrierIdCode </cic> [1]
<countryCode> CountryCode </countryCode> [1]
<isIntraLata> xs:boolean </isIntraLata> [1]
<isInterLata> xs:boolean </isInterLata> [1]
<isInternational> xs:boolean </isInternational> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierAddRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="carrier" type=" PreferredCarrierName "/>
<xs:element name="cic" type=" PreferredCarrierIdCode "/>
<xs:element name="countryCode" type=" CountryCode "/>
<xs:element name="isIntraLata" type=" xs:boolean "/>
<xs:element name="isInterLata" type=" xs:boolean "/>
<xs:element name="isInternational" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierDeleteRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierDeleteRequest
Abstract no
Documentation Delete a carrier from the system. The response is either a SuccessResponse or an ErrorResponse. An ErrorResponse is returned if the carrier is in use, or if the carrier didn't exist prior to deletion..
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<carrier> PreferredCarrierName </carrier> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierDeleteRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="carrier" type=" PreferredCarrierName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetGroupListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetGroupListRequest
Abstract no
Documentation Requests a list of groups using the specified carrier. It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together. The response is either a SystemPreferredCarrierGetGroupListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<carrier> PreferredCarrierName </carrier> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaGroupId> SearchCriteriaGroupId </searchCriteriaGroupId> [0..*]
<searchCriteriaGroupName> SearchCriteriaGroupName </searchCriteriaGroupName> [0..*]
<searchCriteriaExactServiceProvider> SearchCriteriaExactServiceProvider </searchCriteriaExactServiceProvider> [0..1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetGroupListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="carrier" type=" PreferredCarrierName "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaGroupId" type=" SearchCriteriaGroupId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaGroupName" type=" SearchCriteriaGroupName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactServiceProvider" type=" SearchCriteriaExactServiceProvider " minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetGroupListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetGroupListResponse
Abstract no
Documentation Response to a SystemPreferredCarrierGetGroupListRequest. Contains a table with one row per group. The table columns are: "Group Id", "Group Name", "Organization Id", "Organization Type". The "Organization Id" column is populated with either a service provider Id or an enterprise Id. The "Organization Type" column is populated with one of the enumerated strings defined in the OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<groupsUsingCarrierTable> core:OCITable </groupsUsingCarrierTable> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetGroupListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="groupsUsingCarrierTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetListRequest
Abstract no
Documentation Requests a table of all the carriers defined in the system. The response is either a SystemPreferredCarrierGetListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetListResponse
Abstract no
Documentation Response to a SystemPreferredCarrierGetListRequest. Contains a table with one row per carrier. The table columns are: "Carrier", "Country Code", "CIC", "Is Intra-Lata", "Is Inter-Lata", "Is International". The value in the "Is Intra-Lata", "Is Inter-Lata", and "Is International" columns is one of "true" or "false".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<systemCarrierTable> core:OCITable </systemCarrierTable> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="systemCarrierTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetRequest
Abstract no
Documentation Requests the attributes of carrier. The response is either a SystemPreferreredCarrierGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<carrier> PreferredCarrierName </carrier> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="carrier" type=" PreferredCarrierName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetResponse
Abstract no
Documentation Response to a SystemPreferredCarrierGetRequest. Contains the attributes of a carrier.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<cic> PreferredCarrierIdCode </cic> [1]
<countryCode> CountryCode </countryCode> [1]
<isIntraLata> xs:boolean </isIntraLata> [1]
<isInterLata> xs:boolean </isInterLata> [1]
<isInternational> xs:boolean </isInternational> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="cic" type=" PreferredCarrierIdCode "/>
<xs:element name="countryCode" type=" CountryCode "/>
<xs:element name="isIntraLata" type=" xs:boolean "/>
<xs:element name="isInterLata" type=" xs:boolean "/>
<xs:element name="isInternational" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetUserListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetUserListRequest
Abstract no
Documentation Requests a list of users using the specified carrier. It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together. The response is either a SystemPreferreredCarrierGetUserListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<carrier> PreferredCarrierName </carrier> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetUserListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="carrier" type=" PreferredCarrierName "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierGetUserListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierGetUserListResponse
Abstract no
Documentation Response to a SystemPreferredCarrierGetUserListRequest. Contains a table with one row per user. The table columns are: "User Id", "Service Provider Id", "Group Id", "Last Name", "First Name", "Phone Number", "Email Address", "Hiragana Last Name", and "Hiragana First Name", "Extension", "Department".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<usersUsingCarrierTable> core:OCITable </usersUsingCarrierTable> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierGetUserListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="usersUsingCarrierTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemPreferredCarrierModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemPreferredCarrierModifyRequest
Abstract no
Documentation Modify the attributes of a carrier. The response is either a SuccessResponse or an ErrorResponse. An ErrorResponse is returned if countryCode modification is attempted while the carrier is assigned to a service provider. An ErrorResponse is returned if an attempt to set isIntraLata to false is made while the carrier is used as an intra-LATA carrier. An ErrorResponse is returned if an attempt to set isInternational to false is made while the carrier is used as an international carrier.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<carrier> PreferredCarrierName </carrier> [1]
<cic> PreferredCarrierIdCode </cic> [0..1]
<countryCode> CountryCode </countryCode> [0..1]
<isIntraLata> xs:boolean </isIntraLata> [0..1]
<isInterLata> xs:boolean </isInterLata> [0..1]
<isInternational> xs:boolean </isInternational> [0..1]
</...>
Schema Component Representation
<xs:complexType name="SystemPreferredCarrierModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="carrier" type=" PreferredCarrierName "/>
<xs:element name="cic" type=" PreferredCarrierIdCode " minOccurs="0"/>
<xs:element name="countryCode" type=" CountryCode " minOccurs="0"/>
<xs:element name="isIntraLata" type=" xs:boolean " minOccurs="0"/>
<xs:element name="isInterLata" type=" xs:boolean " minOccurs="0"/>
<xs:element name="isInternational" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPreferredCarrierName

Parent type: None
Sub-types: None
Name UserPreferredCarrierName
Abstract no
Documentation User can either use it's group's preferred carrier or use it's own. The user carrier name is exposed if it was previously configured.
XML Instance Representation
<...>
<useGroupPreferredCarrier> xs:boolean </useGroupPreferredCarrier> [1]
<carrier> PreferredCarrierName </carrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPreferredCarrierName">
<xs:sequence>
<xs:element name="useGroupPreferredCarrier" type=" xs:boolean "/>
<xs:element name="carrier" type=" PreferredCarrierName " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: UserPreferredCarrierNameModify

Parent type: None
Sub-types: None
Name UserPreferredCarrierNameModify
Abstract no
Documentation User can either use it's group's preferred carrier or use it's own. You can use the group's preferred carrier without clearing the user carrier name -- in this case, the user carrier name is retained.
XML Instance Representation
<...>
<useGroupPreferredCarrier> xs:boolean </useGroupPreferredCarrier> [1]
<carrier> PreferredCarrierName </carrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPreferredCarrierNameModify">
<xs:sequence>
<xs:element name="useGroupPreferredCarrier" type=" xs:boolean "/>
<xs:element name="carrier" type=" PreferredCarrierName " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: UserPreferredCarrierUserGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPreferredCarrierUserGetRequest
Abstract no
Documentation Requests the currently configured preferred carriers for a user. The response is either a UserPreferredCarrierUserGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPreferredCarrierUserGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPreferredCarrierUserGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPreferredCarrierUserGetResponse
Abstract no
Documentation Response to a UserPreferredCarrierUserGetRequest.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<intraLataCarrier> UserPreferredCarrierName </intraLataCarrier> [1]
<interLataCarrier> UserPreferredCarrierName </interLataCarrier> [1]
<internationalCarrier> UserPreferredCarrierName </internationalCarrier> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPreferredCarrierUserGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="intraLataCarrier" type=" UserPreferredCarrierName "/>
<xs:element name="interLataCarrier" type=" UserPreferredCarrierName "/>
<xs:element name="internationalCarrier" type=" UserPreferredCarrierName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPreferredCarrierUserModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPreferredCarrierUserModifyRequest
Abstract no
Documentation Modifies the currently configured preferred carriers for a user. The response is either SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<intraLataCarrier> UserPreferredCarrierNameModify </intraLataCarrier> [0..1]
<interLataCarrier> UserPreferredCarrierNameModify </interLataCarrier> [0..1]
<internationalCarrier> UserPreferredCarrierNameModify </internationalCarrier> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPreferredCarrierUserModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="intraLataCarrier" type=" UserPreferredCarrierNameModify " minOccurs="0"/>
<xs:element name="interLataCarrier" type=" UserPreferredCarrierNameModify " minOccurs="0"/>
<xs:element name="internationalCarrier" type=" UserPreferredCarrierNameModify " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: PreferredCarrierIdCode

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name PreferredCarrierIdCode
Content
  • Base XSD Type: token
  • length >= 1
Documentation A digit code used by network signaling to identifiy a carrier.
Schema Component Representation
<xs:simpleType name="PreferredCarrierIdCode">
<xs:restriction base=" xs:token ">
<xs:minLength value="1"/>
<xs:maxLength value="6"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PreferredCarrierName

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name PreferredCarrierName
Content
  • Base XSD Type: token
  • length >= 1
Documentation Uniquely identifies a carrier.
Schema Component Representation
<xs:simpleType name="PreferredCarrierName">
<xs:restriction base=" xs:token ">
<xs:minLength value="1"/>
<xs:maxLength value="80"/>
</xs:restriction>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Parent type: Address (derivation method: extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top