Contents

1   Introduction

This section is an introduction to this document. It 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 operations or Customers Service Orders (CSOs) in the provisioning of the Authentication Vector Generation (AVG) service in the CAI3G interface, which is used for provisioning of HSS FE module data. This document also declares the types and occurrences of the attributes used in the operations.

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

1.2   Target Groups

The target groups for this document are as follows:

• System Integrator

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

1.3   Typographic Conventions

Typographic conventions are described in Library Overview, Reference [3].

In addition, this document uses the following to indicate operations:

1.4   Prerequisites

To use this document fully, users must meet the following prerequisites:

• Basic knowledge about the Ericsson™ Dynamic Activation (EDA) product.
• Knowledge about Generic CAI3G Interface 1.2, Reference [2]

1.5   Namespaces

This document refers to the following namespaces:

• CAI3G 1.2 namespace:

  http://schemas.ericsson.com/cai3g1.2/

• Provisioning namespace:

  http://schemas.ericsson.com/ma/HSS/

1.6   Legends

The following table shows the legends used in XML schema figures in this specification.

1.7   Operations

One Managed Object (MO) with four operations are described in this document. See the following table for the commands and valid operations:

1.8   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:

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

1.9   MOType

MOType is a plain text string based on the type xs:string. An MO type 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 MO type 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.10   MOId

MOId is an Extensible Markup Language (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:

<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   Create AVGMultiSC

This section covers the AVG command CreateAVGMultiSC.

MOType

AVGMultiSC@http://schemas.ericsson.com/ma/HSS/

2.1   Request Data

Note:  

It is not allowed to create new services for a subscriber (Multi Service Consumer, AVGMultiSC) when the subscriber (Multi Service Consumer) is involved in an ongoing IMSI Changeover. This applies to both the old and new IMSI.

2.1.1   Parameters

MOId

(1)  One of the parameters, impi, or imsi, must be included in the request. An IMSI must be provisioned if AVG service is provisioned for a subscriber that is also defined in IMS, LTE, CSPS, or AVGMultiSC.

MOAttributes

The parameters that are used in the operation are shown in Figure 1

The following table covers the parameters that can be used in a CreateAVGMultiSC request.

(1)  One of the parameters, impi, or imsi, must be included in the request. An IMSI must be provisioned if AVG service is provisioned for a subscriber that is also defined in IMS, LTE, CSPS, or AVGMultiSC.

2.2   Examples

Request Example

This section gives an example of a CreateAVGMultiSC request, as shown in Example 2.

<soapenv:Envelope
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/" xmlns:hss="http://schemas.ericsson.com/ma/HSS/">
	<soapenv:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</soapenv:Header>
	<soapenv:Body>
		<cai3g:Create>
			<cai3g:MOType>AVGMultiSC@http://schemas.ericsson.com/ma/HSS/</cai3g:MOType>
			<cai3g:MOId>
				<!--You have a CHOICE of the next 2 items at this level-->
				<hss:imsi>123456</hss:imsi>
				<hss:impi>sip:user@ims.operator.org</hss:impi>
			</cai3g:MOId>
			<cai3g:MOAttributes>
				<hss:CreateAVGMultiSC imsi=123456 impi=sip:user@ims.operator.org>
					<!--You have a CHOICE of the next 2 items at this level-->
					<hss:imsi>123456</hss:imsi>
					<hss:impi>sip:user@ims.operator.org</hss:impi>
					<hss:avgEncryptedK>1234567890ABCDEF1234567890ABCDEF
					</hss:avgEncryptedK>
					<hss:avgA4KeyInd>2</hss:avgA4KeyInd>
					<hss:avgFSetInd>1</hss:avgFSetInd>
					<!--Optional:-->
					<hss:avgAmf>0001</hss:avgAmf>
					<hss:zoneid>128</hss:zoneid>
				</hss:CreateAVGMultiSC>
			</cai3g:MOAttributes>
		</cai3g:Create>
	</soapenv:Body>
</soapenv:Envelope>

An AVG subscription with IMSI 123456 is initiated.

Response Example

This section gives an example of a CreateAVGMultiSC response message, as shown in Example 3.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
	<S:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</S:Header>
	<S:Body>
		<ns2:CreateResponse xmlns:ns2= "http://schemas.ericsson.com/cai3g1.2/">
			<ns2:MOId>
				<hss:imsi xmlns:hss= "http://schemas.ericsson.com/ma/HSS/">123456
				</hss:imsi>
			</ns2:MOId>
		</ns2:CreateResponse>
	</S:Body>
</S:Envelope>

3   Set AVGMultiSC

This section covers the AVG command SetAVGMultiSC.

MOType

AVGMultiSC@http://schemas.ericsson.com/ma/HSS/

3.1   Request Data

3.1.1   Parameters

MOId

(1)  One of the parameters, impi, or imsi, must be included in the request.

The parameters that are used in the operation are shown in Figure 2

The following table covers the parameters that can be used in a SetAVGMultiSC request.

(1)  One of the parameters, impi, or imsi, must be included in the request.

(2)  When this attribute is changed, avgA4KeyInd must be modified so, that is, both parameters must be present in the Set AVGMultiSC CSO.

(3)  When this attribute is changed, avgEncryptedK must be modified so, that is, both parameters must be present in the Set AVGMultiSC CSO.

(4)  If the avgEncryptedOPc is defined and avgA4KeyInd is modified, avgEncryptedOPc must also be modified, that is, both attributes must be present in the Set AVGMultiSC CSO.

3.2   Examples

Request Example

This section gives an example of a SetAVGMultiSC request, as shown in Example 4.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:hss="http://schemas.ericsson.com/ma/HSS/">
	<soapenv:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</soapenv:Header>
	<soapenv:Body>
		<cai3g:Set>
			<cai3g:MOType>AVGMultiSC@http://schemas.ericsson.com/ma/HSS/
			</cai3g:MOType>
			<cai3g:MOId>
				<!--You have a CHOICE of the next 2 items at this level-->
				<hss:imsi>123456</hss:imsi>
				<hss:impi>sip:user@ims.operator.org</hss:impi>
			</cai3g:MOId>
			<cai3g:MOAttributes>
				<hss:SetAVGMultiSC imsi=123456 
				impi=sip:user@ims.operator.org>
					<!--Optional:-->
					<hss:avgEncryptedK>1234567890ABCDEF1234567890ABCDEF
					</hss:avgEncryptedK>
					<!--Optional:-->
					<hss:avgA4KeyInd>2</hss:avgA4KeyInd>
					<!--Optional:-->
					<hss:avgAmf>0001</hss:avgAmf>
				</hss:SetAVGMultiSC>
			</cai3g:MOAttributes>
		</cai3g:Set>
	</soapenv:Body>
</soapenv:Envelope>

The AVG subscription with IMSI 123456 has been updated.

Response Example

This section gives an example of a SetAVGMultiSC response message, as shown in Example 5.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
	<S:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</S:Header>
	<S:Body>
		<ns2:SetResponse xmlns:ns2= "http://schemas.ericsson.com/cai3g1.2/"/>
	</S:Body>
</S:Envelope>

4   Get AVGMultiSC

This section covers the AVG command GetAVGMultiSC.

MOType

AVGMultiSC@http://schemas.ericsson.com/ma/HSS/

4.1   Request Data

4.1.1   Parameters

The following table covers the parameters that can be sent in a GetAVGMultiSC request.

(1)  One of the parameters, impi, or imsi, must be included in the request.

4.2   Response Data

4.2.1   Parameters

MOId

(1)  One of the parameters, impi, or imsi, must be included in the request.

MOAttributes

The parameters that are used in the operation are shown in Figure 3.

The following table covers the parameters that can be received in a GetAVGMultiSC response.

(1)  One of the parameters, impi, or imsi, must be included in the request.

4.3   Examples

Request Example

This section gives an example of a GetAVGMultiSC request, as shown in Example 6.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:hss="http://schemas.ericsson.com/ma/HSS/">
	<soapenv:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</soapenv:Header>
	<soapenv:Body>
		<cai3g:Get>
			<cai3g:MOType>AVGMultiSC@http://schemas.ericsson.com/ma/HSS/</cai3g:MOType>
			<cai3g:MOId>
				<!--You have a CHOICE of the next 2 items at this level-->
				<hss:imsi>123456</hss:imsi>
				<hss:impi>sip:user@ims.operator.org</hss:impi>
			</cai3g:MOId>
		</cai3g:Get>
	</soapenv:Body>
</soapenv:Envelope>

Response Example

This section gives an example of a GetAVGMultiSC response message, as shown in Example 7.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
  <soapenv:Header>
    <cai3g:SessionId>150466530</cai3g:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <ns2:GetResponse xmlns:ns2= "http://schemas.ericsson.com/cai3g1.2/">
      <ns2:MOAttributes>
       <ns:GetResponseAVGMultiSC imsi=123456 
           xmlns:ns="http://schemas.ericsson.com/ma/HSS/">
          <ns:imsi>123456</ns:imsi>
          <ns:avgEncryptedK>1234567890ABCDEF1234567890ABCDEF</ns:avgEncryptedK>
          <ns:avgA4KeyInd>2</ns:avgA4KeyInd>
          <ns:avgFSetInd>1</ns:avgFSetInd>
          <ns:avgAmf>0001</ns:avgAmf>
          <ns:zoneid>128</ns:zoneid>
       </ns:GetResponseAVGMultiSC>
       </ns2:MOAttributes>
     </ns2:GetResponse>
  </soapenv:Body>
</soapenv:Envelope>

The AVG subscription with IMSI 123456 is printed.

5   Delete AVGMultiSC

This section covers the AVG command DeleteAVGMultiSC.

This command is always capable of removing an AVG service, even if a previous Create or Delete has failed.

MOType

AVGMultiSC@http://schemas.ericsson.com/ma/HSS/

5.1   Request Data

5.1.1   Parameters

MOId

The following table covers the parameters that can be used in a DeleteAVGMultiSC request.

(1)  One of the parameters, impi, or imsi, must be included in the request.

MOAttributes

5.2   Examples

Request Example

This section gives an example of a DeleteAVGMultiSC request, as shown in Example 8.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:hss="http://schemas.ericsson.com/ma/HSS/">
	<soapenv:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</soapenv:Header>
	<soapenv:Body>
		<cai3g:Delete>
			<cai3g:MOType>AVGMultiSC@http://schemas.ericsson.com/ma/HSS/</cai3g:MOType>
			<cai3g:MOId>
				<!--You have a CHOICE of the next 2 items at this level-->
				<hss:imsi>123456</hss:imsi>
				<hss:impi>sip:user@ims.operator.org</hss:impi>
			</cai3g:MOId>
		</cai3g:Delete>
	</soapenv:Body>
</soapenv:Envelope>

The AVG subscription with IMSI 123456 is deleted.

Response Example

This section gives an example of a DeleteAVGMultiSC response message, as shown in Example 9.

<S:Envelope
 xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
	<S:Header>
		<cai3g:SessionId>150466530</cai3g:SessionId>
	</S:Header>
	<S:Body>
		<ns2:DeleteResponse xmlns:ns2= "http://schemas.ericsson.com/cai3g1.2/">
			<ns2:MOId>
				<hss:imsi xmlns:hss= "http://schemas.ericsson.com/ma/HSS/">
				123456</hss:imsi>
			</ns2:MOId>
		</ns2:DeleteResponse>
	</S:Body>
</S:Envelope>

6   Faults and Errors

The generic structure for fault responses is covered in Generic CAI3G Interface 1.2, Reference [2]. That document also covers the generic fault codes, which are applicable to all CAI3G operations.

This section covers the subordinate CAI3G errors. They can appear in the errorcode element in the error message.

Only AVG specific error codes are described in this section. These error codes are included in the Fault type AVGFault.

For generic error codes, and information about the different Fault types, see CAI3G Implementation, Reference [5].

6.1   Subordinate AVG Error Codes

The following table covers subordinate error codes for AVG commands over the CAI3G interface.

6.2   CAI3G Error Message Example

The following, shown in Example 10, is an example of a CAI3G error message.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>a829efcb5c0d4a57a359db1112b1fe26</cai3g:SessionId>
      <cai3g:TransactionId>22</cai3g:TransactionId>
      <cai3g:SequenceId>568498212</cai3g:SequenceId>
   </S:Header>
   <S:Body>
      <ns2:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" 
      xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
         <faultcode>ns2:Server</faultcode>
         <faultstring>This is a server fault</faultstring>
         <detail>
            <Cai3gFault:Cai3gFault xmlns="http://schemas.ericsson.com/cai3g1.2/" 
            xmlns:Cai3gFault="http://schemas.ericsson.com/cai3g1.2/">
               <faultcode>4006</faultcode>
               <faultreason>
                  <reasonText>External error.</reasonText>
               </faultreason>
               <faultrole>MF</faultrole>
               <details>
                  <AVGFault:AVGFault xmlns="http://schemas.ericsson.com/pg/1.0" 
                  xmlns:AVGFault="http://schemas.ericsson.com/pg/1.0">
                     <errorcode>13002</errorcode>
                     <errormessage>SERVICE ALREADY DEFINED</errormessage>
                     <errordetails>IMSI defined and AVG service exists - 
                     [Processed by PG Node: CL24-PL-3]</errordetails>
                  </AVGFault:AVGFault>
               </details>
            </Cai3gFault:Cai3gFault>
         </detail>
      </ns2:Fault>
   </S:Body>
</S:Envelope>

Reference List