BCE Provisioning over CAI3G

Ericsson Dynamic Activation 1

1	Introduction
1.1	Purpose and Scope
1.2	Target Groups
1.3	Typographic Conventions
1.4	Prerequisites
1.5	Web Service Interface
1.6	MOType
1.7	MOId
2	Company
2.1	Creating a Company
2.2	Deleting a Company
2.3	Setting a Company
2.4	Getting a Company
3	OrganizationUnit
3.1	Creating an OrganizationUnit
3.2	Deleting an OrganizationUnit
3.3	Setting an OrganizationUnit
3.4	Getting an OrganizationUnit
4	Users
4.1	Creating a User
4.2	Deleting a User
4.3	Setting a User
4.4	Getting a User
5	Auto Attendant
5.1	Creating an Auto Attendant
5.2	Deleting an Auto Attendant
5.3	Setting an Auto Attendant
5.4	Getting an Auto Attendant
6	Audio Conference
6.1	Creating an Audio Conference
6.2	Deleting an Audio Conference
6.3	Setting an Audio Conference
6.4	Getting an Audio Conference
7	Call Distribution Group
7.1	Creating a Call Distribution Group
7.2	Deleting a Call Distribution Group
7.3	Setting a Call Distribution Group
7.4	Getting a Call Distribution Group
8	Call Barring Profile
8.1	Creating a Call Barring Profile
8.2	Deleting a Call Barring Profile
8.3	Setting a Call Barring Profile
8.4	Getting a Call Barring Profile
9	Connection Profile
9.1	Creating a Connection Profile
9.2	Deleting a Connection Profile
9.3	Setting a Connection Profile
9.4	Getting a Connection Profile
10	BCE File
10.1	Deleting a BCE File
10.2	Setting a BCE File
10.3	Getting a BCE File
11	Company File
11.1	Creating a Company File
11.2	Deleting a Company File
11.3	Getting a Company File
12	Error Code
Reference List

1 Introduction

This section contains information about the prerequisites, purpose, scope, and target group for the document. This section also contains information about typographic conventions used in this document.

1.1 Purpose and Scope

This document describes the supported Customers Service Orders (CSOs) in the CAI3G interface which is used for provisioning of Business Communication Enabler (BCE).

Note:: This document is not a tutorial of CAI3G, it must be used together with document Generic CAI3G Interface 1.2, Reference [2].

1.2 Target Groups

The target group for this document is as follows:

System Integrator

For more information about the different target groups, see Library Overview, Reference [1].

1.3 Typographic Conventions

Typographic conventions are described in the document Library Overview, Reference [1].

1.4 Prerequisites

This document is written with the assumption that the users:

Have basic knowledge about the Ericsson Dynamic Activation (EDA) product.
Have knowledge about Generic CAI3G Interface 1.2, Reference [2].

1.5 Web Service Interface

The Web Services Definition Language (WSDL) and XML Schema Definition Language (XSD) files that describe the provisioning interface can be found in /home/dveinstaller/da/. It is also possible to download the files and view or store them in an appropriate area by following below instruction:

Save the zip file, Multi_Activation_WSDL_ and_ XSD_ files.zip, to a local folder.
Unpack the zip file.

1.6 MOType

MOType is a plain text string based on the type xs:string. An MOType consists of two parts. One is the namespace of the MO, and the other is the MO name string that is always starting with an alphabetical character in either upper or lower case, followed by zero or more alphabetical characters, digits or underscores.

Those two parts are connected with symbol @. The syntax of the MOType string is MO_Name@MO_Namespace. The name string of an MOType must follow the regular expression: [A-Za-z][A-Za-z0-9]*

The MO name together with the MO namespace must be globally unique.

1.7 MOId

MOId is an XML fragment containing the MOId parameter-value pairs that are used to identify an MO instance in the interface data model. CAI3G 1.2 standard supports compound MO identifiers or multiple MO identifier. The following is an example of an MOId:

Example 1 Example of MOId

<MOId>
   <msisdn>46455395000</msisdn>
   <imsi>46234563545000</imsi>
</MOId>

The MOId is defined as a sequence of xs:any element in CAI3G schema file. It is the developers responsibility to define the real schema for this parameter.

The MOId is also the key attributes that must be defined in the top-level element, CreateMODefinition or SetMODefinition, within MOAttributes parameter.

Each implementation of CAI3G interface is to define own logic relationship of MOId. It is also the CAI3GAgents responsibility to interpret this parameter correctly by either the hard-coded logic or the dynamic parsing of the schema.

2 Company

2.1 Creating a Company

This section describes how to create a Company.

MOType

Company@http://schemas.ericsson.com/ma/bce/

2.1.1 Request Data

MOId

Table 1 MOID Parameters of Creating a Company
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1

MOAttributes

Table 2 MOAttributes of Creating a Company
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`name`		The name of the Company String minLength value="1" maxLength value="100"	Mandatory	eda
`description`		The description of the Company String maxLength value="255"	Optional	EDA_Test
`address`		The address of the Company	Optional
	`StreetAddress`	The street address of the Company String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the Company String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the Company String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the Company String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the Company String minLength value="1" maxLength value="255"	Optional	CHN
`domain`		The domain of the Company String minLength value="1" maxLength value="100"	Optional	Data
`searchCountLimit`		The limit times of searching the Company int minOccurs="0"	Optional	3
`companySetting`		sub-MO
	`name`	The name of the sub-MO `companySetting` String minLength value="1" maxLength value="20"	Optional	Ericsson
	`value`	The value of the sub-MO `companySetting` String minOccurs="0"	Optional	EDA
`DirectoryName`		sub-MO
	`name`	The name of the sub-MO `DirectoryName` String minLength value="1" maxLength value="100"	Optional	name
	`default`	Indicates whether the sub-MO `DirectoryName` is default or not. Boolean minOccurs="0"	Optional	true
	`minpartialmatch`	int minOccurs="0"	Optional	1
	`connectionProfileId`	String minLength value="1" maxLength value="100"	Optional	1
`companyAnnouncements`		sub-MO
	`name`	The name of the sub-MO `companyAnnouncements` String minOccurs="0"	Optional	CDG_WELCOME
	`fileId`	The file ID of the sub-MO `companyAnnouncements` long minOccurs="0"	Optional	1281

2.1.2 Example

An example for creating a Company is as follows:

Example 2 Creating a Company

Request:
<cai3:Create>
        <cai3:MOType>
             Company@http://schemas.ericsson.com/ma/bce/
        </cai3:MOType>
        <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createCompany serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_2}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
               <bce:name>BIG_company</bce:name>
               <bce:description>EMA_Test</bce:description>
               <bce:address>
                  <bce:StreetAddress>West Tianshan Road</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>Shanghai</bce:City>
                  <bce:Region>RNEA</bce:Region>
                  <bce:Country>CHN</bce:Country>
               </bce:address>
               <bce:domain>Data</bce:domain>
               <bce:searchCountLimit>3</bce:searchCountLimit>
               <!--Zero or more repetitions:-->
               <bce:companySetting name="Ericsson">
                  <bce:name>Ericsson</bce:name>
                  <bce:value>EMA</bce:value>
               </bce:companySetting>
               <!--Zero or more repetitions:-->
               <bce:directory name="DirectoryName">
                  <bce:name>DirectoryName</bce:name>
                  <bce:default>true</bce:default>
                  <bce:minpartialmatch>1</bce:minpartialmatch>
                  <bce:connectionProfileId>1</bce:connectionProfileId>
               </bce:directory>
               <!--Zero or more repetitions:-->
               <bce:companyAnnouncements name="CDG_WELCOME">
                  <bce:name>CDG_WELCOME</bce:name>
                  <bce:fileId>1281</bce:fileId>
               </bce:companyAnnouncements>
               <!--Zero or more repetitions:-->
            </bce:createCompany>
         </cai3:MOAttributes>
</cai3:Create>

2.2 Deleting a Company

This section describes how to delete a Company.

MOType

Company@http://schemas.ericsson.com/ma/bce/

2.2.1 Request Data

MOId

Table 3 MOID Parameters of Deleting a Company
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1

2.2.2 Example

An example for deleting a Company is as follows:

Example 3 Deleting a Company

Request:
<cai3:Delete>
       <cai3:MOType>Company@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
       <cai3:MOId>
           <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
           <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
       </cai3:MOId>
</cai3:Delete>

2.3 Setting a Company

This section describes how to set a Company.

MOType

Company@http://schemas.ericsson.com/ma/bce/

2.3.1 Request Data

MOId

Table 4 MOID Parameters of Setting a Company
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1

MOAttributes

Table 5 MOAttributes of Setting a Company
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`name`		The name of the Company String minLength value="1" maxLength value="100"	Mandatory	eda
`description`		The description of the Company String maxLength value="255"	Optional	EDA_Test
`address`		The address of the Company	Optional
	`StreetAddress`	The street address of the Company String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the Company String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the Company String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the Company String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the Company String minLength value="1" maxLength value="255"	Optional	CHN
`domain`		The domain of the Company String minLength value="1" maxLength value="100"	Optional	Data
`searchCountLimit`		The limit times of searching the Company int minOccurs="0"	Optional	3
`companySetting`		sub-MO
	`name`	The name of the sub-MO `companySetting` String minLength value="1" maxLength value="20"	Optional	Ericsson
	`value`	The value of the sub-MO `companySetting` String minOccurs="0"	Optional	EDA
`DirectoryName`		sub-MO
	`name`	The name of the sub-MO `DirectoryName` String minLength value="1" maxLength value="100"	Optional	name
	`default`	Indicates whether the sub-MO `DirectoryName` is default or not. Boolean minOccurs="0"	Optional	true
	`minpartialmatch`	int minOccurs="0"	Optional	1
	`connectionProfileId`	String minLength value="1" maxLength value="100"	Optional	1
`companyAnnouncements`		sub-MO
	`name`	The name of the sub-MO `companyAnnouncements` String minOccurs="0"	Optional	CDG_WELCOME
	`fileId`	The file ID of the sub-MO `companyAnnouncements` long minOccurs="0"	Optional	1281
`activeCallBarringProfileIds`		sub-MO
	`id`	The ID of the sub-MO `activeCallBarringProfileIds` String minLength value="1" maxLength value="20"	Optional	8881

2.3.2 Example

An example for setting a Company is as follows:

Example 4 Setting a Company

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Company@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setCompany serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:name>${Properties#CompanyId_1}_update</bce:name>
               <bce:description>ema_1_update</bce:description>
               <bce:address>
                  <bce:StreetAddress>tianshanroad_new</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>shanghai</bce:City>
                  <bce:Region>rnea</bce:Region>
                  <bce:Country>china</bce:Country>
               </bce:address>
               <bce:domain>data</bce:domain>
               <bce:searchCountLimit>3</bce:searchCountLimit>
               <!--Zero or more repetitions:-->
               <bce:companySetting name="CDG_AGENT_BUSY_TIMEOUT">
                  <bce:name>CDG_AGENT_BUSY_TIMEOUT</bce:name>
                  <bce:value>50</bce:value>
               </bce:companySetting>
               <!--Zero or more repetitions:-->
               <bce:directory name="ema1directory">
                  <bce:name>ema1directory</bce:name>
                  <bce:default>true</bce:default>
                  <bce:minpartialmatch>0</bce:minpartialmatch>
                  <bce:connectionProfileId>default</bce:connectionProfileId>
               </bce:directory>
               <!--Zero or more repetitions:-->
               <bce:companyAnnouncements name="CDG_WELCOME">
                  <bce:name>CDG_WELCOME</bce:name>
                  <bce:fileId>1</bce:fileId>
               </bce:companyAnnouncements>
               <!--Zero or more repetitions:-->
               <bce:activeCallBarringProfileIds id="ema111">
                  <bce:id>ema111</bce:id>
               </bce:activeCallBarringProfileIds>
            </bce:setCompany>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

2.4 Getting a Company

This section describes how to get a Company.

MOType

Company@http://schemas.ericsson.com/ma/bce/

2.4.1 Request Data

MOId

Table 6 MOID Parameters of Getting a Company
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1

MOAttributes

Table 7 MOAttributes of Getting a Company
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`name`		The name of the Company String minLength value="1" maxLength value="100"	Mandatory	eda
`description`		The description of the Company String maxLength value="255"	Optional	EDA_Test
`address`		The address of the Company	Optional
	`StreetAddress`	The street address of the Company String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the Company String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the Company String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the Company String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the Company String minLength value="1" maxLength value="255"	Optional	CHN
`domain`		The domain of the Company String minLength value="1" maxLength value="100"	Optional	Data
`searchCountLimit`		The limit times of searching the Company int minOccurs="0"	Optional	3
`directory`		sub-MO	Optional
	`name`	The name of the sub-MO `DirectoryName` String minLength value="1" maxLength value="100"	Optional	name
	`default`	Indicates whether the sub-MO directory is default or not. Boolean minOccurs="0"	Optional	true
	`minpartialmatch`	int minOccurs="0"	Optional	1
	`connectionProfileId`	String minLength value="1" maxLength value="100"	Optional	1
`activeCallBarringProfileIds`		sub-MO	Optional
	`id`	The ID of the sub-MO `activeCallBarringProfileIds` String minLength value="1" maxLength value="20"	Optional	8881
`companySetting`		sub-MO
	`name`	The name of the sub-MO `companySetting` String minLength value="1" maxLength value="20"	Optional	Ericsson
	`value`	The value of the sub-MO `companySetting` String minOccurs="0"	Optional	EDA
`cdgIds`		The ID of a CDG service for one specific Company String minOccurs="0"	Optional	cdg1_ema2
`autoAttendantIds`		The ID of an auto attendant service for one specific Company String minOccurs="0"	Optional	autoattend1_ema2
`audioConferencIds`		The ID of an audio conference service for one specific Company String minOccurs="0"	Optional	audioconf2_ema2
`companyAdminIds`		Admin User ID for one specific Company String minOccurs="0"	Optional	eda
`definedCallBarringProfileIds`		The ID of a barring profile defined for one specific Company String minOccurs="0"	Optional	8882

2.4.2 Example

An example for getting a Company is as follows:

Example 5 Getting a Company

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Company@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
         </cai3:MOId>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>57ed411553ac471c901f9e47f7208ad4</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getCompanyResponse companyId="ema_2" serviceProviderId="sp-tcv" 
              xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema_2</bce:companyId>
               <bce:name>ema_2</bce:name>
               <bce:description>EMA_Test</bce:description>
               <bce:address>
                  <bce:StreetAddress>West Tianshan Road</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>Shanghai</bce:City>
                  <bce:Region>RNEA</bce:Region>
                  <bce:Country>CHN</bce:Country>
               </bce:address>
               <bce:domain>Data</bce:domain>
               <bce:searchCountLimit>3</bce:searchCountLimit>
               <bce:directory name="DirectoryName">
                  <bce:name>DirectoryName</bce:name>
                  <bce:default>true</bce:default>
                  <bce:minpartialmatch>1</bce:minpartialmatch>
                  <bce:connectionProfileId>default</bce:connectionProfileId>
               </bce:directory>
               <bce:activeCallBarringProfileIds id="11112">
                  <bce:id>11112</bce:id>
               </bce:activeCallBarringProfileIds>
               <bce:activeCallBarringProfileIds id="11113">
                  <bce:id>11113</bce:id>
               </bce:activeCallBarringProfileIds>
               <bce:activeCallBarringProfileIds id="11111">
                  <bce:id>11111</bce:id>
               </bce:activeCallBarringProfileIds>
               <bce:companySetting name="AA_TIMEOUT">
                  <bce:name>AA_TIMEOUT</bce:name>
                  <bce:value>60</bce:value>
               </bce:companySetting>
               <bce:companySetting name="CDG_AGENT_BUSY_TIMEOUT">
                  <bce:name>CDG_AGENT_BUSY_TIMEOUT</bce:name>
                  <bce:value>20</bce:value>
               </bce:companySetting>
               <bce:companySetting name="CDG_AGENT_UNAVAILABLE_TIMEOUT">
                  <bce:name>CDG_AGENT_UNAVAILABLE_TIMEOUT</bce:name>
                  <bce:value>20</bce:value>
               </bce:companySetting>
               <bce:companySetting 
                 name="COH_SMS_REMINDER_TIME_BEFORE_START">
                  <bce:name>COH_SMS_REMINDER_TIME_BEFORE_START
                  </bce:name>
                  <bce:value>900</bce:value>
               </bce:companySetting>
               <bce:companySetting name="COH_SMS_REMINDER_ENABLED">
                  <bce:name>COH_SMS_REMINDER_ENABLED</bce:name>
                  <bce:value>true</bce:value>
               </bce:companySetting>
               <bce:companySetting name="CDG_AGENT_TIMED_OUT_TIMEOUT">
                  <bce:name>CDG_AGENT_TIMED_OUT_TIMEOUT</bce:name>
                  <bce:value>20</bce:value>
               </bce:companySetting>
               <bce:companySetting 
                 name="RESTRICTED_SHORT_NUMBERS_PATTERN">
                  <bce:name>RESTRICTED_SHORT_NUMBERS_PATTERN</bce:name>
                  <bce:value/>
               </bce:companySetting>
               <bce:companySetting name="CDG_NO_ANSWER_TIMEOUT">
                  <bce:name>CDG_NO_ANSWER_TIMEOUT</bce:name>
                  <bce:value>10</bce:value>
               </bce:companySetting>
               <bce:companySetting name="PNP_ATTACH_CODE_LENGTH">
                  <bce:name>PNP_ATTACH_CODE_LENGTH</bce:name>
                  <bce:value>3</bce:value>
               </bce:companySetting>
               <bce:companySetting name="CDG_AGENT_CANCEL_TIMEOUT">
                  <bce:name>CDG_AGENT_CANCEL_TIMEOUT</bce:name>
                  <bce:value>0</bce:value>
               </bce:companySetting>
               <bce:companySetting 
                 name="CDG_INTERMITTENT_QUEUE_MESSAGE_INTERVAL">
                  <bce:name>CDG_INTERMITTENT_QUEUE_MESSAGE_INTERVAL
                  </bce:name>
                  <bce:value>20</bce:value>
               </bce:companySetting>
               <bce:companySetting name="COH_MIN_PIN_CODE_LENGTH">
                  <bce:name>COH_MIN_PIN_CODE_LENGTH</bce:name>
                  <bce:value>8</bce:value>
               </bce:companySetting>
               <bce:cdgIds>cdg3_ema2</bce:cdgIds>
               <bce:cdgIds>cdg1_ema2</bce:cdgIds>
               <bce:cdgIds>cdg2_ema2</bce:cdgIds>
               <bce:autoAttendantIds>autoattend1_ema2</bce:autoAttendantIds>
               <bce:autoAttendantIds>autoattend2_ema2</bce:autoAttendantIds>
               <bce:autoAttendantIds>autoattend3_ema2</bce:autoAttendantIds>
               <bce:audioConferencIds>audioconf2_ema2</bce:audioConferencIds>
               <bce:audioConferencIds>audioconf1_ema2</bce:audioConferencIds>
               <bce:audioConferencIds>audioconf3_ema2</bce:audioConferencIds>
            </bce:getCompanyResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

3 OrganizationUnit

3.1 Creating an OrganizationUnit

This section describes how to create an OrganizationUnit.

MOType

OrganizationUnit@http://schemas.ericsson.com/ma/bce/

3.1.1 Request Data

MOId

Table 8 MOID Parameters of Creating an OrganizationUnit
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site

MOAttributes

Table 9 MOAttributes of Creating an OrganizationUnit
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`organizationUnitId`		The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site
`name`		The name of the organizationUnit String minLength value="1" maxLength value="100"	Mandatory	eda-company1-site2
`description`		The description of the organizationUnit String maxLength value="255"	Optional	eda-or_ description
`address`		The address of the organizationUnit	Optional
	`StreetAddress`	The street address of the organizationUnit String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the organizationUnit String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the organizationUnit String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the organizationUnit String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the organizationUnit String minLength value="1" maxLength value="255"	Optional	CHN
`type`		The type of the organizationUnit String minLength value="1" maxLength value="40"	Optional	site
`attachCode`		The attachCode of the organizationUnit String	Optional	123
`callBarringProfileIds`		Group IDs for call barring	Optional
	`ids`	The ID of callBarringProfile	Optional	222

3.1.2 Example

An example for creating an OrganizationUnit is as follows:

Example 6 Creating an OrganizationUnit

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>OrganizationUnit@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
            </bce:organizationUnitId>
            <bce:organizationUnitId>${Properties#OrganizationUnitId_dep1}
            </bce:organizationUnitId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createOrganizationUnit serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" 
              organizationUnitId="${Properties#OrganizationUnitId_dep1}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <!--1 to 6 repetitions:-->
               <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
               </bce:organizationUnitId>
               <bce:organizationUnitId>${Properties#OrganizationUnitId_dep1}
               </bce:organizationUnitId>
               <bce:name>${Properties#OrganizationUnitId_dep1}</bce:name>
               <bce:description>${Properties#OrganizationUnitId_dep1}</bce:description>
               <bce:address>
                  <bce:StreetAddress>minhang strict</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>nanjing</bce:City>
                  <bce:Region>RNEA</bce:Region>
                  <bce:Country>CHN</bce:Country>
               </bce:address>
               <bce:type>department</bce:type>
               <bce:callBarringProfileIds>
                  <!--Zero or more repetitions:-->
                  <bce:ids>2223</bce:ids>
               </bce:callBarringProfileIds>
            </bce:createOrganizationUnit>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

3.2 Deleting an OrganizationUnit

This section describes how to delete an OrganizationUnit.

MOType

OrganizationUnit@http://schemas.ericsson.com/ma/bce/

3.2.1 Request Data

MOId

Table 10 MOID Parameters of Deleting an OrganizationUnit
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site

MOAttributes

Table 11 MOAttributes of Deleting an OrganizationUnit
Parameter	Type	Occurrence	Example
`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site

3.2.2 Example

An example for deleting an OrganizationUnit is as follows:

Example 7 Deleting an OrganizationUnit

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
  xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>OrganizationUnit@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
            </bce:organizationUnitId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:deleteOrganizationUnit>
               <!--1 to 6 repetitions:-->
               <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
               </bce:organizationUnitId>
               <bce:organizationUnitId>${Properties#OrganizationUnitId_dep1}
               </bce:organizationUnitId>
            </bce:deleteOrganizationUnit>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

3.3 Setting an OrganizationUnit

This section describes how to set an OrganizationUnit.

MOType

OrganizationUnit@http://schemas.ericsson.com/ma/bce/

3.3.1 Request Data

MOId

Table 12 MOID Parameters of Setting a OrganizationUnit
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site

MOAttributes

Table 13 MOAttributes of Setting an OrganizationUnit
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`organizationUnitId`		The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site
`name`		The name of the organizationUnit String minLength value="1" maxLength value="100"	Optional	eda-company1-site2
`description`		The description of the organizationUnit String maxLength value="255"	Optional	eda-or_ description
`address`		The address of the organizationUnit	Optional
	`StreetAddress`	The street address of the organizationUnit String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the organizationUnit String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the organizationUnit String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the organizationUnit String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the organizationUnit String minLength value="1" maxLength value="255"	Optional	CHN
`type`		The type of the organizationUnit String minLength value="1" maxLength value="40"	Optional	site
`attachCode`		The attachCode of the organizationUnit String	Optional	123
`callBarringProfileIds`		Group IDs for call barring	Optional
	`ids`	The ID of callBarringProfile	Optional	222

3.3.2 Example

An example for setting an OrganizationUnit is as follows:

Example 8 Setting an OrganizationUnit

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>OrganizationUnit@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
            </bce:organizationUnitId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setOrganizationUnit serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" 
              organizationUnitId="${Properties#OrganizationUnitId_site1}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <!--1 to 6 repetitions:-->
               <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
               </bce:organizationUnitId>
               <bce:name>${Properties#OrganizationUnitId_site1}_update</bce:name>
               <bce:description>${Properties#OrganizationUnitId_site1}_update
               </bce:description>
               <bce:address>
                  <bce:StreetAddress>West Tianshan Road_update</bce:StreetAddress>
                  <bce:ZipCode>200335_1</bce:ZipCode>
                  <bce:City>Shanghai_update</bce:City>
                  <bce:Region>RNEA_update</bce:Region>
                  <bce:Country>CHN_update</bce:Country>
               </bce:address>
               <bce:type>site</bce:type>
               <!--0 to 6 repetitions:-->
               <bce:attachCode>111</bce:attachCode>
               <bce:callBarringProfileIds>
                  <!--Zero or more repetitions:-->
                  <bce:ids>2221</bce:ids>
                  <bce:ids>2222</bce:ids>
                  <bce:ids>2223</bce:ids>
               </bce:callBarringProfileIds>
            </bce:setOrganizationUnit>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

3.4 Getting an OrganizationUnit

This section describes how to get an OrganizationUnit.

MOType

OrganizationUnit@http://schemas.ericsson.com/ma/bce/

3.4.1 Request Data

MOId

Table 14 MOID Parameters of Getting an OrganizationUnit
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the OrganizationUnit String minLength value="1" maxLength value="20"	Mandatory	eda_1
`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site

MOAttributes

Table 15 MOAttributes of Getting an OrganizationUnit Request
Parameter	Type	Occurrence	Example
`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Mandatory	eda-company1-site

3.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 9.

3.4.3 Example

An example for getting an OrganizationUnit is as follows:

Example 9 Getting an OrganizationUnit

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>OrganizationUnit@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
            </bce:organizationUnitId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:getOrganizationUnit>
               <!--1 to 6 repetitions:-->
               <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
               </bce:organizationUnitId>
               <bce:organizationUnitId>${Properties#OrganizationUnitId_dep2}
               </bce:organizationUnitId>
            </bce:getOrganizationUnit>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>17ec57e9d0b34ded8a82d391a403d766</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getOrganizationUnitResponse companyId="ema-company1" 
              organizationUnitId="ema-company1-site1" serviceProviderId="sp-tcv" 
              xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema-company1</bce:companyId>
               <bce:organizationUnitId>ema-company1-site1</bce:organizationUnitId>
               <bce:organizationUnitId>ema-company1-dep1</bce:organizationUnitId>
               <bce:name>ema-company1-dep1</bce:name>
               <bce:description>ema-company1-dep1</bce:description>
               <bce:address>
                  <bce:StreetAddress>minhang strict</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>nanjing</bce:City>
                  <bce:Region>RNEA</bce:Region>
                  <bce:Country>CHN</bce:Country>
               </bce:address>
               <bce:type>department</bce:type>
               <bce:callBarringProfileIds>
                  <bce:ids>2223</bce:ids>
               </bce:callBarringProfileIds>
               <bce:inheritedAttachCode>111</bce:inheritedAttachCode>
            </bce:getOrganizationUnitResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

4 Users

4.1 Creating a User

This section describes how to create a User.

MOType

User@http://schemas.ericsson.com/ma/bce/

4.1.1 Request Data

MOId

Table 16 MOID Parameters of Creating a User
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`userId`	The ID of the User String minLength value="1" maxLength value="20"	Mandatory	22088113

MOAttributes

Table 17 MOAttributes of Creating a User
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`userId`		The ID of the User String minLength value="1" maxLength value="20"	Mandatory	22088113
`organizationUnitIds`		Group IDs for organizationUnits	Optional
	`operationType`	The type of operation	Optional	UPDATE
	`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Optional	eda-organizationUnit-1
`sipAddress`		The complex type of the address	Mandatory
	`SipUri`	The URI address of the User String	Mandatory	sip:22088113@tcv.ics.se
	`Type`	The type of the User String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Mandatory	PUBLIC_ID
	`Default`	Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Mandatory	true
`shortNumber`		The shortNumber of the User String Pattern value= "[0-9]{2,5}"	Optional	27113
`firstName`		The first name of the user String maxLength value="40"	Optional	Terry
`lastName`		The last name of the user String maxLength value="40"	Optional	Tao
`password`		The password of the user String minLengthvalue="6" maxLength value="255"	Mandatory	11111111
`expirePassword`		Indicates whether the password will be expired. Boolean value="true" or "false"	Optional	true
`email`		The email address of the user String	Optional	Terry.Tao@ericsson.com
`active`		Indicates whether the user is active or not. Boolean value="true" or "false"	Optional	true
`nonTelephonyUser`		Boolean value="true" or "false"	Optional	true
`contactAdministrator`		Boolean value="true" or "false"	Optional	true
`administrator`		Boolean value="true" or "false"	Optional	false
`systemAdministrator`		Boolean value="true" or "false"	Optional	false
`clientEnum`		The type of client String enumeration value="MOBILE" enumeration value="PC"	Optional	PC
`userName`		The user name String minLengthvalue="1" maxLength value="255"	Mandatory	22088113
`location`		The location of user String minLengthvalue="1" maxLength value="255"	Optional	shanghai
`locationAddress`		The complex type of the location address	Optional
	`StreetAddress`	The street address of the organizationUnit String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the organizationUnit String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the organizationUnit String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the organizationUnit String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the organizationUnit String minLength value="1" maxLength value="255"	Optional	China
`skills`		The skill of the user String minLength value="1" maxLength value="255"	Optional	test
`role`		The role of the user String minLength value="1" maxLength value="255"	Optional	verification engineer
`webUrl`		The web URI address of the user String minLength value="1" maxLength value="255"	Optional	www.ericsson.com
`fax`		The fax number of the user String minLength value="1" maxLength value="20"	Optional	12344112
`title`		The title of the user String minLength value="1" maxLength value="255"	Optional	verification engineer
`department`		The department of the user String minLength value="1" maxLength value="255"	Optional	CBC/XLEG
`externalId`		The external ID of the user String minLength value="1" maxLength value="100"	Optional	23

4.1.2 Example

An example for creating a User is as follows:

Example 10 Creating a User

Request:
<cai3:Create>
         <cai3:MOType>User@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:userId>${Properties#User_1}</bce:userId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createUser serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" userId="${Properties#User_1}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:userId>${Properties#User_1}</bce:userId>
               <bce:organizationUnitIds>
                  <bce:operationType>UPDATE</bce:operationType>
                  <!--0 to 3 repetitions:-->
                  <bce:organizationUnitId>${Properties#OrganizationUnitId_site1}
                  </bce:organizationUnitId>
               </bce:organizationUnitIds>
               <!--0 to 10 repetitions:-->
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:22088111@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>27111</bce:shortNumber>
               <bce:firstName>michelle</bce:firstName>
               <bce:lastName>wang</bce:lastName>
               <bce:password>111111</bce:password>
               <bce:expirePassword>false</bce:expirePassword>
               <bce:email>michelle.wang@ericsson.com</bce:email>
               <bce:active>true</bce:active>
               <bce:nonTelephonyUser>false</bce:nonTelephonyUser>
               <bce:contactAdministrator>false</bce:contactAdministrator>
               <bce:administrator>false</bce:administrator>
               <bce:systemAdministrator>false</bce:systemAdministrator>
               <!--Zero or more repetitions:-->
               <bce:clientEnum>PC</bce:clientEnum>
               <bce:userName>${Properties#User_1}</bce:userName>
               <bce:location>shanghai</bce:location>
               <bce:locationAddress>
                  <bce:StreetAddress>tianshan road_michelle</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>shanghai</bce:City>
                  <bce:Region>RNEA</bce:Region>
                  <bce:Country>china</bce:Country>
               </bce:locationAddress>
               <bce:skills>test</bce:skills>
               <bce:role>verification engineer</bce:role>
               <bce:webUrl>www.ericsson.com</bce:webUrl>
               <bce:fax>22087555</bce:fax>
               <bce:title>verification engineer</bce:title>
               <bce:department>cbc/xleg</bce:department>
               <bce:externalId>1</bce:externalId>
            </bce:createUser>
         </cai3:MOAttributes>
</cai3:Create>

4.2 Deleting a User

This section describes how to delete a User.

MOType

User@http://schemas.ericsson.com/ma/bce/

4.2.1 Request Data

MOId

Table 18 MOID Parameters of Deleting a User
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`userId`	The ID of the User String minLength value="1" maxLength value="20"	Mandatory	22088113

4.2.2 Example

An example for deleting a User is as follows:

Example 11 Deleting a User

Request:
<cai3:Delete>
         <cai3:MOType>User@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:userId>${Properties#User_1}</bce:userId>
         </cai3:MOId>
</cai3:Delete>

4.3 Setting a User

This section describes how to set a User.

MOType

User@http://schemas.ericsson.com/ma/bce/

4.3.1 Request Data

MOId

Table 19 MOID Parameters of Setting a User
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`userId`	The ID of the User String minLength value="1" maxLength value="20"	Mandatory	22088113

MOAttributes

Table 20 MOAttributes of Setting a User
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`userId`		The ID of the User String minLength value="1" maxLength value="20"	Mandatory	22088113
`organizationUnitIds`		Group IDs for organizationUnits	Optional
	`operationType`	The type of operation	Optional	UPDATE
	`organizationUnitId`	The ID of the organizationUnit String minLength value="1" maxLength value="40"	Optional	eda-organizationUnit-1
`sipAddress`		The complex type of the address	Mandatory
	`SipUri`	The URI address of the User String	Mandatory	sip:22088113@tcv.ics.se
	`Type`	The type of the User String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Mandatory	PUBLIC_ID
	`Default`	Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Mandatory	true
`shortNumber`		The shortNumber of the User String Pattern value= "[0-9]{2,5}"	Optional	27113
`firstName`		The first name of the user String maxLength value="40"	Optional	Terry
`lastName`		The last name of the user String maxLength value="40"	Optional	Tao
`password`		The password of the user String minLengthvalue="6" maxLength value="255"	Mandatory	11111111
`expirePassword`		Indicates whether the password will be expired. Boolean value="true" or "false"	Optional	true
`email`		The email address of the user String	Optional	Terry.Tao@ericsson.com
`active`		Indicates whether the user is active or not. Boolean value="true" or "false"	Optional	true
`nonTelephonyUser`		Boolean value="true" or "false"	Optional	true
`contactAdministrator`		Boolean value="true" or "false"	Optional	true
`administrator`		Boolean value="true" or "false"	Optional	false
`systemAdministrator`		Boolean value="true" or "false"	Optional	false
`clientEnum`		The type of client String enumeration value="MOBILE" enumeration value="PC"	Optional	PC
`userName`		The user name String minLengthvalue="1" maxLength value="255"	Mandatory	22088113
`location`		The location of user String minLengthvalue="1" maxLength value="255"	Optional	shanghai
`locationAddress`		The complex type of the location address	Optional
	`StreetAddress`	The street address of the organizationUnit String minLength value="1" maxLength value="255"	Optional	West Tianshan Road
	`ZipCode`	The zip code of the organizationUnit String minLength value="1" maxLength value="10"	Optional	200335
	`City`	The city of the organizationUnit String minLength value="1" maxLength value="255"	Optional	Shanghai
	`Region`	The region of the organizationUnit String minLength value="1" maxLength value="255"	Optional	RNEA
	`Country`	The country of the organizationUnit String minLength value="1" maxLength value="255"	Optional	China
`skills`		The skill of the user String minLength value="1" maxLength value="255"	Optional	test
`role`		The role of the user String minLength value="1" maxLength value="255"	Optional	verification engineer
`webUrl`		The web URI address of the user String minLength value="1" maxLength value="255"	Optional	www.ericsson.com
`fax`		The fax number of the user String minLength value="1" maxLength value="20"	Optional	12344112
`title`		The title of the user String minLength value="1" maxLength value="255"	Optional	verification engineer
`department`		The department of the user String minLength value="1" maxLength value="255"	Optional	CBC/XLEG
`externalId`		The external ID of the user String minLength value="1" maxLength value="100"	Optional	23

4.3.2 Example

An example for setting a User is as follows:

Example 12 Setting a User

      <cai3:Set>
         <cai3:MOType>User@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:userId>${Properties#User_1}</bce:userId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setUser serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" userId="${Properties#User_1}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:userId>${Properties#User_1}</bce:userId>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:22088111@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>tel:+861865664345</bce:SipUri>
                  <bce:Type>MOBILE</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>2208</bce:shortNumber>
               <bce:firstName>Michelle_new</bce:firstName>
               <bce:lastName>Jin</bce:lastName>
               <bce:password>3333333333</bce:password>
               <bce:expirePassword>true</bce:expirePassword>
               <bce:email/>
               <bce:active>false</bce:active>
            </bce:setUser>
         </cai3:MOAttributes>
      </cai3:Set>

4.4 Getting a User

This section describes how to get a User.

MOType

User@http://schemas.ericsson.com/ma/bce/

4.4.1 Request Data

MOId

Table 21 MOID Parameters of Getting a User
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`userId`	The ID of the User String minLength value="1" maxLength value="20"	Mandatory	22088113

4.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 17.

4.4.3 Example

An example for getting a User is as follows:

Example 13 Getting a User

Request:
<cai3:Get>
         <cai3:MOType>User@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:userId>${Properties#User_2}</bce:userId>
         </cai3:MOId>
</cai3:Get>

Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>50df275ad9ef44dfbd17b3669b40d43c</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getUserResponse companyId="ema-company_user_12"
             serviceProviderId="sp-tcv" userId="2208811133"
             xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema-company_user_12</bce:companyId>
               <bce:userId>2208811133</bce:userId>
               <bce:organizationUnitIds>
                  <bce:organizationUnitId>ema1-user_site1</bce:organizationUnitId>
               </bce:organizationUnitIds>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:2208811331@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>27111</bce:shortNumber>
               <bce:firstName>michelle</bce:firstName>
               <bce:lastName>wang</bce:lastName>
               <bce:password>{SHA-512}6eUqg5iKxLIWk16pZx4TsSvt1KPh62BAR6JAYBBafHp4QJNTDptIhe86uEA9H4Nuo8H+twzJ/QNbS5job92M6Q==</bce:password>
               <bce:email>michelle.wang@ericsson.com</bce:email>
               <bce:active>true</bce:active>
               <bce:nonTelephonyUser>false</bce:nonTelephonyUser>
               <bce:contactAdministrator>false</bce:contactAdministrator>
               <bce:administrator>false</bce:administrator>
               <bce:systemAdministrator>false</bce:systemAdministrator>
               <bce:clientEnum>PC</bce:clientEnum>
               <bce:userName>2208811133</bce:userName>
               <bce:location>shanghai</bce:location>
               <bce:locationAddress>
                  <bce:StreetAddress>tianshan road_michelle</bce:StreetAddress>
                  <bce:ZipCode>200335</bce:ZipCode>
                  <bce:City>shanghai</bce:City>
                  <bce:Region>RNEA</bce:Region>
                  <bce:Country>china</bce:Country>
               </bce:locationAddress>
               <bce:skills>test</bce:skills>
               <bce:webUrl>www.ericsson.com</bce:webUrl>
               <bce:fax>22087555</bce:fax>
               <bce:title>verificaton engineer</bce:title>
               <bce:department>cbc/xleg</bce:department>
               <bce:externalId>1</bce:externalId>
            </bce:getUserResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

5 Auto Attendant

5.1 Creating an Auto Attendant

This section describes how to create an Auto Attendant.

MOType

AutoAttendant@http://schemas.ericsson.com/ma/bce/

5.1.1 Request Data

MOId

Table 22 MOID Parameters of Creating an Auto Attendant
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`autoAttendantId`	The ID of the Auto Attendant String minLength value="1" maxLength value="20"	Mandatory	autoattendant

MOAttributes

Table 23 MOAttributes of Creating an Auto Attendant
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`autoAttendantId`			The ID of the Auto Attendant String minLength value="1" maxLength value="20"	Mandatory	autoattendant
`sipAddress`			The complex type of the address	Mandatory
	`SipUri`		The URI address String	Mandatory	sip:22088113@tcv.ics.se or tel:22088113
	`Type`		The type of the `sipAddress` String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Mandatory	PUBLIC_ID
	`Default`		Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Mandatory	true
`bagNumbers`			Sub-MO This sub-MO only supports some customers.	Optional
	`mobileNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	13800138000
	`fixedNumber`		The fixed number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	60614197
	`clipNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	6061
`shortNumber`			The short number String pattern value="[0-9]{2,5}"	Optional	24197
`voiceMailAddress`			The voice mail address String	Optional	sip:test@ericsson.com
`name`			The name of the Auto Attendant String minLength value="1" maxLength value="100"	Mandatory	Tom
`description`			The description of the Auto Attendant String maxLength value="255"	Optional	Test the description
`aaOpen`			The status of the Auto Attendent String enumeration value="OPEN" enumeration value="CLOSED" enumeration value="SCHEDULE"	Optional	OPEN
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean value="true" or "false"	Optional	true
	`overflowAction`		Sub-MO Configure either of the following two parameters, otherwise an error can occur.	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`incomingNumberPresentation`			The incoming caller display String enumeration value="CALLER" enumeration value="SERVICE_ADDRESS"	Optional	CALLER
`UpAutoAttendantMenuItemType`			Sub-MO	Optional
	`operation`		The type of the operation String enumeration value="DELETE"	Optional	DELETE
	`key`		The type of the Auto Attendant key String minLength value="1" pattern value="[0-9]"	Optional	1
	`keyPressedAction`		Sub-MO Configure only one of the following parameters, otherwise an error can occur.
		`SipAddress`	The URI address String	Optional	sip:22088113@tcv.ics.se or tel:+8612323456783
		`CdgId`	The ID of Call Distribution Group String minLength value="1" maxLength value="20"	Optional	cdg1_ema2
		`MenuAction`	The action triggered by a menu item String enumeration value="FORWARD_TO_VOICE_MAIL" enumeration value="REPEAT_ANNOUNCEMENT" enumeration value="DISCONNECT"	Optional	REPEAT_ANNOUNCEMENT
`timeOutAction`			Sub-MO Configure only one of the following parameters, otherwise an error can occur.	Mandatory
	`SipAddress`		The URI address String	Mandatory	sip:22088113@tcv.ics.se or tel:+8612323456783
	`CdgId`		The ID of Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	cdg1_ema2
	`MenuAction`		The action triggered by a menu item String enumeration value="FORWARD_TO_VOICE_MAIL" enumeration value="REPEAT_ANNOUNCEMENT" enumeration value="DISCONNECT"	Mandatory	REPEAT_ANNOUNCEMENT
`wrongSelectionAction`			Sub-MO Configure only one of the following parameters, otherwise an error can occur.	Mandatory
	`SipAddress`		The URI address String	Mandatory	sip:22088113@tcv.ics.se or tel:+8612323456783
	`CdgId`		The ID of Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	cdg1_ema2
	`MenuAction`		The action triggered by a menu item String enumeration value="FORWARD_TO_VOICE_MAIL" enumeration value="REPEAT_ANNOUNCEMENT" enumeration value="DISCONNECT"	Mandatory	FORWARD_TO_VOICE_MAIL
`announcements`			Sub-MO	Optional
	`operation`		The operation on the announcement String enumeration value="DELETE"	Optional	DELETE
	`announcementName`		The name of the announcement String	Optional	announcementName
	`companyId`		Sub-MO	Optional
		`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Optional	sp-tcv
		`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Optional	eda_1
	`fileId`		The ID of the file Long	Optional	54321

5.1.2 Example

An example for creating an Auto Attendant is as follows:

Example 14 Creating an Auto Attendant

Request:
<cai3:Create>
         <cai3:MOType>
          AutoAttendant@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:autoAttendantId>${Properties#autoAttendantId}</bce:autoAttendantId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createAutoAttendant serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" 
              autoAttendantId="${Properties#autoAttendantId}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:autoAttendantId>${Properties#autoAttendantId}</bce:autoAttendantId>
               <!--0 to 10 repetitions:-->
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:27348111@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>tel:+25498111</bce:SipUri>
                  <bce:Type>FIXED</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>54198</bce:shortNumber>
               <bce:voiceMailAddress>sip:test@ericsson.com</bce:voiceMailAddress>
               <bce:name>Tom</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:aaOpen>OPEN</bce:aaOpen>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>To_voice_email</bce:forwardToAddress-->
                     <bce:overflowOption>
                      FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:incomingNumberPresentation>
                 CALLER
               </bce:incomingNumberPresentation>
               <!--0 to 10 repetitions:-->
               <bce:UpAutoAttendantMenuItemType>
                  <bce:operation>DELETE</bce:operation>
                  <bce:key>1</bce:key>
                  <bce:keyPressedAction>
                     <!--You have a CHOICE of the next 3 items at this level-->
                     <!--bce:SipAddress>sip:22088113@tcv.ics.se</bce:SipAddress-->
                     <!--bce:CdgId>cdg1_ema2</bce:CdgId-->
                     <bce:MenuAction>REPEAT_ANNOUNCEMENT</bce:MenuAction>
                  </bce:keyPressedAction>
               </bce:UpAutoAttendantMenuItemType>
               <bce:timeOutAction>
                  <!--You have a CHOICE of the next 3 items at this level-->
                  <!--bce:SipAddress>sip:22088113@tcv.ics.se</bce:SipAddress-->
                  <!--bce:CdgId>cdg1_ema2</bce:CdgId-->
                  <bce:MenuAction>REPEAT_ANNOUNCEMENT</bce:MenuAction>
               </bce:timeOutAction>
               <bce:wrongSelectionAction>
                  <!--You have a CHOICE of the next 3 items at this level-->
                  <!--bce:SipAddress>sip:22088113@tcv.ics.se</bce:SipAddress-->
                  <!--bce:CdgId>cdg1_ema2</bce:CdgId-->
                  <bce:MenuAction>FORWARD_TO_VOICE_MAIL</bce:MenuAction>
               </bce:wrongSelectionAction>
               <!--0 to 7 repetitions:-->
               <!--Zero or more repetitions:-->
               <bce:announcements>
                  <bce:operation>DELETE</bce:operation>
                  <bce:announcementName>CDG_WELCOME</bce:announcementName>
                  <bce:companyId>
                     <bce:serviceProviderId>
                       ${Properties#ProviderId}
                     </bce:serviceProviderId>
                     <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
                    </bce:companyId>
                    <bce:fileId>54321</bce:fileId>
               </bce:announcements>
            </bce:createAutoAttendant>
         </cai3:MOAttributes>
</cai3:Create>

5.2 Deleting an Auto Attendant

This section describes how to delete an Auto Attendant.

MOType

AutoAttendant@http://schemas.ericsson.com/ma/bce/

5.2.1 Request Data

MOId

Table 24 MOID Parameters of Deleting an Auto Attendant
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`autoAttendantId`	The ID of the Auto Attendant String minLength value="1" maxLength value="20"	Mandatory	autoattendant

5.2.2 Example

An example for deleting an Auto Attendant is as follows:

Example 15 Deleting an Auto Attendant

Request:
<cai3:Delete>
         <cai3:MOType>
           AutoAttendant@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:autoAttendantId>${Properties#autoAttendantId}</bce:autoAttendantId>
         </cai3:MOId>
</cai3:Delete>

5.3 Setting an Auto Attendant

This section describes how to set an Auto Attendant.

MOType

AutoAttendant@http://schemas.ericsson.com/ma/bce/

5.3.1 Request Data

MOId

Table 25 MOID Parameters of Setting an Auto Attendant
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`autoAttendantId`	The ID of the Auto Attendant String minLength value="1" maxLength value="20"	Mandatory	autoattendant

MOAttributes

Table 26 MOAttributes of Setting an Auto Attendant
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`autoAttendantId`			The ID of the Auto Attendant String minLength value="1" maxLength value="20"	Mandatory	autoattendant
`sipAddress`			The complex type of the address	Optional
	`SipUri`		The URI address String	Optional	sip:22088113@tcv.ics.se or tel:22088113
	`Type`		The type of the `sipAddress` String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Optional	PUBLIC_ID
	`Default`		Boolean value="true" or "false"	Optional	true
`bagNumbers`			Indicates whether the `sipAddress` is default or not. Sub-MO This sub-MO only supports some customers.	Optional
	`mobileNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	13800138000
	`fixedNumber`		The fixed number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	60614197
	`clipNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	6061
`shortNumber`			The short number String pattern value="[0-9]{2,5}"	Optional	24197
`voiceMailAddress`			The voice mail address String	Optional	sip:test@ericsson.com
`name`			The name of the Auto Attendant String minLength value="1" maxLength value="100"	Optional	Tom
`description`			The description of the Auto Attendant String maxLength value="255"	Optional	Test the description
`aaOpen`			The status of the Auto Attendent String enumeration value="OPEN" enumeration value="CLOSED" enumeration value="SCHEDULE"	Optional	OPEN
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean value="true" or "false"	Optional	true
	`overflowAction`		Sub-MO Configure either of the following two parameters, otherwise an error can occur.	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`incomingNumberPresentation`			The incoming caller display String enumeration value="CALLER" enumeration value="SERVICE_ADDRESS"	Optional	CALLER
`UpAutoAttendantMenuItemType`			Sub-MO	Optional
	`operation`		The type of the operation String enumeration value="DELETE"	Optional	DELETE
	`key`		The type of the Auto Attendant key String minLength value="1" pattern value="[0-9]"	Optional	1
	`keyPressedAction`		Sub-MO Configure only one of the following parameters, otherwise an error can occur.	Optional
		`SipAddress`	The URI address String	Optional	sip:22088113@tcv.ics.se or tel:+8612323456783
		`CdgId`	The ID of Call Distribution Group String minLength value="1" maxLength value="20"	Optional	cdg1_ema2
		`MenuAction`	The action triggered by a menu item String enumeration value="FORWARD_TO_VOICE_MAIL" enumeration value="REPEAT_ANNOUNCEMENT" enumeration value="DISCONNECT"	Optional	REPEAT_ANNOUNCEMENT
`timeOutAction`			Sub-MO Configure only one of the following parameters, otherwise an error can occur.	Optional
	`SipAddress`		The URI address String	Optional	sip:22088113@tcv.ics.se or tel:+8612323456783
	`CdgId`		The ID of Call Distribution Group String minLength value="1" maxLength value="20"	Optional	cdg1_ema2
	`MenuAction`		The action triggered by a menu item String enumeration value="FORWARD_TO_VOICE_MAIL" enumeration value="REPEAT_ANNOUNCEMENT" enumeration value="DISCONNECT"	Optional	REPEAT_ANNOUNCEMENT
`wrongSelectionAction`			Sub-MO Configure only one of the following parameters, otherwise an error can occur.	Optional
	`SipAddress`		The URI address String	Optional	sip:22088113@tcv.ics.se or tel:+8612323456783
	`CdgId`		The ID of Call Distribution Group String minLength value="1" maxLength value="20"	Optional	cdg1_ema2
	`MenuAction`		The action triggered by a menu item String enumeration value="FORWARD_TO_VOICE_MAIL" enumeration value="REPEAT_ANNOUNCEMENT" enumeration value="DISCONNECT"	Optional	FORWARD_TO_VOICE_MAIL
`announcements`			Sub-MO	Optional
	`operation`		The operation on the announcement String enumeration value="DELETE"	Optional	DELETE
	`announcementName`		The name of the announcement String	Optional	announcementName
	`companyId`		Sub-MO	Optional
		`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Optional	sp-tcv
		`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Optional	eda_1
	`fileId`		The ID of the file Long	Optional	54321

5.3.2 Example

An example for setting an Auto Attendant is as follows:

Example 16 Setting an Auto Attendant

Request:
<cai3:Set>
         <cai3:MOType>
           AutoAttendant@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:autoAttendantId>
              ${Properties#autoAttendantId_M}
            </bce:autoAttendantId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setAutoAttendant serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" 
              autoAttendantId="${Properties#autoAttendantId_M}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:autoAttendantId>
                 ${Properties#autoAttendantId_M}
               </bce:autoAttendantId>
               <!--0 to 10 repetitions:-->
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:21238112@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:name>Tom1</bce:name>
               <bce:aaOpen>OPEN</bce:aaOpen>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>false</bce:playAnnouncement>
                  <bce:overflowAction>
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:timeOutAction>
                  <!--You have a CHOICE of the next 3 items at this level-->
                  <bce:SipAddress>sip:22088113@tcv.ics.se</bce:SipAddress>
                  <!--bce:CdgId>cdg1_ema2</bce:CdgId-->
                  <!--bce:MenuAction>REPEAT_ANNOUNCEMENT</bce:MenuAction-->
               </bce:timeOutAction>
               <bce:wrongSelectionAction>
                  <!--You have a CHOICE of the next 3 items at this level-->
                  <bce:SipAddress>sip:22088113@tcv.ics.se</bce:SipAddress>
                  <!--bce:CdgId>cdg1_ema2</bce:CdgId-->
                  <!--bce:MenuAction>FORWARD_TO_VOICE_MAIL</bce:MenuAction-->
               </bce:wrongSelectionAction>
            </bce:setAutoAttendant>
         </cai3:MOAttributes>
</cai3:Set>

5.4 Getting an Auto Attendant

This section describes how to get an Auto Attendant.

MOType

AutoAttendant@http://schemas.ericsson.com/ma/bce/

5.4.1 Request Data

MOId

Table 27 MOID Parameters of Getting an Auto Attendant
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`autoAttendantId`	The ID of the Auto Attendant String minLength value="1" maxLength value="20"	Mandatory	autoattendant

5.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 23.

5.4.3 Example

An example for getting an Auto Attendant is as follows:

Example 17 Getting an Auto Attendant

Request:
<cai3:Get>
         <cai3:MOType>
          AutoAttendant@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:autoAttendantId>${Properties#autoAttendantId}</bce:autoAttendantId>
         </cai3:MOId>
</cai3:Get>

Response:
<GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getAutoAttendantResponse autoAttendantId="autoattendant" 
              companyId="ema_1381" serviceProviderId="sp-tcv" 
              xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema_1381</bce:companyId>
               <bce:autoAttendantId>autoattendant</bce:autoAttendantId>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>tel:+25498111</bce:SipUri>
                  <bce:Type>FIXED</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:27348111@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>54198</bce:shortNumber>
               <bce:voiceMailAddress>sip:test@ericsson.com</bce:voiceMailAddress>
               <bce:name>Tom</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:aaOpen>OPEN</bce:aaOpen>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <bce:overflowOption>
                       FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:incomingNumberPresentation>CALLER
               </bce:incomingNumberPresentation>
               <bce:UpAutoAttendantMenuItemType>
                  <bce:key>1</bce:key>
                  <bce:keyPressedAction>
                     <bce:MenuAction>REPEAT_ANNOUNCEMENT</bce:MenuAction>
                  </bce:keyPressedAction>
               </bce:UpAutoAttendantMenuItemType>
               <bce:timeOutAction>
                  <bce:MenuAction>REPEAT_ANNOUNCEMENT</bce:MenuAction>
               </bce:timeOutAction>
               <bce:wrongSelectionAction>
                  <bce:MenuAction>FORWARD_TO_VOICE_MAIL</bce:MenuAction>
               </bce:wrongSelectionAction>
            </bce:getAutoAttendantResponse>
         </MOAttributes>
</GetResponse>

6 Audio Conference

6.1 Creating an Audio Conference

This section describes how to create an Audio Conference.

MOType

AudioConference@http://schemas.ericsson.com/ma/bce

6.1.1 Request Data

MOId

Table 28 MOID Parameters of Creating an Audio Conference
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`objectId`	The ID of the Audio Conference String minLength value="1" maxLength value="20"	Mandatory	object

MOAttributes

Table 29 MOAttributes of Creating an Audio Conference
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`objectId`			The ID of the Audio Conference String minLength value="1" maxLength value="20"	Mandatory	object
`sipAddress`			The complex type of the address	Mandatory	Both tel and sipuri addresses must be defined for this MO.
	`SipUri`		The URI address String	Mandatory	sip:22088113@tcv.ics.se or tel:+8612323456783
	`Type`		The type of the sipAddress String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Mandatory	PUBLIC_ID
	`Default`		Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Mandatory	true
`bagNumbers`			Sub-MO This sub-MO only supports some customers.	Optional
	`mobileNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	13800138000
	`fixedNumber`		The fixed number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	60614197
	`clipNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	6061
`shortNumber`			The short number String pattern value="[0-9]{2,5}"	Optional	24197
`name`			The name of the Audio Conference String minLength value="1" maxLength value="100"	Mandatory	audio_conference
`description`			The description of the Audio Conference String minLength value="1" maxLength value="100"	Optional	Test the description
`open`			The status of the Audio Conference String enumeration value="OPEN" enumeration value="CLOSED" enumeration value="SCHEDULE"	Optional	OPEN
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean value="true" or "false"	Optional	true
	`overflowAction`		Sub-MO Configure either of the following two parameters, otherwise an error can occur.	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`pinCodeLength`			The length of the pincode Int	Mandatory	8

6.1.2 Example

An example for creating an Audio Conference is as follows:

Example 18 Creating an Audio Conference

Request:
<cai3:Create>
         <cai3:MOType>AudioConference@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:objectId>${Properties#objectId}</bce:objectId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createAudioConference serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" objectId="${Properties#objectId}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:objectId>${Properties#objectId}</bce:objectId>
               <!--0 to 10 repetitions:-->
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:24088111@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>tel:+24088111</bce:SipUri>
                  <bce:Type>FIXED</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>84198</bce:shortNumber>
               <bce:name>audio_conference</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:open>OPEN</bce:open>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>To_voice_email</bce:forwardToAddress-->
                     <bce:overflowOption>FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:pinCodeLength>8</bce:pinCodeLength>
            </bce:createAudioConference>
         </cai3:MOAttributes>
</cai3:Create>

6.2 Deleting an Audio Conference

This section describes how to delete an Audio Conference.

MOType

AudioConference@http://schemas.ericsson.com/ma/bce

6.2.1 Request Data

MOId

Table 30 MOID Parameters of Deleting an Audio Conference
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`objectId`	The ID of the Audio Conference String minLength value="1" maxLength value="20"	Mandatory	object

6.2.2 Example

An example for deleting an Audio Conference is as follows:

Example 19 Deleting an Audio Conference

Request:
<cai3:Delete>
         <cai3:MOType>AudioConference@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:objectId>${Properties#objectId}</bce:objectId>
         </cai3:MOId>
</cai3:Delete>

6.3 Setting an Audio Conference

This section describes how to set an Audio Conference.

MOType

AudioConference@http://schemas.ericsson.com/ma/bce

6.3.1 Request Data

MOId

Table 31 MOID Parameters of Setting an Audio Conference
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`objectId`	The ID of the Audio Conference String minLength value="1" maxLength value="20"	Mandatory	object

MOAttributes

Table 32 MOAttributes of Setting an Audio Conference
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`objectId`			The ID of the Audio Conference String minLength value="1" maxLength value="20"	Mandatory	object
`sipAddress`			The complex type of the address	Mandatory	Both tel and sipuri addresses must be defined for this MO.
	`SipUri`		The URI address String	Mandatory	sip:22088113@tcv.ics.se or tel:+8612323456783
	`Type`		The type of the sipAddress String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Mandatory	PUBLIC_ID
	`Default`		Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Mandatory	true
`bagNumbers`			Sub-MO This sub-MO only supports some customers.	Optional
	`mobileNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	13800138000
	`fixedNumber`		The fixed number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	60614197
	`clipNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	6061
`shortNumber`			The short number String pattern value="[0-9]{2,5}"	Optional	24197
`name`			The name of the Audio Conference String minLength value="1" maxLength value="100"	Mandatory	audio_conference
`description`			The description of the Audio Conference String minLength value="1" maxLength value="100"	Optional	Test the description
`open`			The status of the Audio Conference String enumeration value="OPEN" enumeration value="CLOSED" enumeration value="SCHEDULE"	Optional	OPEN
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean value="true" or "false"	Optional	true
	`overflowAction`		Sub-MO Configure either of the following two parameters, otherwise an error can occur.	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`pinCodeLength`			The length of the pincode Int	Optional	8

6.3.2 Example

An example for setting an Audio Conference is as follows:

Example 20 Setting an Audio Conference

Request:
<cai3:Set>
         <cai3:MOType>AudioConference@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:objectId>${Properties#objectId}</bce:objectId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setAudioConference serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" objectId="${Properties#objectId}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:objectId>${Properties#objectId}</bce:objectId>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>To_voice_email</bce:forwardToAddress-->
                     <bce:overflowOption>FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:pinCodeLength>9</bce:pinCodeLength>
            </bce:setAudioConference>
         </cai3:MOAttributes>
</cai3:Set>

6.4 Getting an Audio Conference

This section describes how to get an Audio Conference.

MOType

AudioConference@http://schemas.ericsson.com/ma/bce

6.4.1 Request Data

MOId

Table 33 MOID Parameters of Getting an Audio Conference
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`objectId`	The ID of the Audio Conference String minLength value="1" maxLength value="20"	Mandatory	object

6.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 29.

6.4.3 Example

An example for getting an Audio Conference is as follows:

Example 21 Getting an Audio Conference

Request:
<cai3:Get>
         <cai3:MOType>AudioConference@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:objectId>${Properties#objectId}</bce:objectId>
         </cai3:MOId>
</cai3:Get>

Response:
<GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getAudioConferenceResponse companyId="ema_139" 
              objectId="audio_object" serviceProviderId="sp-tcv" 
              xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema_139</bce:companyId>
               <bce:objectId>audio_object</bce:objectId>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>tel:+24088111</bce:SipUri>
                  <bce:Type>FIXED</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:24088111@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>84198</bce:shortNumber>
               <bce:name>audio_conference</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:open>OPEN</bce:open>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <bce:overflowOption>FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:pinCodeLength>9</bce:pinCodeLength>
            </bce:getAudioConferenceResponse>
         </MOAttributes>
</GetResponse>

7 Call Distribution Group

7.1 Creating a Call Distribution Group

This section describes how to create a Call Distribution Group.

MOType

CallDistributionGroup@http://schemas.ericsson.com/ma/bce

7.1.1 Request Data

MOId

Table 34 MOID Parameters of Creating a Call Distribution Group
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`cdgId`	The ID of the Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	CallDistributionGroup

MOAttributes

Table 35 MOAttributes of Creating a Call Distribution Group
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`cdgId`			The ID of the Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	CallDistributionGroup
`sipAddress`			The complex type of the address	Mandatory
	`SipUri`		The URI address String	Mandatory	sip:22088113@tcv.ics.se or tel:22088113
	`Type`		The type of the sipAddress String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Mandatory	PUBLIC_ID
	`Default`		Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Mandatory	true
`bagNumbers`			Sub-MO This sub-MO only supports some customers.	Optional
	`mobileNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	13800138000
	`fixedNumber`		The fixed number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	60614197
	`clipNumber`		The calling line identification presentation number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	6061
`shortNumber`			The short number String pattern value="[0-9]{2,5}"	Optional	24197
`name`			The name of the Call Distribution Group String minLength value="1" maxLength value="100"	Mandatory	call_distribution_group
`description`			The description of the Call Distribution Group String maxLength value="255"	Optional	Test the description
`maxConcurrentAttempts`			The maximum number of concurrent attempts Int minInclusive value="1" maxInclusive value="9"	Optional	9
`concurrentAttempts`			The number of concurrent attempts Int	Optional	1
`clericalTimeOut`			The idle time after a call is disconnected and before a new call is accepted. Int minInclusive value="0" maxInclusive value="300"	Optional	300
`noAnswerTimeOut`			Sub-MO Configure either of the following parameters, otherwise an error can occur.	Optional
	`TimeOut`		The maximum length of time the phone can ring Int minInclusive value="0" maxInclusive value="300"	Optional	300
	`CompanyDefault`		Indicates whether the value is as same as the default value of the Company. Boolean	Optional	true
`maxQueueSize`			The maximum size of the queue Int minInclusive value="0" maxInclusive value="20"	Optional	20
`maxTimeInQueue`			The maximum duration an item can be kept in queue Int minInclusive value="60" maxInclusive value="1800"	Optional	1800
`cdgOpen`			Indicates the status of the Call Distribution Group. String enumeration value="OPEN" enumeration value="CLOSED" enumeration value="SCHEDULE"	Optional	OPEN
`playWelcomeAnnouncement`			Indicates whether to play the welcome announcement or not. Boolean	Optional	true
`playQueueAnnouncement`			Indicates whether to play the queue announcement or not. Boolean	Optional	true
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not.	Optional	true
	`overflowAction`		Sub-MO	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`overflowWhenNoAgents`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean	Optional	true
	`overflowAction`		Sub-MO	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean	Optional	true
	`overflowAction`		Sub-MO	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`voiceMailAddress`			The voice mail address String	Optional	sip:test@ericsson.com
`incomingNumberPresentation`			The incoming caller display String enumeration value="CALLER" enumeration value="SERVICE_ADDRESS"	Optional	CALLER
`outgoingNumberPresentation`			The outgoing caller display String enumeration value="CALLER" enumeration value="SERVICE_ADDRESS"	Optional	SERVICE_ADDRESS
`agents`			Sub-MO	Optional
	`operation`		The type of the operation String enumeration value=" DELETE"	Optional	DELETE
	`userId`		The user ID String minLength value="1" maxLength value="20"	Optional	22088113
	`loggedIn`		Indicates whether the user is logged in or not. Boolean	Optional	true
	`prio`		Priority order Int minInclusive value="1" maxInclusive value="20"	Optional	3
`announcements`			Sub-MO	Optional
	`operation`		The operation on the announcement String enumeration value="DELETE"	Optional	DELETE
	`announcementName`		The name of the announcement String	Optional	announcementName
	`companyId`		Sub-MO	Optional
		`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Optional	sp-tcv
		`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Optional	eda_1
	`fileId`		The ID of the file Long	Optional	54321
`anonymousCallRejection`			The switch of the anonymous call rejection function String enumeration value="ON" enumeration value="OFF" enumeration value="UNSET"	Optional	ON

7.1.2 Example

An example for creating a Call Distribution Group is as follows:

Example 22 Creating a Call Distribution Group

Request:
<cai3:Create>
         <cai3:MOType>CallDistributionGroup@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:cdgId>${Properties#cdgId}</bce:cdgId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createCDG serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" cdgId="${Properties#cdgId}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:cdgId>${Properties#cdgId}</bce:cdgId>
               <!--0 to 10 repetitions:-->
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:276565112@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>94198</bce:shortNumber>
               <bce:name>call_distribution_group</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:maxConcurrentAttempts>9</bce:maxConcurrentAttempts>
               <bce:concurrentAttempts>1</bce:concurrentAttempts>
               <bce:clericalTimeOut>300</bce:clericalTimeOut>
               <bce:noAnswerTimeOut>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <bce:TimeOut>300</bce:TimeOut>
                  <!--bce:CompanyDefault>true</bce:CompanyDefault-->
               </bce:noAnswerTimeOut>
               <bce:maxQueueSize>20</bce:maxQueueSize>
               <bce:maxTimeInQueue>1800</bce:maxTimeInQueue>
               <bce:cdgOpen>OPEN</bce:cdgOpen>
               <bce:playWelcomeAnnouncement>true</bce:playWelcomeAnnouncement>
               <bce:playQueueAnnouncement>true</bce:playQueueAnnouncement>
               <bce:overflowWhenBusy>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>to_voice_mail</bce:forwardToAddress-->
                     <bce:overflowOption>FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenBusy>
               <bce:overflowWhenNoAgents>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>to_voice_mail</bce:forwardToAddress-->
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenNoAgents>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>forward_to_address
                     </bce:forwardToAddress-->
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:voiceMailAddress>sip:test@ericsson.com</bce:voiceMailAddress>
               <bce:incomingNumberPresentation>CALLER
               </bce:incomingNumberPresentation>
               <bce:outgoingNumberPresentation>SERVICE_ADDRESS
               </bce:outgoingNumberPresentation>
               <!--Zero or more repetitions:-->
               <bce:agents>
                  <bce:operation>DELETE</bce:operation>
                  <bce:userId>${Properties#User_1}</bce:userId>
                  <bce:loggedIn>true</bce:loggedIn>
                  <bce:prio>1</bce:prio>
               </bce:agents>
               <bce:announcements>
                  <bce:operation>DELETE</bce:operation>
                  <bce:announcementName>CDG_WELCOME
                  </bce:announcementName>
                  <bce:companyId>
                     <bce:serviceProviderId>${Properties#ProviderId}
                     </bce:serviceProviderId>
                     <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
                  </bce:companyId>
                  <bce:fileId>54321</bce:fileId>
               </bce:announcements>
               <bce:anonymousCallRejection>ON</bce:anonymousCallRejection>
            </bce:createCDG>
         </cai3:MOAttributes>
</cai3:Create>

7.2 Deleting a Call Distribution Group

This section describes how to delete a Call Distribution Group.

MOType

CallDistributionGroup@http://schemas.ericsson.com/ma/bce

7.2.1 Request Data

MOId

Table 36 MOID Parameters of Deleting a Call Distribution Group
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`cdgId`	The ID of the Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	CallDistributionGroup

7.2.2 Example

An example for deleting a Call Distribution Group is as follows:

Example 23 Deleting a Call Distribution Group

Request:
<cai3:Delete>
         <cai3:MOType>CallDistributionGroup@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:cdgId>${Properties#cdgId}</bce:cdgId>
         </cai3:MOId>
</cai3:Delete>

7.3 Setting a Call Distribution Group

This section describes how to set a Call Distribution Group.

MOType

CallDistributionGroup@http://schemas.ericsson.com/ma/bce

7.3.1 Request Data

MOId

Table 37 MOID Parameters of Setting a Call Distribution Group
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`cdgId`	The ID of the Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	CallDistributionGroup

MOAttributes

Table 38 MOAttributes of Setting a Call Distribution Group
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`cdgId`			The ID of the Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	CallDistributionGroup
`sipAddress`			The complex type of the address	Optional
	`SipUri`		The URI address String	Optional	sip:22088113@tcv.ics.se
	`Type`		The type of the `sipAddress` String enumeration value="FIXED" enumeration value="MOBILE" enumeration value="CLIP" enumeration value="PUBLIC_ID" enumeration value="PRIVATE_ID"	Optional	PUBLIC_ID
	`Default`		Indicates whether the `sipAddress` is default or not. Boolean value="true" or "false"	Optional	true
`bagNumbers`			Sub-MO This sub-MO only supports some customers.	Optional
	`mobileNumber`		The mobile number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	13800138000
	`fixedNumber`		The fixed number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	60614197
	`clipNumber`		The calling line identification presentation number String minLength value="0" maxLength value="15" pattern value="[1-9]([0-9])*"	Optional	6061
`shortNumber`			The short number String pattern value="[0-9]{2,5}"	Optional	24197
`name`			The name of the Call Distribution Group String minLength value="1" maxLength value="100"	Mandatory	call_distribution_group
`description`			The description of the Call Distribution Group String maxLength value="255"	Optional	Test the description
`maxConcurrentAttempts`			The maximum number of concurrent attempts Int minInclusive value="1" maxInclusive value="9"	Optional	9
`concurrentAttempts`			The number of concurrent attempts Int	Optional	1
`clericalTimeOut`			The idle time after a call is disconnected and before a new call is accepted. Int minInclusive value="0" maxInclusive value="300"	Optional	300
`noAnswerTimeOut`			Sub-MO Configure either of the following parameters, otherwise an error can occur.	Optional
	`TimeOut`		The maximum length of time the phone can ring Int minInclusive value="0" maxInclusive value="300"	Optional	300
	`CompanyDefault`		Indicates whether the value is as same as the default value of the Company. Boolean	Optional	true
`maxQueueSize`			The maximum size of the queue Int minInclusive value="0" maxInclusive value="20"	Optional	20
`maxTimeInQueue`			The maximum duration an item can be kept in queue Int minInclusive value="60" maxInclusive value="1800"	Optional	1800
`cdgOpen`			Indicates the status of the Call Distribution Group. String enumeration value="OPEN" enumeration value="CLOSED" enumeration value="SCHEDULE"	Optional	OPEN
`playWelcomeAnnouncement`			Indicates whether to play the welcome announcement or not. Boolean	Optional	true
`playQueueAnnouncement`			Indicates whether to play the queue announcement or not. Boolean	Optional	true
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not.	Optional	true
	`overflowAction`		Sub-MO	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`overflowWhenNoAgents`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean	Optional	true
	`overflowAction`		Sub-MO	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`overflowWhenClosed`			Sub-MO	Optional
	`playAnnouncement`		Indicates whether to play the announcement or not. Boolean	Optional	true
	`overflowAction`		Sub-MO	Optional
		`forwardToAddress`	The email addresses that are forwarded to String	Optional	To_voice_email
		`overflowOption`	The overflow option String enumeration value= "FORWARD_TO_VOICEMAIL" enumeration value="HANGUP"	Optional	FORWARD_TO_VOICEMAIL
`voiceMailAddress`			The voice mail address String	Optional	sip:test@ericsson.com
`incomingNumberPresentation`			The incoming caller display String enumeration value="CALLER" enumeration value="SERVICE_ADDRESS"	Optional	CALLER
`outgoingNumberPresentation`			The outgoing caller display String enumeration value="CALLER" enumeration value="SERVICE_ADDRESS"	Optional	SERVICE_ADDRESS
`agents`			Sub-MO	Optional
	`operation`		The type of the operation String enumeration value=" DELETE"	Optional	DELETE
	`userId`		The user ID String minLength value="1" maxLength value="20"	Optional	22088113
	`loggedIn`		Indicates whether the user is logged in or not. Boolean	Optional	true
	`prio`		Priority order Int minInclusive value="1" maxInclusive value="20"	Optional	3
`announcements`			Sub-MO	Optional
	`operation`		The operation on the announcement String enumeration value="DELETE"	Optional	DELETE
	`announcementName`		The name of the announcement String	Optional	announcementName
	`companyId`		Sub-MO	Optional
		`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Optional	sp-tcv
		`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Optional	eda_1
	`fileId`		The ID of the file Long	Optional	54321
`anonymousCallRejection`			The switch of the anonymous call rejection function String enumeration value="ON" enumeration value="OFF" enumeration value="UNSET"	Optional	ON

7.3.2 Example

An example for setting a Call Distribution Group is as follows:

Example 24 Setting a Call Distribution Group

Request:
<cai3:Set>
         <cai3:MOType>CallDistributionGroup@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:cdgId>${Properties#cdgId_M}</bce:cdgId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setCDG serviceProviderId="${Properties#ProviderId}" 
              companyId="${Properties#CompanyId_1}" 
              cdgId="${Properties#cdgId_M}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:cdgId>${Properties#cdgId_M}</bce:cdgId>
               <!--0 to 10 repetitions:-->
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:271865112@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>74198</bce:shortNumber>
               <bce:name>call_distribution_group</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:maxConcurrentAttempts>9</bce:maxConcurrentAttempts>
               <bce:concurrentAttempts>1</bce:concurrentAttempts>
               <bce:clericalTimeOut>300</bce:clericalTimeOut>
               <bce:noAnswerTimeOut>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <bce:TimeOut>300</bce:TimeOut>
                  <!--bce:CompanyDefault>true</bce:CompanyDefault-->
               </bce:noAnswerTimeOut>
               <bce:maxQueueSize>20</bce:maxQueueSize>
               <bce:maxTimeInQueue>1800</bce:maxTimeInQueue>
               <bce:cdgOpen>OPEN</bce:cdgOpen>
               <bce:playWelcomeAnnouncement>true</bce:playWelcomeAnnouncement>
               <bce:playQueueAnnouncement>true</bce:playQueueAnnouncement>
               <bce:overflowWhenBusy>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>to_voice_mail</bce:forwardToAddress-->
                     <bce:overflowOption>FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenBusy>
               <bce:overflowWhenNoAgents>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>to_voice_mail</bce:forwardToAddress-->
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenNoAgents>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <!--You have a CHOICE of the next 2 items at this level-->
                     <!--bce:forwardToAddress>forward_to_address
                     </bce:forwardToAddress-->
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:voiceMailAddress>sip:test@ericsson.com</bce:voiceMailAddress>
               <bce:incomingNumberPresentation>CALLER
               </bce:incomingNumberPresentation>
               <bce:outgoingNumberPresentation>SERVICE_ADDRESS
               </bce:outgoingNumberPresentation>
               <!--Zero or more repetitions:-->
               <bce:agents>
                  <bce:operation>DELETE</bce:operation>
                  <bce:userId>${Properties#User_1}</bce:userId>
                  <bce:loggedIn>true</bce:loggedIn>
                  <bce:prio>1</bce:prio>
               </bce:agents>
               <bce:announcements>
                  <bce:operation>DELETE</bce:operation>
                  <bce:announcementName>CDG_WELCOME</bce:announcementName>
                  <bce:companyId>
                     <bce:serviceProviderId>${Properties#ProviderId}
                     </bce:serviceProviderId>
                     <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
                  </bce:companyId>
                  <bce:fileId>54321</bce:fileId>
               </bce:announcements>
               <bce:anonymousCallRejection>ON</bce:anonymousCallRejection>
            </bce:setCDG>
         </cai3:MOAttributes>
</cai3:Set>

7.4 Getting a Call Distribution Group

This section describes how to get a Call Distribution Group.

MOType

CallDistributionGroup@http://schemas.ericsson.com/ma/bce

7.4.1 Request Data

MOId

Table 39 MOID Parameters of Getting a Call Distribution Group
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`cdgId`	The ID of the Call Distribution Group String minLength value="1" maxLength value="20"	Mandatory	CallDistributionGroup

7.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 35.

7.4.3 Example

An example for getting a Call Distribution Group is as follows:

Example 25 Getting a Call Distribution Group

Request:
<cai3:Get>
         <cai3:MOType>CallDistributionGroup@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:cdgId>${Properties#cdgId}</bce:cdgId>
         </cai3:MOId>
</cai3:Get>

Response:
<GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getCDGResponse cdgId="cdg" companyId="ema_1372" 
              serviceProviderId="sp-tcv" 
              xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema_1372</bce:companyId>
               <bce:cdgId>cdg</bce:cdgId>
               <bce:sipAddress readOnly="false">
                  <bce:SipUri>sip:22hf112@tcv.ics.se</bce:SipUri>
                  <bce:Type>PUBLIC_ID</bce:Type>
                  <bce:Default>true</bce:Default>
               </bce:sipAddress>
               <bce:shortNumber>94198</bce:shortNumber>
               <bce:name>call_distribution_group</bce:name>
               <bce:description>Test the description</bce:description>
               <bce:maxConcurrentAttempts>9</bce:maxConcurrentAttempts>
               <bce:concurrentAttempts>1</bce:concurrentAttempts>
               <bce:clericalTimeOut>300</bce:clericalTimeOut>
               <bce:noAnswerTimeOut>
                  <bce:TimeOut>300</bce:TimeOut>
               </bce:noAnswerTimeOut>
               <bce:maxQueueSize>20</bce:maxQueueSize>
               <bce:maxTimeInQueue>1800</bce:maxTimeInQueue>
               <bce:cdgOpen>OPEN</bce:cdgOpen>
               <bce:playWelcomeAnnouncement>true</bce:playWelcomeAnnouncement>
               <bce:playQueueAnnouncement>true</bce:playQueueAnnouncement>
               <bce:overflowWhenBusy>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <bce:overflowOption>FORWARD_TO_VOICEMAIL
                     </bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenBusy>
               <bce:overflowWhenNoAgents>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenNoAgents>
               <bce:overflowWhenClosed>
                  <bce:playAnnouncement>true</bce:playAnnouncement>
                  <bce:overflowAction>
                     <bce:overflowOption>HANGUP</bce:overflowOption>
                  </bce:overflowAction>
               </bce:overflowWhenClosed>
               <bce:voiceMailAddress>sip:test@ericsson.com</bce:voiceMailAddress>
               <bce:incomingNumberPresentation>CALLER
               </bce:incomingNumberPresentation>
               <bce:outgoingNumberPresentation>SERVICE_ADDRESS
               </bce:outgoingNumberPresentation>
               <bce:agents>
                  <bce:userId>42088111</bce:userId>
                  <bce:loggedIn>true</bce:loggedIn>
                  <bce:prio>1</bce:prio>
               </bce:agents>
               <bce:anonymousCallRejection>ON</bce:anonymousCallRejection>
</bce:getCDGResponse>

8 Call Barring Profile

8.1 Creating a Call Barring Profile

This section describes how to create a Call Barring Profile.

MOType

CallBarringProfile@http://schemas.ericsson.com/ma/bce/

8.1.1 Request Data

MOId

Table 40 MOID Parameters of Creating a Call Barring Profile
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`barringProfileId`	The ID of the Call Barring Profile String minLength value="1" maxLength value="20"	Mandatory	CBPId

MOAttributes

Table 41 MOAttributes of Creating a Call Barring Profile
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`barringProfileId`			The ID of the Call Barring Profile String minLength value="1" maxLength value="20"	Mandatory	CBPId
`description`			The description of the Call Barring Profile String maxLength value="255"	Optional	EDA_Test
`blackList`			Sub-MO
	`operation`		The type of operation String enumeration value="ADD" enumeration value="DELETE"	Optional	ADD
	`callTypeStatement`		The type of the statement String enumeration value="ONNET" enumeration value="DELETE"	Optional	ONNET
	`numRangeStatement`		Sub-MO	Optional
		`value`	The value of number range statement String	Optional	+49*
`whiteList`			Sub-MO	Optional
	`operation`		The type of operation String enumeration value="ADD" enumeration value="DELETE"	Optional	DELETE
	`callTypeStatement`		The type of the statement String enumeration value="ONNET" enumeration value="OFFNET"	Optional	OFFNET
	`numRangeStatement`		Sub-MO	Optional
		`value`	The value of number range statement String	Optional	+49*
`name`			The name of the Call Barring Profile	Optional	Test_cbp

8.1.2 Example

An example for creating a Call Barring Profile is as follows:

Example 26 Creating a Call Barring Profile

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>
           CallBarringProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
            <bce:barringProfileId>${Properties#CBPId_2}</bce:barringProfileId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createCallBarringProfile serviceProviderId="${Properties#ProviderId}"
             companyId="${Properties#CompanyId_2}" barringProfileId="${Properties#CBPId_2}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
               <bce:barringProfileId>${Properties#CBPId_2}</bce:barringProfileId>
               <!--Optional:-->
               <bce:description>This profile blocks all mobile numbers except calls made to germany</bce:description>
               <!--Zero or more repetitions:-->
               <bce:blackList>
                  <!--Optional:-->
                  <bce:operation>ADD</bce:operation>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <bce:callTypeStatement>OFFNET</bce:callTypeStatement>
               </bce:blackList>
               <bce:blackList>
                  <!--Optional:-->
                  <bce:operation>ADD</bce:operation>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <bce:callTypeStatement>ONNET</bce:callTypeStatement>
               </bce:blackList>
               <!--Zero or more repetitions:-->
               <!--Zero or more repetitions:-->
               <bce:whiteList>
                  <!--Optional:-->
                  <bce:operation>ADD</bce:operation>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <!--Optional:-->
                  <bce:numRangeStatement>
                     <bce:value>+4670*</bce:value>
                  </bce:numRangeStatement>
               </bce:whiteList>
               <bce:whiteList>
                  <!--Optional:-->
                  <bce:operation>ADD</bce:operation>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <!--Optional:-->
                  <bce:numRangeStatement>
                     <bce:value>+4680*</bce:value>
                  </bce:numRangeStatement>
               </bce:whiteList>
               <!--Optional:-->
               <bce:name>${Properties#CBPId_2}</bce:name>
            </bce:createCallBarringProfile>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

8.2 Deleting a Call Barring Profile

This section describes how to delete a Call Barring Profile.

MOType

CallBarringProfile@http://schemas.ericsson.com/ma/bce/

8.2.1 Request Data

MOId

Table 42 MOID Parameters of Deleting a Call Barring Profile
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`barringProfileId`	The ID of the Call Barring Profile String minLength value="1" maxLength value="20"	Mandatory	CBPId

8.2.2 Example

An example for deleting a Call Barring Profile is as follows:

Example 27 Deleting a Call Barring Profile

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>
           CallBarringProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
            <bce:barringProfileId>${Properties#CBPId_2}</bce:barringProfileId>
         </cai3:MOId>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

8.3 Setting a Call Barring Profile

This section describes how to set a Call Barring Profile.

MOType

CallBarringProfile@http://schemas.ericsson.com/ma/bce/

8.3.1 Request Data

MOId

Table 43 MOID Parameters of Setting a Call Barring Profile
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`barringProfileId`	The ID of the Call Barring Profile String minLength value="1" maxLength value="20"	Mandatory	CBPId

MOAttributes

Table 44 MOAttributes of Setting a Call Barring Profile
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`barringProfileId`			The ID of the Call Barring Profile String minLength value="1" maxLength value="20"	Mandatory	CBPId
`description`			The description of the Call Barring Profile String maxLength value="255"	Optional	EDA_Test
`blackList`			Sub-MO
	`operation`		The type of operation String enumeration value="ADD" enumeration value="DELETE"	Optional	ADD
	`callTypeStatement`		The type of the statement String enumeration value="ONNET" enumeration value="OFFNET"	Optional	OFFNET
	`numRangeStatement`		Sub-MO	Optional
		`value`	The value of number range statement String	Optional	+49*
`whiteList`			Sub-MO	Optional
	`operation`		The type of operation String enumeration value="ADD" enumeration value="DELETE"	Optional	DELETE
	`callTypeStatement`		The type of the statement String enumeration value="ONNET" enumeration value="OFFNET"	Optional	ONNET
	`numRangeStatement`		Sub-MO	Optional
		`value`	The value of number range statement String	Optional	+49*
`name`			The name of the Call Barring Profile	Optional	Test_cbp

8.3.2 Example

An example for setting a Call Barring Profile is as follows:

Example 28 Setting a Call Barring Profile

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>
           CallBarringProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
            <bce:barringProfileId>${Properties#CBPId_2}</bce:barringProfileId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setCallBarringProfile serviceProviderId="${Properties#ProviderId}"
             companyId="${Properties#CompanyId_2}" barringProfileId="${Properties#CBPId_2}">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
               <bce:barringProfileId>${Properties#CBPId_2}</bce:barringProfileId>
               <!--Optional:-->
               <bce:description>This profile blocks all mobile numbers except calls made to germany</bce:description>
               <!--Zero or more repetitions:-->
               <bce:blackList>
                  <!--Optional:-->
                  <bce:operation>DELETE</bce:operation>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <!--Optional:-->
                  <bce:callTypeStatement>ONNET</bce:callTypeStatement>
                  <!--Optional:-->
               </bce:blackList>
               <!--Zero or more repetitions:-->
               <bce:whiteList>
                  <!--Optional:-->
                  <bce:operation>ADD</bce:operation>
                  <!--You have a CHOICE of the next 2 items at this level-->
                  <!--Optional:-->
                  <bce:callTypeStatement>ONNET</bce:callTypeStatement>
               </bce:whiteList>
               <!--Optional:-->
               <bce:name>${Properties#CBPId_2}</bce:name>
            </bce:setCallBarringProfile>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

8.4 Getting a Call Barring Profile

This section describes how to get a Call Barring Profile.

MOType

CallBarringProfile@http://schemas.ericsson.com/ma/bce/

8.4.1 Request Data

MOId

Table 45 MOID Parameters of Getting a Call Barring Profile
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`barringProfileId`	The ID of the Call Barring Profile String minLength value="1" maxLength value="20"	Mandatory	CBPId

8.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 41.

8.4.3 Example

An example for getting a Call Barring Profile is as follows:

Example 29 Getting a Call Barring Profile

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>
           CallBarringProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_2}</bce:companyId>
            <bce:barringProfileId>${Properties#CBPId_2}</bce:barringProfileId>
         </cai3:MOId>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>565cf75cf83e40589297ce131b5c1666</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getCallBarringProfileResponse barringProfileId="profile_2"
             companyId="ema_cbp_company2" serviceProviderId="sp-tcv"
             xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema_cbp_company2</bce:companyId>
               <bce:barringProfileId>profile_2</bce:barringProfileId>
               <bce:description>This profile blocks all mobile numbers except
 calls made to germany</bce:description>
               <bce:blackList>
                  <bce:callTypeStatement>OFFNET</bce:callTypeStatement>
               </bce:blackList>
               <bce:whiteList>
                  <bce:numRangeStatement>
                     <bce:value>+4670*</bce:value>
                  </bce:numRangeStatement>
               </bce:whiteList>
               <bce:whiteList>
                  <bce:numRangeStatement>
                     <bce:value>+4680*</bce:value>
                  </bce:numRangeStatement>
               </bce:whiteList>
               <bce:whiteList>
                  <bce:callTypeStatement>ONNET</bce:callTypeStatement>
               </bce:whiteList>
               <bce:name>profile_2</bce:name>
            </bce:getCallBarringProfileResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

9 Connection Profile

9.1 Creating a Connection Profile

This section describes how to create a Connection Profile.

MOType

ConnectionProfile@http://schemas.ericsson.com/ma/bce

9.1.1 Request Data

MOId

Table 46 MOID Parameters of Creating a Connection Profile
Parameter	Type	Occurrence	Example
`connectionProfileId`	The ID of the Connection Profile String minLength value="1" maxLength value="20"	Mandatory	connprofId

MOAttributes

Table 47 MOAttributes of Creating a Connection Profile
Parameter			Type	Occurrence	Example
`connectionProfileId`			The ID of the Connection Profile String minLength value="1" maxLength value="20"	Mandatory	connprofId
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Optional	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Optional	eda_1
`dbSchema`			The DB schema String minLength value="1" maxLength value="100"	Optional	dbschema
`directoryType`			The type of directory String enumeration value="DUMMY" enumeration value="SRD" enumeration value="SQL" enumeration value="VOICE" enumeration value="BCSDIR" enumeration value="LDAP"	Optional	SQL
`searchDomain`			The domain of searching String minLength value="1" maxLength value="100"	Optional	domain
`url`			The url address String minLength value="1" maxLength value="255"	Optional	`http://<IP address or host name>:<port number>/<service>`
`userName`			The user name String minLength value="1" maxLength value="255"	Optional	username
`password`			The password String minLengthvalue="6" maxLength value="255"	Optional	passwordtest
`vendor`			The vendor’s name String minLengthvalue="1" maxLength value="100"	Optional	vendor
`schema`			Sub-MO	Optional
	`fields`		Sub-MO	Optional	ADD
		`name`	The field name String minLengthvalue="1" maxLength value="100"	Optional	Name_test
		`type`	The field type String enumeration value="ID" enumeration value="FIRSTNAME" enumeration value="LASTNAME" enumeration value="DISPLAYNAME" enumeration value="PHONE" enumeration value="MOBILE" enumeration value="EMAIL" enumeration value="SIPURI" enumeration value="EXTENSION" enumeration value="TITLE" enumeration value="DEPARTMENT" enumeration value="LOCATION" enumeration value="PICTURE" enumeration value="STREETADDRESS" enumeration value="ZIPCODE" enumeration value="CITY" enumeration value="REGION" enumeration value="COUNTRY" enumeration value="SKILLS enumeration value="ROLE" enumeration value="COMPANY" enumeration value="WEBURL" enumeration value="FAX" enumeration value="UNDEFINED"	Optional	TITLE
		`searchable`	Indicates whether the field can be searched or not Boolean value="true" or "false"	Optional	true
		`primaryField`	Indicates whether the field is primary or not Boolean value="true" or "false"	Optional	false
	`uniqueId`		The field type String enumeration value="ID" enumeration value="FIRSTNAME" enumeration value="LASTNAME" enumeration value="DISPLAYNAME" enumeration value="PHONE" enumeration value="MOBILE" enumeration value="EMAIL" enumeration value="SIPURI" enumeration value="EXTENSION" enumeration value="TITLE" enumeration value="DEPARTMENT" enumeration value="LOCATION" enumeration value="PICTURE" enumeration value="STREETADDRESS" enumeration value="ZIPCODE" enumeration value="CITY" enumeration value="REGION" enumeration value="COUNTRY" enumeration value="SKILLS enumeration value="ROLE" enumeration value="COMPANY" enumeration value="WEBURL" enumeration value="FAX" enumeration value="UNDEFINED"	Optional	COMPANY

9.1.2 Example

An example for creating a Connection Profile is as follows:

Example 30 Creating a Connection Profile

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>ConnectionProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:connectionProfileId>${Properties#connectionprofileId}
            </bce:connectionProfileId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createConnectionProfile
   connectionProfileId="${Properties#connectionprofileId}">
               <!--Optional:-->
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:connectionProfileId>${Properties#connectionprofileId}
               </bce:connectionProfileId>
               <!--Optional:-->
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <!--Optional:-->
               <!--Optional:-->
               <bce:dbSchema>dbschema</bce:dbSchema>
               <!--Optional:-->
               <bce:directoryType>LDAP</bce:directoryType>
               <!--Optional:-->
               <bce:searchDomain>CN=Users,DC=tcv,DC=ics,DC=se
               </bce:searchDomain>
               <!--Optional:-->
               <bce:url>ldap://10.80.132.46:389</bce:url>
               <!--Optional:-->
               <bce:userName>tcv\ericsson</bce:userName>
               <!--Optional:-->
               <bce:password>wwwwww111111</bce:password>
               <!--Optional:-->
               <bce:vendor>vendor</bce:vendor>
               <!--Optional:-->
               <bce:schema>
                  <!--1 or more repetitions:-->
                  <bce:fields>
                     <bce:name>department</bce:name>
                     <bce:type>DEPARTMENT</bce:type>
                     <bce:searchable>true</bce:searchable>
                     <bce:primaryField>true</bce:primaryField>
                  </bce:fields>
                  <bce:fields>
                     <bce:name>mail</bce:name>
                     <bce:type>EMAIL</bce:type>
                     <bce:searchable>true</bce:searchable>
                     <bce:primaryField>true</bce:primaryField>
                  </bce:fields>
                  <bce:uniqueId>DEPARTMENT</bce:uniqueId>
               </bce:schema>
            </bce:createConnectionProfile>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

9.2 Deleting a Connection Profile

This section describes how to delete a Connection Profile.

MOType

ConnectionProfile@http://schemas.ericsson.com/ma/bce

9.2.1 Request Data

MOId

Table 48 MOID Parameters of Deleting a Connection Profile
Parameter	Type	Occurrence	Example
`connectionProfileId`	The ID of the Connection Profile String minLength value="1" maxLength value="20"	Mandatory	connprofId

MOAttributes

Table 49 MOAttributes of Deleting a Connection Profile
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Optional	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Optional	eda_1

9.2.2 Example

An example for deleting a Connection Profile is as follows:

Example 31 Deleting a Connection Profile

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>ConnectionProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:connectionProfileId>${Properties#connectionprofileId}
            </bce:connectionProfileId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:deleteConnectionProfile>
               <!--Optional:-->
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <!--Optional:-->
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            </bce:deleteConnectionProfile>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

9.3 Setting a Connection Profile

This section describes how to set a Connection Profile.

MOType

ConnectionProfile@http://schemas.ericsson.com/ma/bce

9.3.1 Request Data

MOId

Table 50 MOID Parameters of Setting a Connection Profile
Parameter	Type	Occurrence	Example
`connectionProfileId`	The ID of the Connection Profile String minLength value="1" maxLength value="20"	Mandatory	connprofId

MOAttributes

Table 51 MOAttributes of Setting a Connection Profile
Parameter			Type	Occurrence	Example
`connectionProfileId`			The ID of the Connection Profile String minLength value="1" maxLength value="20"	Mandatory	connprofId
`dbSchema`			The DB schema String minLength value="1" maxLength value="100"	Optional	dbschema
`directoryType`			The type of directory String enumeration value="DUMMY" enumeration value="SRD" enumeration value="SQL" enumeration value="VOICE" enumeration value="BCSDIR" enumeration value="LDAP"	Optional	SQL
`searchDomain`			The domain of searching String minLength value="1" maxLength value="100"	Optional	domain
`url`			The url address String minLength value="1" maxLength value="255"	Optional	`http://<IP address or host name>:<port number>/<service>`
`userName`			The user name String minLength value="1" maxLength value="255"	Optional	username
`password`			The password String minLengthvalue="6" maxLength value="255"	Optional	passwordtest
`vendor`			The vendor’s name String minLengthvalue="1" maxLength value="100"	Optional	vendor
`schema`			Sub-MO	Optional
	`fields`		Sub-MO	Optional	ADD
		`name`	The field name String minLengthvalue="1" maxLength value="100"	Optional	Name_test
		`type`	The field type String enumeration value="ID" enumeration value="FIRSTNAME" enumeration value="LASTNAME" enumeration value="DISPLAYNAME" enumeration value="PHONE" enumeration value="MOBILE" enumeration value="EMAIL" enumeration value="SIPURI" enumeration value="EXTENSION" enumeration value="TITLE" enumeration value="DEPARTMENT" enumeration value="LOCATION" enumeration value="PICTURE" enumeration value="STREETADDRESS" enumeration value="ZIPCODE" enumeration value="CITY" enumeration value="REGION" enumeration value="COUNTRY" enumeration value="SKILLS enumeration value="ROLE" enumeration value="COMPANY" enumeration value="WEBURL" enumeration value="FAX" enumeration value="UNDEFINED"	Optional	TITLE
		`searchable`	Indicates whether the field can be searched or not Boolean value="true" or "false"	Optional	true
		`primaryField`	Indicates whether the field is primary or not Boolean value="true" or "false"	Optional	false
	`uniqueId`		The field type String enumeration value="ID" enumeration value="FIRSTNAME" enumeration value="LASTNAME" enumeration value="DISPLAYNAME" enumeration value="PHONE" enumeration value="MOBILE" enumeration value="EMAIL" enumeration value="SIPURI" enumeration value="EXTENSION" enumeration value="TITLE" enumeration value="DEPARTMENT" enumeration value="LOCATION" enumeration value="PICTURE" enumeration value="STREETADDRESS" enumeration value="ZIPCODE" enumeration value="CITY" enumeration value="REGION" enumeration value="COUNTRY" enumeration value="SKILLS enumeration value="ROLE" enumeration value="COMPANY" enumeration value="WEBURL" enumeration value="FAX" enumeration value="UNDEFINED"	Optional	COMPANY
	`operation`		The type of operation String enumeration value="DELETE"	Optional	DELETE

9.3.2 Example

An example for setting a Connection Profile is as follows:

Example 32 Setting a Connection Profile

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>ConnectionProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:connectionProfileId>${Properties#connectionprofileId}
            </bce:connectionProfileId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setConnectionProfile connectionProfileId="${Properties#connectionprofileId}">
               <bce:connectionProfileId>${Properties#connectionprofileId}
               </bce:connectionProfileId>
               <bce:directoryType>LDAP</bce:directoryType>
               <bce:schema>
                  <bce:fields>
                     <bce:name>department</bce:name>
                     <bce:type>DEPARTMENT</bce:type>
                     <bce:searchable>true</bce:searchable>
                     <bce:primaryField>true</bce:primaryField>
                  </bce:fields>
                  <!--1 or more repetitions:-->
                  <bce:uniqueId>DEPARTMENT</bce:uniqueId>
                  <!--Optional:-->
                  <bce:operation>DELETE</bce:operation>
               </bce:schema>
            </bce:setConnectionProfile>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

9.4 Getting a Connection Profile

This section describes how to get a Connection Profile.

MOType

ConnectionProfile@http://schemas.ericsson.com/ma/bce

9.4.1 Request Data

MOId

Table 52 MOID Parameters of Getting a Connection Profile
Parameter	Type	Occurrence	Example
`connectionProfileId`	The ID of the Connection Profile String minLength value="1" maxLength value="20"	Mandatory	connprofId

9.4.2 Response Data

For the parameter details of the Get response operation, refer to Table 47.

9.4.3 Example

An example for getting a Connection Profile is as follows:

Example 33 Getting a Connection Profile

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>ConnectionProfile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:connectionProfileId>${Properties#connectionprofileId}
            </bce:connectionProfileId>
         </cai3:MOId>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>d6a39407b9f7446aa02b6d0d0b1f7517</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getConnectionProfileResponse connectionProfileId="connprofidd"
               xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:connectionProfileId>connprofidd</bce:connectionProfileId>
               <bce:dbSchema>dbschema</bce:dbSchema>
               <bce:directoryType>LDAP</bce:directoryType>
               <bce:searchDomain>CN=Users,DC=tcv,DC=ics,DC=se
               </bce:searchDomain>
               <bce:url>ldap://10.80.132.46:389</bce:url>
               <bce:userName>tcv\ericsson</bce:userName>
               <bce:password>wwwwww111111</bce:password>
               <bce:vendor>vendor</bce:vendor>
               <bce:schema>
                  <bce:fields>
                     <bce:name>mail</bce:name>
                     <bce:type>EMAIL</bce:type>
                     <bce:searchable>true</bce:searchable>
                     <bce:primaryField>true</bce:primaryField>
                  </bce:fields>
                  <bce:fields>
                     <bce:name>department</bce:name>
                     <bce:type>DEPARTMENT</bce:type>
                     <bce:searchable>true</bce:searchable>
                     <bce:primaryField>true</bce:primaryField>
                  </bce:fields>
                  <bce:uniqueId>DEPARTMENT</bce:uniqueId>
               </bce:schema>
            </bce:getConnectionProfileResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

10 BCE File

10.1 Deleting a BCE File

This section describes how to delete a BCE File.

MOType

File@http://schemas.ericsson.com/ma/bce/

10.1.1 Request Data

MOId

Table 53 MOID Parameters of Deleting a BCE File
Parameter	Type	Occurrence	Example
`fileId`	The ID of the BCE file Long	Mandatory	123456789

10.1.2 Example

An example for deleting a BCE File is as follows:

Example 34 Deleting a BCE File

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>File@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:fileId>2109</bce:fileId>
         </cai3:MOId>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

10.2 Setting a BCE File

This section describes how to set a BCE File.

MOType

File@http://schemas.ericsson.com/ma/bce/

10.2.1 Request Data

MOId

Table 54 MOID Parameters of Setting a BCE File
Parameter	Type	Occurrence	Example
`fileId`	The ID of the BCE file Long	Mandatory	123456789

MOAttributes

Table 55 MOAttributes of Setting a BCE File
Parameter		Type	Occurrence	Example
`fileId`		The ID of the BCE file Long	Mandatory	123456789
`fileData`		The file data String	Optional	File_data
`metaData`		Sub-MO	Optional
	`name`	The name of the meta data String	Optional	CDG_WELCOME
	`extension`	The extension of the meta data String	Optional	wav
	`Description`	The description of the meta data String	Optional	CDG_WELCOME
	`language`	The language of the meta data String	Optional	SE

10.2.2 Example

An example for setting a BCE File is as follows:

Example 35 Setting a BCE File

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>File@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:fileId>2109</bce:fileId>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:setFile fileId="2109">
               <!--Optional:-->
               <bce:fileId>2109</bce:fileId>
               <!--Optional:-->
               <bce:fileData>UklGRiR5AABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAA
BmYWN0BAAAAPJ4AABkYXRh8ngAANXVVVVVVVVUVFRVVFVUVVRUVVRUVVRVVFRVVFVUVFVUVVVVVVRVV
VVV1VXVVdVV1VXVVdVV1dXV1dXV1dXV1dTV1NXU1NXU1dXU1NXV1dXV1dXV1dXV1VXV1VXVVVVVVVVU
VFRUVFRUVFRUVFRXVFRUVFRUVFRUVVVUVVVVVdXVVdXV1dVV1VXV1dXV1dXV1dXV1dXV1dVV1VX

&mldr;

VVFVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVFVUVVRVVVRVVFVUVFVUVVVVVVVVVVVV1VXVVdVV1dVV1V
XVVdVV1dVV1VVVVdVV1VXV1VXVVdXVVdXVVdXV1dVV1VXV1dVV1dXV1VXV1dVV1VXV1VXVVdVV1VXV1
VXVVdVV1VXVVdXV1dXV1dXV1dXV1dXVVdVV1VXVVdXV1dXVVdXV1dVV1dXV1dXV1dXVVdVV1VXVVdXV
VdVV1VXV1dXVVdVV</bce:fileData>
               <!--Optional:-->
               <bce:metaData>
                  <!--Optional:-->
                  <bce:name>CDG_WELCOME_EMA_Test_update</bce:name>
                  <!--Optional:-->
                  <bce:description>CDG_WELCOME_EMA_Test_update</bce:description>
                  <!--Optional:-->
                  <bce:language>SE</bce:language>
               </bce:metaData>
            </bce:setFile>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

10.3 Getting a BCE File

This section describes how to get a BCE File.

MOType

File@http://schemas.ericsson.com/ma/bce/

10.3.1 Request Data

MOId

Table 56 MOID Parameters of Getting a BCE File
Parameter	Type	Occurrence	Example
`fileId`	The ID of the BCE file Long	Mandatory	123456789

MOAttributes

Table 57 MOAttributes of Getting a BCE File
Parameter			Type	Occurrence	Example
`fileId`			The ID of the BCE file Long	Mandatory	1234
`fileDescriptors`			Sub-MO	Optional
	`externalUrl`		The external url of the file	Optional	http://10.80.132.76:38080/services/files/UwHaH6tJKypeYY1lEVWja0WAcKXoAXgzM7m2fUrVbyEsHQ8xBFAgAwixvM4vURYI
	`fileSize`		The file size	Optional
	`id`		The ID of the BCE file Long	Optional	1234
	`internalUrl`		The internal url of the file	Optional	http://10.80.132.76:38080/services/files/UwHaH6tJKypeYY1lEVWja0WAcKXoAXgzM7m2fUrVbyEsHQ8xBFAgAwixvM4vURY
	`metaData`			Optional
		`name`	The name of the meta data String	Optional	CDG_WELCOME
		`extension`	The extension of the meta data String	Optional	wav
		`Description`	The description of the meta data String	Optional	CDG_WELCOME
		`language`	The language of the meta data String	Optional	SE
	`mimeType`		The Multipurpose Internet Mail Extensions (MIME) type of the Company file String	Optional	audio/wav
	`uniqueHash`		The unique Hash of the file	Optional	UwHaH6tJKypeYY1lEVWja0WAcKXoAXgzM7m2fUrVbyEsHQ8xBFAgAwixvM4vURYI
`fileData`			The data of the BCE file String	Optional	File_data

10.3.2 Example

An example for getting a BCE File is as follows:

Example 36 Getting a BCE File

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>9551333b5aee417d8deb258fdea7f91b</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>File@http://schemas.ericsson.com/ma/bce/</cai3:MOType>
         <cai3:MOId>
            <bce:fileId>2109</bce:fileId>
         </cai3:MOId>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>9551333b5aee417d8deb258fdea7f91b</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getFileResponse fileId="2109"
             xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:fileId>2109</bce:fileId>
               <bce:fileDescriptors>
                  <bce:externalUrl>
http://10.80.132.76:38080/services/files/qgD7ioL7n6XInkuB5nwns1v
tiXV9YBhlzBYk-0UcvoMT6_qeVoks6I7kHsj_xvhW
                  </bce:externalUrl>
                  <bce:fileSize>24120</bce:fileSize>
                  <bce:id>2109</bce:id>
                  <bce:internalUrl>
http://10.80.132.76:38080/services/files/qgD7ioL7n6XInkuB5nwns1v
tiXV9YBhlzBYk-0UcvoMT6_qeVoks6I7kHsj_xvhW
                  </bce:internalUrl>
                  <bce:metaData>
                     <bce:name>CDG_WELCOME_EMA_Test</bce:name>
                     <bce:extension>wav</bce:extension>
                     <bce:description>CDG_WELCOME_EMA_Test</bce:description>
                     <bce:language>EN</bce:language>
                  </bce:metaData>
                  <bce:mimeType>audio/wav</bce:mimeType>
                  <bce:uniqueHash>qgD7ioL7n6XInkuB5nwns1vtiXV9YBh
lzBYk-0UcvoMT6_qeVoks6I7kHsj_xvhW</bce:uniqueHash>
               </bce:fileDescriptors>
               <bce:fileData>UklGRjBeAABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAA
gAAABmYWN0BAAAAP5dAABkYXRh/l0AANXV1dXV1dXVVdXV1NXU1NTV1NXV1dVV1VXV1VXV1dVVV
VVVVVVV1VXVVVVUVFRXVFdUVFRXVFdXVldXV1dXVFRUV1dXV1dUVVRUVFdUVFRUVFRUV1RXV1RX
VFRUVFdUVFVUVVVV1dVV1VXV1NTV1dXV1dXU1NTX19fX19bW1tbR0dDR0NHQ0dDR0NDT09PT09D
Q0NDQ0NDT0NDQ0NDQ0dHR0dHW0dHW1tfW19fW1NfU1NTV1dVV1VVUVFRUV1RXVFdXVlZRVlFWUVZR

&mldr;

VRV1VXVVdVV1VXV1VXV1VXVVdXVVdVV1VVVVVVUVVRVVFVUVVRVVFRVVFVUVVRUVFRUVFRUVFRUV
FdXVFRUVFdXV1dXV1dXV1RXV1RXV1RUVFRVVVVV1VVVVdXVVdVV1VXVVdXV1dXVVdXV1dXV1dXVV
dXV1dXVVdVV1VXV1VXVVdXVVdXVVdXV1dXV1dXV1dXU1dTU1dTU1NTU1NTU1NTU1NTU1NTX1NTU1
dTV1dXV1VXV1VXV1VVVVVVVVFVUVFdUV1RUV1RXV1RXV1dXV1ZXVlZWVldWVlZWUVZWVldWVldXV
1dUV1RXVFRUVFRUVFVVVFVUVVVVVVVV1dVV1dXV1dXV1NXU1NTV1NTU1dTV1NTV1NTU1NTU1NTU1
9TU19XV</bce:fileData>
            </bce:getFileResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

11 Company File

11.1 Creating a Company File

This section describes how to create a Company file.

MOType

CompanyFile@http://schemas.ericsson.com/ma/bce/

11.1.1 Request Data

MOId

Table 58 MOID Parameters of Creating a Company File
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`mediaType`	The media type of the Company file String enumeration value="PICTURE" enumeration value="AUDIO"	Mandatory	PICTURE

MOAttributes

Table 59 MOAttributes of Creating a Company File
Parameter		Type	Occurrence	Example
`serviceProviderId`		The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`		The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`mediaType`		The media type of the Company file String enumeration value="PICTURE" enumeration value="AUDIO"	Mandatory	PICTURE
`mimeType`		The Multipurpose Internet Mail Extensions (MIME) type of the Company file String	Optional	MIME
`metaData`		Sub-MO	Optional
	`name`	The name of the meta data String	Optional	CDG_WELCOME
	`extension`	The extension of the meta data String	Optional	wav
	`Description`	The description of the meta data String	Optional	CDG_WELCOME
	`language`	The language of the meta data String	Optional	EN
`data`		The data of the Company file String	Optional	filedata

11.1.2 Example

An example for Creating a Company file is as follows:

Example 37 Creating a Company File

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>CompanyFile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:mediaType>AUDIO</bce:mediaType>
         </cai3:MOId>
         <cai3:MOAttributes>
            <bce:createCompanyFile serviceProviderId="${Properties#ProviderId}"
 companyId="${Properties#CompanyId_1}" mediaType="AUDIO">
               <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
               <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
               <bce:mediaType>AUDIO</bce:mediaType>
               <!--Optional:-->
               <bce:mimeType>audio/wav</bce:mimeType>
               <!--Optional:-->
               <bce:metaData>
                  <!--Optional:-->
                  <bce:name>CDG_WELCOME_EMA_Test</bce:name>
                  <!--Optional:-->
                  <bce:extension>wav</bce:extension>
                  <!--Optional:-->
                  <bce:description>CDG_WELCOME_EMA_Test</bce:description>
                  <!--Optional:-->
                  <bce:language>CN</bce:language>
               </bce:metaData>
               <!--Optional:-->
               <bce:data>UklGRjBeAABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAABmY
WN0BAAAAP5dAABkYXRh/l0AANXV1dXV1dXVVdXV1NXU1NTV1NXV1dVV1VXV1VXV1dVVVVVVVVVV1VX
VVVVUVFRXVFdUVFRXVFdXVldXV1dXVFRUV1dXV1dUVVRUVFdUVFRUVFRUV1RXV1RXVFRUVFdUVFVUV
VVV1dVV1VXV1NTV1dXV1dXU1NTX19fX19bW1tbR0dDR0NHQ0dDR0NDT09PT09DQ0NDQ0NDT0NDQ0NDQ0

&mldr;

U1dTU1dTU1NTU1NTU1NTU1NTU1NTX1NTU1dTV1dXV1VXV1VXV1VVVVVVVVFVUVFdUV1RUV1RXV1RXV1
dXV1ZXVlZWVldWVlZWUVZWVldWVldXV1dUV1RXVFRUVFRUVFVVVFVUVVVVVVVV1dVV1dXV1dXV1NXU1
NTV1NTU1dTV1NTV1NTU1NTU1NTU19TU19XV</bce:data>
            </bce:createCompanyFile>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

11.2 Deleting a Company File

This section describes how to delete a Company File.

MOType

CompanyFile@http://schemas.ericsson.com/ma/bce/

11.2.1 Request Data

MOId

Table 60 MOID Parameters of Deleting a Company File
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`mediaType`	The media type of the Company file String enumeration value="PICTURE" enumeration value="AUDIO"	Mandatory	PICTURE

11.2.2 Example

An example for deleting a Company File is as follows:

Example 38 Deleting a Company File

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>CompanyFile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:mediaType>AUDIO</bce:mediaType>
         </cai3:MOId>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

11.3 Getting a Company File

This section describes how to get a Company File.

MOType

CompanyFile@http://schemas.ericsson.com/ma/bce/

11.3.1 Request Data

MOId

Table 61 MOID Parameters of Getting a Company File
Parameter	Type	Occurrence	Example
`serviceProviderId`	The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`	The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`mediaType`	The media type of the Company file String enumeration value="PICTURE" enumeration value="AUDIO"	Mandatory	PICTURE

MOAttributes

Table 62 MOAttributes of Getting a Company File Response
Parameter			Type	Occurrence	Example
`serviceProviderId`			The service Provider ID String minLength value="1" maxLength value="20"	Mandatory	sp-tcv
`companyId`			The ID of the Company String minLength value="1" maxLength value="20"	Mandatory	eda_1
`mediaType`			The media type of the Company file String enumeration value="PICTURE" enumeration value="AUDIO"	Mandatory	PICTURE
`fileDescriptors`			Sub-MO	Optional
	`externalUrl`		The external url of the file	Optional	http://10.80.132.76:38080/services/files/UwHaH6tJKypeYY1lEVWja0WAcKXoAXgzM7m2fUrVbyEsHQ8xBFAgAwixvM4vURYI
	`fileSize`		The file size	Optional
	`id`		The ID of the BCE file Long	Optional	1234
	`internalUrl`		The internal url of the file	Optional	http://10.80.132.76:38080/services/files/UwHaH6tJKypeYY1lEVWja0WAcKXoAXgzM7m2fUrVbyEsHQ8xBFAgAwixvM4vURY
	`metaData`		Sub-MO	Optional
		`name`	The name of the meta data String	Optional	CDG_WELCOME
		`extension`	The extension of the meta data String	Optional	wav
		`Description`	The description of the meta data String	Optional	CDG_WELCOME
		`language`	The language of the meta data String	Optional	SE
	`mimeType`		The Multipurpose Internet Mail Extensions (MIME) type of the Company file String	Optional	audio/wav
	`uniqueHash`		The unique Hash of the file	Optional	UwHaH6tJKypeYY1lEVWja0WAcKXoAXgzM7m2fUrVbyEsHQ8xBFAgAwixvM4vURYI

11.3.2 Example

An example for getting a Company file is as follows:

Example 39 Getting a Company File

Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:bce="http://schemas.ericsson.com/ma/bce/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>CompanyFile@http://schemas.ericsson.com/ma/bce/
         </cai3:MOType>
         <cai3:MOId>
            <bce:serviceProviderId>${Properties#ProviderId}</bce:serviceProviderId>
            <bce:companyId>${Properties#CompanyId_1}</bce:companyId>
            <bce:mediaType>AUDIO</bce:mediaType>
         </cai3:MOId>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>b55cf599066c440f8b58113461024025</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <bce:getCompanyFileResponse companyId="ema_13819170"
             mediaType="AUDIO" serviceProviderId="sp-tcv"
             xmlns:bce="http://schemas.ericsson.com/ma/bce/">
               <bce:serviceProviderId>sp-tcv</bce:serviceProviderId>
               <bce:companyId>ema_13819170</bce:companyId>
               <bce:mediaType>AUDIO</bce:mediaType>
               <bce:fileDescriptors>
                  <bce:externalUrl>
http://10.80.132.76:38080/services/files/t2EXw6nVaUj22Qf8TmwLi_nzPOYHr7cifDPdLve9q67CrN8C1NYbyJWATH6Dc49H
                  </bce:externalUrl>
                  <bce:fileSize>23686</bce:fileSize>
                  <bce:id>1839</bce:id>
                  <bce:internalUrl>
http://10.80.132.76:38080/services/files/t2EXw6nVaUj22Qf8TmwLi_nzPOYHr7cifDPdLve9q67CrN8C1NYbyJWATH6Dc49H
                   </bce:internalUrl>
                  <bce:metaData>
                     <bce:name>CDG_RINGING_EMA_Test</bce:name>
                     <bce:extension>wav</bce:extension>
                     <bce:description>CDG_RINGING_EMA_Test</bce:description>
                     <bce:language>SE</bce:language>
                  </bce:metaData>
                  <bce:mimeType>audio/wav</bce:mimeType>
                  <bce:uniqueHash>
t2EXw6nVaUj22Qf8TmwLi_nzPOYHr7cifDPdLve9q67CrN8C1NYbyJWATH6Dc49H
                   </bce:uniqueHash>
               </bce:fileDescriptors>
               <bce:fileDescriptors>
                  <bce:externalUrl>
http://10.80.132.76:38080/services/files/oJwaLhhDNKiPkeya8-sMyqb-bmlJPpxcBNr6xp9-o1UrDdWWjjhqsSW-Z0BtwUXG
                  </bce:externalUrl>
                  <bce:fileSize>24120</bce:fileSize>
                  <bce:id>1838</bce:id>
                  <bce:internalUrl>
http://10.80.132.76:38080/services/files/oJwaLhhDNKiPkeya8-sMyqb-bmlJPpxcBNr6xp9-o1UrDdWWjjhqsSW-Z0BtwUXG
                  </bce:internalUrl>
                  <bce:metaData>
                     <bce:name>CDG_WELCOME_EMA_Test</bce:name>
                     <bce:extension>wav</bce:extension>
                     <bce:description>CDG_WELCOME_EMA_Test</bce:description>
                     <bce:language>CN</bce:language>
                  </bce:metaData>
                  <bce:mimeType>audio/wav</bce:mimeType>
                  <bce:uniqueHash>oJwaLhhDNKiPkeya8-sMyqb-bmlJPpxcBNr6xp9-o1UrDdWWjjhqsSW-Z0BtwUXG
                  </bce:uniqueHash>
               </bce:fileDescriptors>
            </bce:getCompanyFileResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

12 Error Code

Table 63 Error Code for BCE
Error Code	Error Message
37101	An active user can not be deleted.
37102	Untrusted host for UP write operation
37103	Object already exists or duplicated
37104	Object not found
37105	Host address missing
37106	Attributes format error or invalid or illegal
37107	Insufficient parameters
37108	Constraint violation
37109	Concurrent write. Please retry
37100	Feedback loop error
37111	Application error
37121	The node has existing children
37199	Other Error

Reference List


[1] Library Overview, 18/1553-CSH 109 628 Uen
[2] Generic CAI3G Interface 1.2, 2/15519-FAY3020003 Uen