Layered EIR Provisioning over CAI3G
Ericsson Dynamic Activation 1

Contents

1Introduction
1.1Purpose and Scope
1.2Target Group
1.3Typographic Conventions
1.4Prerequisites
1.5Namespaces
1.6Legends
1.7Operations
1.8Web Service Interface
1.9MOType
1.10MOId

2
Create Equipment
2.1Request Data
2.2Examples

3
Get Equipment
3.1Request Data
3.2Response Data
3.3Examples

4
Set Equipment
4.1Request Data
4.2Examples

5
Delete Equipment
5.1Request Data
5.2Examples

6
Create Equipments
6.1Request Data
6.2Examples

7
Delete Equipments
7.1Request Data
7.2Examples

8
Create Cloned Handset User
8.1Request Data
8.2Examples

9
Get Cloned Handset User
9.1Request Data
9.2Response Data
9.3Examples

10
Set Cloned Handset User
10.1Request Data
10.2Examples

11
Delete Cloned Handset User
11.1Request Data
11.2Examples

12
Create Mobile Station
12.1Request Data
12.2Examples

13
Get Mobile Station
13.1Request Data
13.2Response Data
13.3Examples

14
Delete Mobile Station
14.1Request Data
14.2Examples

15
Create Search Order
15.1Request Data
15.2Examples

16
Get Search Order
16.1Request Data
16.2Response Data
16.3Examples

17
Set Search Order
17.1Request Data
17.2Examples

18
Delete Search Order
18.1Request Data
18.2Examples

19
Get Equipment Status
19.1Request Data
19.2Response Data
19.3Examples

20
Create Fixed SIM
20.1Request Data
20.2Examples

21
Get Fixed SIM
21.1Request Data
21.2Response Data
21.3Examples

22
Delete Fixed SIM
22.1Request Data
22.2Examples

23
Faults and Errors
23.1Subordinate EIR Error Codes

Reference List

1   Introduction

This document describes the interface exposed by Ericsson™ Dynamic Activation (EDA) for provisioning of EIR data. The interface exposes a number of Customers Service Orders (CSOs) that enables management of equipment, equipment status, and search orders EIR-related data stored in a Consolidated User Data Base (CUDB).

The exposed interface can be used by a Customer Administration System (CAS) or any other provisioning system.

1.1   Purpose and Scope

This document describes the supported Customers Service Orders (CSOs) in the CAI3G interface which is used for provisioning of EIR data.

CAI3G is an Ericsson propriety interface which enables provisioning of user and subscriber data in telecommunication and IT networks. It is a web service interface based on Simple Object Access Protocol (SOAP) 1.1. This document is not a tutorial of CAI3G, the document must be read together with the Generic CAI3G specification, which is described in Generic CAI3G Interface 1.2, Reference [2]

1.2   Target Group

The target groups for this document are as follows:

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

1.3   Typographic Conventions

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

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

C Create
S Set
G Get
D Delete

1.4   Prerequisites

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

1.5   Namespaces

The following namespaces are referred to in this document:

1.6   Legends

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

Table 1    Legends Used in XML Schema Figures in This Specification

Legend

Description

XML attribute

Optional XML element

Choice icon

Mandatory XML element

Structured element

Subobject element


The occurrence of this element is 0–15.

User-defined type


This is not a standard XML schema type. It is introduced to describe MO schema structure more clearly. In practice, this type is to be replaced by the corresponding elements.

Sequence icon


A list of elements, the sequence order must be followed.

msisdn *

The “*” after msisdn indicates the element, such as msisdn here, can be used as an MOId.

1.7   Operations

See the following table for the operations, or Managed Objects (MOs), and valid operations covered in this document.

Table 2    EIR-FE Data Provisioning CSOs

MO

Operations

Create

Get

Set

Delete

Equipment

x

x

x

x

Equipment

x

    

x

Cloned Handset User

x

x

x

x

Mobile Station

x

x

  

x

SearchOrders

x

x

x

x

EquipmentStatus

  

x

    

FixedSim

x

x

  

x

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/ma/. 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, Dynamic_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:

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

This section covers the EIR-FE Equipment command CreateEquipment.

MOType

Equipment@http://schemas.ericsson.com/ma/EIR/

2.1   Request Data

2.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported.

Table 3    Create Equipment MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

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

Figure 1   Parameters in Create Equipment

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 4    Create Equipment MO Attributes

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

date

Date Format is yyyy-mm-dd.

Optional

This attribute contains the date when the equipment is created.

time

Time Format is hh:mm:ss.

Optional

This attribute contains the time when the equipment is created.

comment

String


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

InsertEquipmentListType

 

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains the list number for which the equipment is to be defined.

insertReason

String


Enumeration value="10"


Enumeration value="11"


Enumeration value="16"


Enumeration value="23"


Enumeration value="25"

Optional

This attribute contains the reason for creating the equipment(1)


10 = Faulty or broken
11 = Stolen or lost
16 = Duplicated IMEI. The IMEI has been copied to several different mobiles.
23 = Third-party request to add in grey/black list (for example, law enforcement).
25 = Unspecified - migrated from CEIR. Only valid for migration.

clarifyReason

String


maxLength value="20"

Optional

This attribute contains an explanatory text stating the reason for creating the equipment.

sourceOfRequest

String


maxLength value="25"

Optional

This attribute contains the name of a third party that initiated the creation of the equipment.

(1)  Default value is 11


2.2   Examples

Request Example

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

Example 2   Create Equipment Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Create>
      <cai3:MOType>Equipment@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imei>55555987654321</eir:imei>
        <eir:svn>16</eir:svn>
      </cai3:MOId>
      <cai3:MOAttributes>
        <eir:CreateEquipment imei="55555987654321" svn="16">
          <eir:imei>55555987654321</eir:imei>
          <eir:svn>16</eir:svn>
          <eir:date>2011-01-19</eir:date>
          <eir:time>13:50:00</eir:time>
          <eir:comment>A comment</eir:comment>
          <eir:InsertEquipmentListType>
          <eir:equipmentListNumber>2</eir:equipmentListNumber>
          <eir:insertReason>23</eir:insertReason>
          </eir:InsertEquipmentListType>
          <eir:clarifyReason>A clarify reason</eir:clarifyReason>
          <eir:sourceOfRequest>A source of request
        </eir:sourceOfRequest>
         </eir:CreateEquipment>
       </cai3:MOAttributes>
    </cai3:Create>
  </soapenv:Body>
</soapenv:Envelope>

Create an EIR Equipment active in list l2.

Response Example

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

Example 3   Create Equipment Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
   <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:CreateResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imei xmlns:eir="http://schemas.ericsson.com/ma/EIR/">55555987654321</eir:imei>
    <eir:svn xmlns:eir="http://schemas.ericsson.com/ma/EIR/">16</eir:svn>
    </ns2:MOId>
  </ns2:CreateResponse>
 </S:Body>
</S:Envelope>

3   Get Equipment

This section covers the EIR-FE Equipment command GetEquipment.

MOType

Equipment@http://schemas.ericsson.com/ma/EIR/

3.1   Request Data

3.1.1   Parameters

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 5    Get Equipment MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

3.2   Response Data

3.2.1   Parameters

MOId

N/A

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

Figure 2   Parameters in Get Response Equipment

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 6    Get Response Equipment MO Attributes

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


SVN value 99 is reserved for future use.

date

Date Format is yyyy-mm-dd.

Optional

This attribute contains the date when the equipment is created.

time

Time Format is hh:mm:ss.

Optional

This attribute contains the time when the equipment is created.

comment

string


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Optional

This attribute contains the lists for which the equipment is defined. One equipment can be included in up to 10 lists.

3.3   Examples

Request Example

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

Example 4   Get Equipment Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Get>
      <cai3:MOType>Equipment@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imei>55555987654321</eir:imei>
        <eir:svn>16</eir:svn>
      </cai3:MOId>
    </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Get EIR Equipment data with IMEI number 55555987654321.

Response Example

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

Example 5   Get Equipment Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:GetResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOAttributes>
    <ns:GetResponseEquipment imei="55555987654321"
     svn="16" xmlns:ns="http://schemas.ericsson.com/ma/EIR/">
     <ns:imei>55555987654321</ns:imei>
     <ns:svn>16</ns:svn>
     <ns:date>2011-01-19</ns:date>
     <ns:time>13:50:00</ns:time>
     <ns:comment>A comment</ns:comment>
     <ns:EquipmentListType>
      <ns:equipmentListNumber>2</ns:equipmentListNumber>
     </ns:EquipmentListType>
    </ns:GetResponseEquipment>
   </ns2:MOAttributes>
  </ns2:GetResponse>
 </S:Body>
</S:Envelope>

4   Set Equipment

This section covers the EIR-FE Equipment command SetEquipment.

MOType

Equipment@http://schemas.ericsson.com/ma/EIR/

4.1   Request Data

4.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported.

Table 7    Set Equipment MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

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

Figure 3   Parameters in Set Equipment

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

Table 8    Set Equipment MO Attributes

Parameter

Type

Occurrence

Description

date

Date Format is yyyy-mm-dd.

Optional

This attribute contains the date when the equipment is created.

time

Time Format is hh:mm:ss.

Optional

This attribute contains the time when the equipment is created.

comment

String


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

InsertEquipmentListType(1)

 

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains the list number for which the equipment is to be defined.

insertReason

String


Enumeration value="10"


Enumeration value="11"


Enumeration value="16"


Enumeration value="23"


Enumeration value="25"

Optional

This attribute contains the reason for creating the equipment(2)


10 = Faulty or broken
11 = Stolen or lost
16 = Duplicated IMEI. The IMEI has been copied to several different mobiles.
23 = Third-party request to add in grey/black list (for example, law enforcement).
25 = Unspecified - migrated from CEIR. Only valid for migration.

RemoveEquipmentListType (1)

 

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains the list number for which the equipment is to be defined.

removeReason

String


Enumeration value="14"


Enumeration value="18"


Enumeration value="20"


Enumeration value="22"


Enumeration value="24"

Optional

This attribute contains the reason for creating the equipment(3)


14 = Found
18 = Repaired
20= Unique IMEI. IMEI not duplicated any more.
22 = Aged IMEI. Is no longer on grey/black list because of the passage of time.
24 = Third-party request to remove from grey/black list.

clarifyReason

String


maxLength value="20"

Optional

This attribute contains an explanatory text stating the reason for creating the equipment.

sourceOfRequest

String


maxLength value="25"

Optional

This attribute contains the name of a third party that initiated the creation of the equipment.

(1)  Only one can be selected

(2)  Default value is 11

(3)  Default value is 14


4.2   Examples

Request Example

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

Example 6   Set Equipment Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Set>
      <cai3:MOType>Equipment@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imei>55555987654321</eir:imei>
        <eir:svn>16</eir:svn>
      </cai3:MOId>
      <cai3:MOAttributes>
        <eir:SetEquipment imei="55555987654321" svn="16">
          <eir:date>2011-02-12</eir:date>
          <eir:time>11:40:00</eir:time>
          <eir:comment>Set comment</eir:comment>
          <eir:InsertEquipmentListType>
            <eir:equipmentListNumber>9</eir:equipmentListNumber>
            <eir:insertReason>23</eir:insertReason>
          </eir:InsertEquipmentListType>
          <eir:clarifyReason>Set reason</eir:clarifyReason>
          <eir:sourceOfRequest>Set source</eir:sourceOfRequest>
        </eir:SetEquipment>
      </cai3:MOAttributes>
    </cai3:Set>
  </soapenv:Body>
</soapenv:Envelope>

Set and create EIR Equipment active in list l9.

Note:  
The attributes date, time, and comment are updated if they are included in the request.

Response Example

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

Example 7   Set Equipment Response Message

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

5   Delete Equipment

This section covers the EIR-FE Equipment command DeleteEquipment.

MOType

Equipment@http://schemas.ericsson.com/ma/EIR/

5.1   Request Data

5.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported.

Table 9    Delete Equipment MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

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

Figure 4   Parameters in Delete Equipment

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

Table 10    Delete Equipment MO Attributes

Parameter

Type

Occurrence

Description

comment

String


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

removeReason

String


Enumeration value="14"


Enumeration value="18"


Enumeration value="20"


Enumeration value="22"


Enumeration value="24"

Optional

This attribute contains the reason for creating the equipment(1)


14 = Found
18 = Repaired
20= Unique IMEI. IMEI not duplicated any more.
22 = Aged IMEI. Is no longer on grey/black list because of the passage of time.
24 = Third-party request to remove from grey/black list.

clarifyReason

String


maxLength value="20"

Optional

This attribute contains an explanatory text stating the reason for creating the equipment.

sourceOfRequest

String


maxLength value="25"

Optional

This attribute contains the name of a third party that initiated the creation of the equipment.

(1)  Default value is 14


5.2   Examples

Request Example

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

Example 8   Delete Equipment Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Delete>
      <cai3:MOType>Equipment@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imei>55555987654321</eir:imei>
        <eir:svn>16</eir:svn>
      </cai3:MOId>
    </cai3:Delete>
  </soapenv:Body>
</soapenv:Envelope>

Remove EIR Equipment with IMEI number 55555987654321.

Response Example

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

Example 9   Delete Equipment Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:DeleteResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imei xmlns:eir="http://schemas.ericsson.com/ma/EIR/">55555987654321
    </eir:imei>
    <eir:svn xmlns:eir="http://schemas.ericsson.com/ma/EIR/">16</eir:svn>
   </ns2:MOId>
  </ns2:DeleteResponse>
 </S:Body>
</S:Envelope>

6   Create Equipments

This section covers the EIR-FE Equipment command CreateEquipments.

The CreateEquipments create one or more equipments in the CUDB. Maximum ten equipments can be created.

MOType

Equipments@http://schemas.ericsson.com/ma/EIR/

6.1   Request Data

6.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported, imeiFrom, or imeiTo.

Table 11    Create Equipments MO Id

Parameter

Type

Occurrence

Description

imeiFrom

String


Pattern value="[0-9]*"


minLength value=14


maxLength value=14

Mandatory

This attribute contains the IMEI associated with the first equipment.

imeiTo

String


Pattern value="[0-9]*"


minLength value=14


maxLength value=14

Mandatory

This attribute contains the IMEI associated with the last equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

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

Figure 5   Parameters in Create Equipments

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

Note:  
The Check Digit in the IMEI value is not supported, imeiFrom, or imeiTo.

Table 12    Create Equipments MO Attributes

Parameter

Type

Occurrence

Description

imeiFrom

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the first equipment.

imeiTo

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the last equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

date

Date Format is yyyy-mm-dd.

Optional

This attribute contains the date when the equipment is created.

time

Time Format is hh:mm:ss.

Optional

This attribute contains the time when the equipment is created.

comment

String


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

InsertEquipmentListType

 

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains the list number for which the equipment is to be defined.

insertReason

String


Enumeration value="10"


Enumeration value="11"


Enumeration value="16"


Enumeration value="23"


Enumeration value="25"

Optional

This attribute contains the reason for creating the equipment(1)


10 = Faulty or broken
11 = Stolen or lost
16 = Duplicated IMEI. The IMEI has been copied to several different mobiles.
23 = Third-party request to add in grey/black list (for example, law enforcement).
25 = Unspecified - migrated from CEIR. Only valid for migration.

clarifyReason

String


maxLength value="20"

Optional

This attribute contains an explanatory text stating the reason for creating the equipment.

sourceOfRequest

String


maxLength value="25"

Optional

This attribute contains the name of a third party that initiated the creation of the equipment.

(1)  Default value is 11


6.2   Examples

Request Example

This section gives an example of a CreateEquipments request message, as shown in Example 10.

Example 10   Create Equipments Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Create>
      <cai3:MOType>Equipments@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imeiFrom>10000000000100</eir:imeiFrom>
        <eir:imeiTo>10000000000109</eir:imeiTo>
        <eir:svn>55</eir:svn>
     </cai3:MOId>
     <cai3:MOAttributes>
       <eir:CreateEquipments
          imeiFrom="10000000000100" imeiTo="10000000000109" svn="55">
          <eir:imeiFrom>10000000000100</eir:imeiFrom>
          <eir:imeiTo>10000000000109</eir:imeiTo>
          <eir:svn>55</eir:svn>
          <eir:InsertEquipmentListType>
            <eir:equipmentListNumber>2</eir:equipmentListNumber>
          </eir:InsertEquipmentListType>
        </eir:CreateEquipments>
      </cai3:MOAttributes>
    </cai3:Create>
  </soapenv:Body>
</soapenv:Envelope>

Create ten EIR Equipments active in list l2.

Response Example

This section gives an example of a CreateEquipments response message, as shown in Example 11.

Example 11   Create Equipments Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:CreateResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imeiFrom xmlns:eir="http://schemas.ericsson.com/ma/EIR/">10000000000100
    </eir:imeiFrom>
    <eir:imeiTo xmlns:eir="http://schemas.ericsson.com/ma/EIR/">10000000000109
    </eir:imeiTo>
    <eir:svn xmlns:eir="http://schemas.ericsson.com/ma/EIR/">55</eir:svn>
   </ns2:MOId>
  </ns2:CreateResponse>
 </S:Body>
</S:Envelope>

7   Delete Equipments

This section covers the EIR-FE Equipment command DeleteEquipments.

The DeleteEquipments deletes one or more equipments in the CUDB. Maximum ten equipments can be deleted.

MOType

Equipments@http://schemas.ericsson.com/ma/EIR/

7.1   Request Data

7.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported, imeiFrom, or imeiTo.

Table 13    Delete Equipments MO Id

Parameter

Type

Occurrence

Description

imeiFrom

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the first equipment.

imeiTo

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the last equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

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

Figure 6   Parameters in Delete Equipments

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

Table 14    Delete Equipments MO Attributes

Parameter

Type

Occurrence

Description

comment

String


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

removeReason

String


Enumeration value = "14"


Enumeration value = "18"


Enumeration value = "20"


Enumeration value = "22"


Enumeration value = "24"

Optional

This attribute contains the reason for removing the equipment. (1)


14 = Found
18 = Repaired
20= Unique IMEI. IMEI not duplicated any more.
22 = Aged IMEI. Is no longer on grey/black list because of the passage of time.
24 = Third-party request to remove from grey/black list.

clarifyReason

String


maxLength value="20"

Optional

This attribute contains an explanatory text stating the reason for deleting the equipment.

sourceOfRequest

String


maxLength value="25"

Optional

This attribute contains the name of a third party that initiated the deletion of the equipment.

(1)  Default value is 14


7.2   Examples

Request Example

This section gives an example of a DeleteEquipments request message, as shown in Example 12.

Example 12   Delete Equipments Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>sessionid_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Delete>
      <cai3:MOType>Equipments@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
        <cai3:MOId>
          <eir:imeiFrom>10000000000105</eir:imeiFrom>
          <eir:imeiTo>10000000000109</eir:imeiTo>
          <eir:svn>55</eir:svn>
        </cai3:MOId>
        <cai3:MOAttributes>
        <eir:DeleteEquipments 
           imeiFrom="10000000000105" imeiTo="10000000000109" svn="55">
           <eir:comment>Delete comment</eir:comment>
           <eir:removeReason>22</eir:removeReason>
           <eir:clarifyReason>Delete reason</eir:clarifyReason>
           <eir:sourceOfRequest>Delete source</eir:sourceOfRequest>
        </eir:DeleteEquipments>
      </cai3:MOAttributes>
    </cai3:Delete>
  </soapenv:Body>
</soapenv:Envelope>

Remove five EIR Equipments.

Response Example

This section gives an example of a DeleteEquipments response message, as shown in Example 13.

Example 13   Delete Equipments Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>sessionid_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:DeleteResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imeiFrom xmlns:eir="http://schemas.ericsson.com/ma/EIR/">10000000000105
    </eir:imeiFrom>
    <eir:imeiTo xmlns:eir="http://schemas.ericsson.com/ma/EIR/">10000000000109
    </eir:imeiTo>
    <eir:svn xmlns:eir="http://schemas.ericsson.com/ma/EIR/">55
    </eir:svn>
   </ns2:MOId>
  </ns2:DeleteResponse>
 </S:Body>
</S:Envelope>

8   Create Cloned Handset User

This section covers the EIR-FE Cloned Handset User command CreateClonedHandsetUser.

MOType

ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/

8.1   Request Data

8.1.1   Parameters

MOId

Table 15    Create Cloned Handset User MO Id

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment.

MOAttributes

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

Figure 7   Parameters in Create Cloned Handset User

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 16    Create Cloned Handset User MO Attributes

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment.

ClonedImei

Sub MO

Mandatory

Maximum five cloned IMEIs can be defined

 

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

8.2   Examples

Request Example

This section gives an example of a CreateClonedHandsetUser request message, as shown in Example 14.

Example 14   Create Cloned Handset User Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Create>
      <cai3:MOType>ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imsi>1538567</eir:imsi>
      </cai3:MOId>
     <cai3:MOAttributes>
       <eir:CreateClonedHandsetUser imsi="1538567">
           <eir:imsi>1538567</eir:imsi>
           <eir:ClonedImei imei="12345678915843">
             <eir:imei>12345678915843</eir:imei>
             <eir:svn>66</eir:svn>
           </eir:ClonedImei>
           <eir:ClonedImei imei="12345678915844">
            <eir:imei>12345678915844</eir:imei>
            <eir:svn>67</eir:svn>
          </eir:ClonedImei>
          <eir:ClonedImei imei="12345678915845">
            <eir:imei>12345678915845</eir:imei>
            <eir:svn>68</eir:svn>
          </eir:ClonedImei>
        </eir:CreateClonedHandsetUser>
      </cai3:MOAttributes>
    </cai3:Create>
  </soapenv:Body>
</soapenv:Envelope>

Create an EIR ClonedHandsetUser with three ClonedImei.

Response Example

This section gives an example of a CreateClonedHandsetUser response message, as shown in Example 15.

Example 15   Create Cloned Handset User Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:CreateResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imsi xmlns:eir="http://schemas.ericsson.com/ma/EIR/">1538567
    </eir:imsi>
   </ns2:MOId>
  </ns2:CreateResponse>
 </S:Body>
</S:Envelope>

9   Get Cloned Handset User

This section covers the EIR-FE Cloned Handset User command GetClonedHandsetUser.

MOType

ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/

9.1   Request Data

9.1.1   Parameters

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

Table 17    Get Cloned Handset User MO Id

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment.

9.2   Response Data

9.2.1   Parameters

MOId

N/A

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

Figure 8   Parameters in Get Response Cloned Handset User

The following table covers the parameters that are received in a GetClonedHandsetUser response.

Note:  
The Check Digit in the IMEI value is not supported.

Table 18    Get Response Cloned Handset User MO Attributes

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment.

ClonedImei

Sub MO

Mandatory

Maximum five cloned IMEIs can be defined

 

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


SVN value 99 is reserved for future use.

9.3   Examples

Request Example

This section gives an example of a GetClonedHandsetUser request message, as shown in Example 16.

Example 16   Get Cloned Handset User Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Get>
      <cai3:MOType>ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/
       </cai3:MOType>
       <cai3:MOId>
        <eir:imsi>1538567</eir:imsi>
      </cai3:MOId>
    </cai3:Get>
  </soapenv:Body>
</soapenv:Envelope>

Get the EIR ClonedHandsetUser data with IMSI number 1538567.

Response Example

This section gives an example of a GetClonedHandsetUser response message, as shown in Example 17.

Example 17   Get Cloned Handset User Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:GetResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOAttributes>
    <ns:GetResponseClonedHandsetUser
     imsi="1538567" xmlns:ns="http://schemas.ericsson.com/ma/EIR/">
     <ns:imsi>1538567</ns:imsi>
     <ns:ClonedImei imei="12345678915843">
      <ns:imei>12345678915843</ns:imei>
      <ns:svn>66</ns:svn>
     </ns:ClonedImei>
     <ns:ClonedImei imei="12345678915844">
      <ns:imei>12345678915844</ns:imei>
      <ns:svn>67</ns:svn>
     </ns:ClonedImei>
     <ns:ClonedImei imei="12345678915845">
      <ns:imei>12345678915845</ns:imei>
      <ns:svn>68</ns:svn>
     </ns:ClonedImei>
    </ns:GetResponseClonedHandsetUser>
   </ns2:MOAttributes>
  </ns2:GetResponse>
 </S:Body>
</S:Envelope>

10   Set Cloned Handset User

This section covers the EIR-FE Cloned Handset User command SetClonedHandsetUser.

MOType

ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/

10.1   Request Data

10.1.1   Parameters

MOId

Table 19    Set Cloned Handset User MO Id

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment.

MOAttributes

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

Figure 9   Parameters in Set Cloned Handset User

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 20    Set Cloned Handset User MO Attributes

Parameter

Type

Occurrence

Description

ClonedImei

Sub MO [nillable]

Mandatory

Maximum five cloned IMEIs can be defined

 

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

10.2   Examples

Request Example

This section gives an example of a SetClonedHandsetUser request message, as shown in Example 18.

Example 18   Set Cloned Handset User Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Set>
      <cai3:MOType>ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imsi>1538567</eir:imsi>
      </cai3:MOId>
      <cai3:MOAttributes>
        <eir:SetClonedHandsetUser imsi="1538567">
          <eir:ClonedImei imei="12345678915846">
            <eir:imei>12345678915846</eir:imei>
            <eir:svn>69</eir:svn>
          </eir:ClonedImei>
        </eir:SetClonedHandsetUser>
      </cai3:MOAttributes>
    </cai3:Set>
  </soapenv:Body>
</soapenv:Envelope>

Set and create EIR ClonedHandsetUser with additional one ClonedImei.

Response Example

This section gives an example of a SetClonedHandsetUser response message, as shown in Example 19.

Example 19   Set Cloned Handset User Response Message

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

11   Delete Cloned Handset User

This section covers the EIR-FE Cloned Handset User command DeleteClonedHandsetUser.

MOType

ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/

11.1   Request Data

11.1.1   Parameters

MOId

Table 21    Delete Cloned Handset User MO Id

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment.

MOAttributes

N/A

11.2   Examples

Request Example

This section gives an example of a DeleteClonedHandsetUser request message, as shown in Example 20.

Example 20   Delete Cloned Handset User Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Delete>
      <cai3:MOType>ClonedHandsetUser@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imsi>1538567</eir:imsi>
      </cai3:MOId>
    </cai3:Delete>
  </soapenv:Body>
</soapenv:Envelope>

Delete EIR ClonedHandsetUser with IMSI number 1538567.

Response Example

This section gives an example of a DeleteClonedHandsetUser response message, as shown in Example 21.

Example 21   Delete Cloned Handset User Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:DeleteResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imsi xmlns:eir="http://schemas.ericsson.com/ma/EIR/">1538567
    </eir:imsi>
   </ns2:MOId>
  </ns2:DeleteResponse>
 </S:Body>
</S:Envelope>

12   Create Mobile Station

This section covers the EIR-FE Mobile Station command CreateMobileStation.

MOType

MobileStation@http://schemas.ericsson.com/ma/EIR/

12.1   Request Data

12.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported.

Table 22    Create Mobile Station MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

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

Figure 10   Parameters in Create Mobile Station

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 23    Create Mobile Station MO Attributes

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

lockedImsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI that is locked to the equipment.

12.2   Examples

Request Example

This section gives an example of a CreateMobileStation request message, as shown in Example 22.

Example 22   Create Mobile Station Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Create>
      <cai3:MOType>MobileStation@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imei>12333333333333</eir:imei>
      </cai3:MOId>
      <cai3:MOAttributes>
        <eir:CreateMobileStation imei="12333333333333">
          <eir:imei>12333333333333</eir:imei>
          <eir:lockedImsi>111111111</eir:lockedImsi>
        </eir:CreateMobileStation>
      </cai3:MOAttributes>
    </cai3:Create>
  </soapenv:Body>
</soapenv:Envelope>

Create an EIR MobileStation with IMEI number 12333333333333 and lockedImsi 111111111.

Response Example

This section gives an example of a CreateMobileStation response message, as shown in Example 23.

Example 23   Create Mobile Station Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:CreateResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imei xmlns:eir="http://schemas.ericsson.com/ma/EIR/">12333333333333
    </eir:imei>
   </ns2:MOId>
  </ns2:CreateResponse>
 </S:Body>
</S:Envelope>

13   Get Mobile Station

This section covers the EIR-FE Mobile Station command GetMobileStation.

MOType

MobileStation@http://schemas.ericsson.com/ma/EIR/

13.1   Request Data

13.1.1   Parameters

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 24    Get Mobile Station MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

13.2   Response Data

13.2.1   Parameters

MOId

N/A

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

Figure 11   Parameters in Get Response Mobile Station

The following table covers the parameters that are received in a GetMobileStation response.

Note:  
The Check Digit in the IMEI value is not supported.

Table 25    Get Response Mobile Station MO Attributes

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


SVN value 99 is reserved for future use.

lockedImsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI that is locked to the equipment.

13.3   Examples

Request Example

This section gives an example of a GetMobileStation request message, as shown in Example 24.

Example 24   Get Mobile Station Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
  <cai3:Get>
    <cai3:MOType>MobileStation@http://schemas.ericsson.com/ma/EIR/
    </cai3:MOType>
    <cai3:MOId>
      <eir:imei>12333333333333</eir:imei>
    </cai3:MOId>
  </cai3:Get>
  </soapenv:Body>
</soapenv:Envelope>

Get EIR MobileStation data with IMEI number 12333333333333

Response Example

This section gives an example of a GetMobileStation response message, as shown in Example 25.

Example 25   Get Mobile Station Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:GetResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOAttributes>
    <ns:GetResponseMobileStation imei="12333333333333"
     xmlns:ns="http://schemas.ericsson.com/ma/EIR/">
     <ns:imei>12333333333333</ns:imei>
     <ns:lockedImsi>111111111</ns:lockedImsi>
    </ns:GetResponseMobileStation>
   </ns2:MOAttributes>
  </ns2:GetResponse>
 </S:Body>
</S:Envelope>

14   Delete Mobile Station

This section covers the EIR-FE Mobile Station command DeleteMobileStation.

MOType

MobileStation@http://schemas.ericsson.com/ma/EIR/

14.1   Request Data

14.1.1   Parameters

MOId

Note:  
The Check Digit in the IMEI value is not supported.

Table 26    Delete Mobile Station MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

MOAttributes

N/A

14.2   Examples

Request Example

This section gives an example of a DeleteMobileStation request message, as shown in Example 26.

Example 26   Delete Mobile Station Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
   <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
   <cai3:Delete>
     <cai3:MOType>MobileStation@http://schemas.ericsson.com/ma/EIR/
     </cai3:MOType>
     <cai3:MOId>
       <eir:imei>12333333333333</eir:imei>
     </cai3:MOId>
   </cai3:Delete>
 </soapenv:Body>
</soapenv:Envelope>

Delete EIR MobileStation with IMEI number 12333333333333

Response Example

This section gives an example of a DeleteMobileStation response message, as shown in Example 27.

Example 27   Delete Mobile Station Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:DeleteResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imei xmlns:eir="http://schemas.ericsson.com/ma/EIR/">12333333333333 
    </eir:imei>
   </ns2:MOId>
  </ns2:DeleteResponse>
 </S:Body>
</S:Envelope>

15   Create Search Order

This section covers the EIR-FE Search Order command CreateSearchOrder.

MOType

SearchOrder@http://schemas.ericsson.com/ma/EIR/

15.1   Request Data

15.1.1   Parameters

MOId

Table 27    Create Search Order MO Id

Parameter

Type

Occurrence

Description

imsiPrefix

String


Pattern value=”[0-9]*|Default”


minLength value="2"


maxLength value="15"

Mandatory

This attribute contains the IMSI of the equipment being searched for.(1)

(1)  A default search order must be present and cannot be created.


MOAttributes

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

Figure 12   Parameters in Create Search Order

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

Table 28    Create Search Order MO Attributes

Parameter

Type

Occurrence

Description

imsiPrefix

String


Pattern value=”[0-9]*|Default”


minLength value="2"


maxLength value="15"

Mandatory

This attribute contains the IMSI of the equipment being searched for.

unknownResponse

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is not found in any of the lists.

SearchOrderListEntry

Sub MO

Optional

Maximum five list entries can be defined

 

searchOrderListNumber

Integer


minInclusive value="1"


maxInclusive value="5"

Mandatory

This attribute contains the identifier of a list entry.

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains a reference to an equipment list to search.(1)

response

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is found in the list identified by equipmentListNumber.

(1)  See Equipment MO for details related to equipment lists.


15.2   Examples

Request Example

This section gives an example of a CreateSearchOrder request message, as shown in Example 28.

Example 28   Create Search Order Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
   <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
   <cai3:Create>
     <cai3:MOType>SearchOrder@http://schemas.ericsson.com/ma/EIR/
     </cai3:MOType>
     <cai3:MOId>
       <eir:imsiPrefix>123456789</eir:imsiPrefix>
     </cai3:MOId>
     <cai3:MOAttributes>
       <eir:CreateSearchOrder imsiPrefix="123456789">
         <eir:imsiPrefix>123456789</eir:imsiPrefix>
         <eir:unknownResponse>White</eir:unknownResponse>
         <eir:SearchOrderListEntry searchOrderListNumber="1">
           <eir:searchOrderListNumber>1</eir:searchOrderListNumber>
           <eir:equipmentListNumber>3</eir:equipmentListNumber>
           <eir:response>Grey</eir:response>
         </eir:SearchOrderListEntry>
         <eir:SearchOrderListEntry searchOrderListNumber="2">
           <eir:searchOrderListNumber>2</eir:searchOrderListNumber>
           <eir:equipmentListNumber>4</eir:equipmentListNumber>
           <eir:response>Black</eir:response>
         </eir:SearchOrderListEntry>
       </eir:CreateSearchOrder>
     </cai3:MOAttributes>
   </cai3:Create>
 </soapenv:Body>
</soapenv:Envelope>

Create an EIR SearchOrder with imsiPrefix 123456789, unknownResponse "White", SearchOrderListEntry(searchOrderListNumber 1, equipmentListNumber 3, response "Grey", searchOrderListNumber 2, equipmentListNumber 4, response "Black").

Response Example

This section gives an example of a CreateSearchOrder response message, as shown in Example 29.

Example 29   Create Search Order Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:CreateResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imsiPrefix xmlns:eir="http://schemas.ericsson.com/ma/EIR/">123456789
    </eir:imsiPrefix>
   </ns2:MOId>
  </ns2:CreateResponse>
 </S:Body>
</S:Envelope>

16   Get Search Order

This section covers the EIR-FE Equipment command GetSearchOrder.

MOType

SearchOrder@http://schemas.ericsson.com/ma/EIR/

16.1   Request Data

16.1.1   Parameters

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

Table 29    Get Search Order MO Id

Parameter

Type

Occurrence

Description

imsiPrefix

String


Pattern value=”[0-9]*|Default”


minLength value="2"


maxLength value="15"

Mandatory

This attribute contains the IMSI of the equipment being searched for.(1)

(1)  A default search order must be present and cannot be created.


16.2   Response Data

16.2.1   Parameters

MOId

N/A

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

Figure 13   Parameters in Get Response Search Order

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

Table 30    Get Response Search Order MO Attributes

Parameter

Type

Occurrence

Description

imsiPrefix

String


Pattern value=”[0-9]*|Default”


minLength value="2"


maxLength value="15"

Mandatory

This attribute contains the IMSI of the equipment being searched for.

unknownResponse

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is not found in any of the lists.

SearchOrderListEntry

Sub MO

Optional

Maximum five list entries can be defined

 

searchOrderListNumber

Integer


minInclusive value="1"


maxInclusive value="5"

Mandatory

This attribute contains the identifier of a list entry.

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains a reference to an equipment list to search.(1)

response

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is found in the list identified by equipmentListNumber.

(1)  See Equipment MO for details related to equipment lists.


16.3   Examples

Request Example

This section gives an example of a GetSearchOrder request message, as shown in Example 30.

Example 30   Get Search Order Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
    <cai3:Get>
       <cai3:MOType>SearchOrder@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType> 
       <cai3:MOId>
          <eir:imsiPrefix>Default</eir:imsiPrefix>
       </cai3:MOId>
    </cai3:Get>
 </soapenv:Body>
</soapenv:Envelope>

Get EIR default SearchOrder data.

Note:  
Default searchorder must exist in CUDB when installed with EIR-FE. Dynamic Activation cannot create this default searchorder.

Response Example

This section gives an example of a GetSearchOrder response message, as shown in Example 31.

Example 31   Get Search Order Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:GetResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOAttributes>
    <ns:GetResponseSearchOrder imsiPrefix="123456789"
     xmlns:ns="http://schemas.ericsson.com/ma/EIR/">
     <ns:imsiPrefix>123456789</ns:imsiPrefix>
     <ns:unknownResponse>White</ns:unknownResponse>
     <ns:SearchOrderListEntry
      searchOrderListNumber="1">
      <ns:searchOrderListNumber>1</ns:searchOrderListNumber>
      <ns:equipmentListNumber>3</ns:equipmentListNumber>
      <ns:response>Grey</ns:response>
     </ns:SearchOrderListEntry>
     <ns:SearchOrderListEntry
      searchOrderListNumber="2">
      <ns:searchOrderListNumber>2</ns:searchOrderListNumber>
      <ns:equipmentListNumber>4</ns:equipmentListNumber>
      <ns:response>Black</ns:response>
     </ns:SearchOrderListEntry>
    </ns:GetResponseSearchOrder>
   </ns2:MOAttributes>
  </ns2:GetResponse>
 </S:Body>
</S:Envelope>

17   Set Search Order

This section covers the EIR-FE Equipment command SetSearchOrder.

MOType

SearchOrder@http://schemas.ericsson.com/ma/EIR/

17.1   Request Data

17.1.1   Parameters

MOId

Table 31    Set Search Order MO Id

Parameter

Type

Occurrence

Description

imsiPrefix

String


Pattern value=”[0-9]*|Default”


minLength value="2"


maxLength value="15"

Mandatory

This attribute contains the IMSI of the equipment being searched for.(1)

(1)  A default search order must be present and cannot be created.


MOAttributes

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

Figure 14   Parameters in Set Search Order

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

Table 32    Set Search Order MO Attributes

Parameter

Type

Occurrence

Description

unknownResponse

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is not found in any of the lists.

SearchOrderListEntry

Sub MO [nillable]

Optional

Maximum five list entries can be defined

 

searchOrderListNumber

Integer


minInclusive value="1"


maxInclusive value="5"

Mandatory

This attribute contains the identifier of a list entry.

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Mandatory

This attribute contains a reference to an equipment list to search.(1)

response

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is found in the list identified by equipmentListNumber.

(1)  See Equipment MO for details related to equipment lists.


17.2   Examples

Request Example

This section gives an example of a SetSearchOrder request message, as shown in Example 32.

Example 32   Set Search Order Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:cai3=http://schemas.ericsson.com/cai3g1.2/ 
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
   <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
  <cai3:Set>
    <cai3:MOType>SearchOrder@http://schemas.ericsson.com/ma/EIR/
    </cai3:MOType>
    <cai3:MOId>
      <eir:imsiPrefix>123456789</eir:imsiPrefix>
    </cai3:MOId>
    <cai3:MOAttributes>
      <eir:SetSearchOrder imsiPrefix="123456789">
        <eir:unknownResponse>Unknown</eir:unknownResponse>
        <eir:SearchOrderListEntry 
          searchOrderListNumber="3">
          <eir:searchOrderListNumber>3</eir:searchOrderListNumber>
          <eir:equipmentListNumber>9</eir:equipmentListNumber>
          <eir:response>White</eir:response>
        </eir:SearchOrderListEntry>
      </eir:SetSearchOrder>
    </cai3:MOAttributes>
  </cai3:Set>
 </soapenv:Body>
</soapenv:Envelope>

Set and create EIR SearchOrder with imsiPrefix 123456789, unknownResponse "Unknown", SearchOrderListEntry(searchOrderListNumber 3, equipmentListNumber 9, response "White").

Note:  
The attribute unknownResponse is updated and attribute searchOrderListNumber 3 is added in the request.

Response Example

This section gives an example of a SetSearchOrder response message, as shown in Example 33.

Example 33   Set Search Order Response Message

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

18   Delete Search Order

This section covers the EIR-FE Equipment command DeleteSearchOrder.

MOType

SearchOrder@http://schemas.ericsson.com/ma/EIR/

18.1   Request Data

18.1.1   Parameters

MOId

Table 33    Delete Search Order MO Id

Parameter

Type

Occurrence

Description

imsiPrefix

String


Pattern value="[0-9]*|Default"


minLength value="2"


maxLength value="15"

Mandatory

This attribute contains the IMSI of the equipment being searched for.(1)

(1)  A default search order must be present and cannot be deleted.


MOAttributes

N/A

18.2   Examples

Request Example

This section gives an example of a DeleteSearchOrder request message, as shown in Example 34.

Example 34   Delete Search Order Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
   <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
   <cai3:Delete>
     <cai3:MOType>SearchOrder@http://schemas.ericsson.com/ma/EIR/
     </cai3:MOType>
     <cai3:MOId>
       <eir:imsiPrefix>123456789</eir:imsiPrefix>
     </cai3:MOId>
   </cai3:Delete>
 </soapenv:Body>
</soapenv:Envelope>

Delete EIR SearchOrder with imsiPrefix 123456789.

Response Example

This section gives an example of a DeleteSearchOrder response message, as shown in Example 35.

Example 35   Delete Search Order Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:DeleteResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imsiPrefix xmlns:eir="http://schemas.ericsson.com/ma/EIR/">123456789
    </eir:imsiPrefix>
   </ns2:MOId>
  </ns2:DeleteResponse>
 </S:Body>
</S:Envelope>

19   Get Equipment Status

This section covers the EIR-FE Equipment Status command GetEquipmentStatus.

MOType

EquipmentStatus@http://schemas.ericsson.com/ma/EIR/

19.1   Request Data

19.1.1   Parameters

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 34    Get Equipment Status MO Id

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Optional

This attribute contains the IMSI associated with the equipment.

19.2   Response Data

19.2.1   Parameters

MOId

N/A

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

Figure 15   Parameters in Get Equipment Status

The following table covers the parameters that are received in a GetEquipmentStatus response.

Note:  
The Check Digit in the IMEI value is not supported.

Table 35    Get Equipment Status MO Attributes

Parameter

Type

Occurrence

Description

imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


SVN value 99 is reserved for future use.

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Optional

This attribute contains the IMSI associated with the equipment.

status

String


Enumeration value="Black"


Enumeration value="Grey"


Enumeration value="White"


Enumeration value="Unknown"

Mandatory

This attribute contains the response returned if the IMEI being searched for is not found in any of the lists.

equipmentListNumber

Integer


minInclusive value="0"


maxInclusive value="9"

Optional

This attribute contains the lists for which the equipment is defined. One equipment can be included in up to 10 lists.

date

Date Format is yyyy-mm-dd.

Optional

This attribute contains the date when the equipment is created.

time

Time Format is hh:mm:ss.

Optional

This attribute contains the time when the equipment is created.

comment

String


minLength value="0"


maxLength value="255"

Optional

This attribute contains a comment related to why the equipment is created.

19.3   Examples

Request Example

This section gives an example of a GetEquipmentStatus request message, as shown in Example 36.

Example 36   Get Equipment Status Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
  xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
  <soapenv:Header>
    <cai3:SessionId>session_id</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Get>
      <cai3:MOType>EquipmentStatus@http://schemas.ericsson.com/ma/EIR/
      </cai3:MOType>
      <cai3:MOId>
        <eir:imei>12345688000009</eir:imei>
        <eir:svn>15</eir:svn>
        <eir:imsi>112158</eir:imsi>
      </cai3:MOId>
    </cai3:Get>
  </soapenv:Body>
</soapenv:Envelope>

Get EIR EquipmentStatus data with IMEI number 12345688000009.

Response Example

This section gives an example of a GetEquipmentStatus response message, as shown in Example 37.

Example 37   Get Equipment Status Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:GetResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOAttributes>
    <ns:GetResponseEquipmentStatus imei="12345688000009"
     svn="15" imsi="112158" xmlns:ns="http://schemas.ericsson.com/ma/EIR/">
     <ns:imei>12345688000009</ns:imei>
     <ns:svn>15</ns:svn>
     <ns:imsi>1121158</ns:imsi>
     <ns:status>Unknown</ns:status>
    </ns:GetResponseEquipmentStatus>
   </ns2:MOAttributes>
  </ns2:GetResponse>
 </S:Body>
</S:Envelope>

20   Create Fixed SIM

This section covers the EIR-FE Fixed SIM command CreateFixedSim.

MOType

FixedSim@http://schemas.ericsson.com/ma/EIR/

20.1   Request Data

20.1.1   Parameters

MOId

Table 36    Create Fixed SIM MO Id

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment that it is locked to.

MOAttributes

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

Figure 16   Parameters in Create Fixed SIM

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

Note:  
The Check Digit in the IMEI value is not supported.

Table 37    Create Fixed SIM MO Attributes

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment that the IMSI is locked to.

lockedImei

 

Imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment.

 

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment.


If this parameter is not included, Dynamic Activation uses an internal value of "0F" (not used on the CAI3G interface).


SVN value 99 is reserved for future use.

20.2   Examples

Request Example

This section gives an example of a CreateFixedSim request message, as shown in Example 38.

Example 38   Create Fixed SIM Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
  <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
  <cai3:Create>
   <cai3:MOType>FixedSim@http://schemas.ericsson.com/ma/EIR/</cai3:MOType>
   <cai3:MOId>
    <eir:imsi>123456789012345</eir:imsi>
   </cai3:MOId>
   <cai3:MOAttributes>
    <eir:CreateFixedSim imsi="123456789012345">
     <eir:imsi>123456789012345</eir:imsi>
     <eir:LockedImei>
      <eir:imei>11223344556677</eir:imei>
      <eir:svn>66</eir:svn>
     </eir:LockedImei>
    </eir:CreateFixedSim>
   </cai3:MOAttributes>
  </cai3:Create>
 </soapenv:Body>
</soapenv:Envelope>

Create an EIR Fixed SIM with IMSI 123456789012345, IMEI 112233445566778 and svn 66.

Response Example

This section gives an example of a CreateFixedSim response message, as shown in Example 39.

Example 39   Create Fixed SIM Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:CreateResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imsi xmlns:eir="http://schemas.ericsson.com/ma/EIR/">123456789012345
    </eir:imsi>
   </ns2:MOId>
   </ns2:CreateResponse>
 </S:Body>
</S:Envelope>

21   Get Fixed SIM

This section covers the EIR-FE Fixed SIM command GetFixedSim.

MOType

FixedSim@http://schemas.ericsson.com/ma/EIR/

21.1   Request Data

21.1.1   Parameters

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

Table 38    Get Fixed SIM MO Id

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment that it is locked to.

21.2   Response Data

21.2.1   Parameters

MOId

N/A

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

Figure 17   Parameters in Get Response Fixed SIM

The following table covers the parameters that are received in a GetFixedSim response.

Note:  
The Check Digit in the IMEI value is not supported.

Table 39    Get Fixed Response Fixed SIM MO Attributes

Parameter

Type

Occurrence

Description

imsi

String


Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment that it is locked to.

lockedImei

 

Imei

String


Pattern value="[0-9]*"


minLength value="14"


maxLength value="14"

Mandatory

This attribute contains the IMEI associated with the equipment that it is locked to.

 

svn

String


Pattern value=”[0-9]{2}"

Optional

This attribute contains the Software Version Number associated with the equipment that it is locked to.


SVN value 99 is reserved for future use.

21.3   Examples

Request Example

This section gives an example of a GetFixedSim request message, as show in Example 40.

Example 40   Get Fixed SIM Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
  <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
  <cai3:Get>
   <cai3:MOType>FixedSim@http://schemas.ericsson.com/ma/EIR/</cai3:MOType>
   <cai3:MOId>
    <eir:imsi>123456789012345</eir:imsi>
   </cai3:MOId>
  </cai3:Get>
 </soapenv:Body>
</soapenv:Envelope>

Get EIR Fixed SIM data with IMSI number 123456789012345.

Response Example

This section gives an example of a GetFixedSim response message, as show in Example 41.

Example 41   Get Fixed SIM Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:GetResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOAttributes>
    <ns:GetResponseFixedSim imsi="123456789012345"
     xmlns:ns="http://schemas.ericsson.com/ma/EIR/">
     <ns:imsi>123456789012345</ns:imsi>
     <ns:LockedImei>
      <ns:imei>11223344556677</ns:imei>
      <ns:svn>66</ns:svn>
     </ns:LockedImei>
    </ns:GetResponseFixedSim>
   </ns2:MOAttributes>
  </ns2:GetResponse>
 </S:Body>
</S:Envelope

22   Delete Fixed SIM

This section covers the EIR-FE Fixed SIM command DeleteFixedSim.

MOType

FixedSim@http://schemas.ericsson.com/ma/EIR/

22.1   Request Data

22.1.1   Parameters

MOId

Table 40    Delete Fixed SIM MO Id

Parameter

Type

Occurrence

Description

imsi

String Pattern value="[0-9]*"


minLength value="6"


maxLength value="15"

Mandatory

This attribute contains the IMSI associated with the equipment that it is locked to.

22.2   Examples

Request Example

This section gives an example of a DeleteFixedSim request message, as shown in Example 42.

Example 42   Delete Fixed SIM Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:eir="http://schemas.ericsson.com/ma/EIR/">
 <soapenv:Header>
  <cai3:SessionId>session_id</cai3:SessionId>
 </soapenv:Header>
 <soapenv:Body>
  <cai3:Delete>
   <cai3:MOType>FixedSim@http://schemas.ericsson.com/ma/EIR/</cai3:MOType>
   <cai3:MOId>
    <eir:imsi>123456789012345</eir:imsi>
   </cai3:MOId>
  </cai3:Delete>
 </soapenv:Body>
</soapenv:Envelope>

Delete EIR Fixed SIM with IMSI number 123456789012345.

Response Example

This section gives an example of a DeleteFixedSim response message, as shown in Example 43.

Example 43   Delete Fixed SIM Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
 <S:Header>
  <cai3g:SessionId>session_id</cai3g:SessionId>
 </S:Header>
 <S:Body>
  <ns2:DeleteResponse xmlns:ns2="http://schemas.ericsson.com/cai3g1.2/">
   <ns2:MOId>
    <eir:imsi xmlns:eir="http://schemas.ericsson.com/ma/EIR/">123456789012345
    </eir:imsi>
   </ns2:MOId>
  </ns2:DeleteResponse>
 </S:Body>
</S:Envelope

23   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 EIR specific error codes are described in this section. These error codes are included in the Fault type PGFault.

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

23.1   Subordinate EIR Error Codes

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

Table 41    Subordinate EIR Error Codes

Error Code

Error Message

Error Details

MO

Operation

15001

EQUIPMENT EXIST

Specified equipment (IMEI) exists

Equipment

C

Part or all equipment (IMEI) range exists

Equipments

C

15003

EQUIPMENT DOES NOT EXIST

Specified equipment (IMEI) does not exist

Equipment

G/S/D

EquipmentStatus

G

Part or all equipment (IMEI) range does not exist

Equipments

D

15005

IMSI EXIST

Specified IMSI exists

ClonedHandsetUser

C/G/D

FixedSim

C/G/D

15006

IMSI DOES NOT EXIST

Specified IMSI does not exist

ClonedHandsetUser

G/S/D

FixedSim

G/D

15007

IMSI PREFIX EXIST

Specified IMSI Prefix exists

SearchOrder

C

15008

IMSI PREFIX DOES NOT EXIST

Specified IMSI Prefix does not exist

SearchOrder

G/S/D

15009

MOBILE STATION DOES NOT EXIST

Mobile station with this IMEI (and SVN) does not exist

MobileStation

G/D

15010

LOCKED IMSI NOT DEFINED

Specified equipment (IMEI) does not have lockedIMSI defined

MobileStation

G

15015

NE UNAVAILABLE

CUDB unavailable – retry operation

Equipment

C/S/D

EquipmentStatus

G

MobileStation

C/D

ClonedHandsetUser

C/S/D

SearchOrder

C/S/D

FixedSim

C/D

CUDB unavailable – retry operation from <imei>

Equipment

C/D

15017

INCOMPLETE DATA

ImeilogData could not be completed, manual repair needed

Equipment

C/S/D

Equipment

C/D

15060

MAX NO OF RESPONSE ITEMS EXCEEDED

Number of items returned by request exceeded the configured max limit

EquipmentStatus

G

SearchOrder

G

15061

NUMBER OF ITEMS EXCEEDED

Not enough space to add new ClonedIMEIs

ClonedHandsetUser

S

15070

WRONG ARGUMENT

Start of range must be less than or equal to the end of range

Equipment

C/D

Max number of items (10) in range exceeded

Equipment

C/D

First 8 digits of imeiFrom and imeiTo must be the same

Equipment

C/D

23.1.1   CAI3G Error Message Example

The following, shown in Example 44, is an example of a CAI3G error message:

Example 44   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>9bba7a74f43942dd9ce89b6dd4b96d85</cai3g:SessionId>
   </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>
                  <PGFault:PGFault xmlns="http://schemas.ericsson.com/pg/1.0"
                   xmlns:PGFault="http://schemas.ericsson.com/pg/1.0">
                     <errorcode>15001</errorcode>
                     <errormessage>EQUIPMENT EXISTS</errormessage>
                     <errordetails>Specified equipment (IMEI) already exist - 
                      [Processed by PG Node: vmx1771]</errordetails>
                  </PGFault:PGFault>
               </details>
            </Cai3gFault:Cai3gFault>
         </detail>
      </ns2:Fault>
   </S:Body>
</S:Envelope>

Reference List

Ericsson Documents
[1] Glossary of Terms and Acronyms, 0033-CSH 109 628 Uen
[2] Generic CAI3G Interface 1.2 Specification, 2/155 19-FAY 302 0003 Uen
[3] Library Overview, 18/1553-CSH 109 628 Uen
[4] CAI3G Implementation, 26/155 19-CSH 109 628 Uen


Copyright

© Ericsson AB 2017. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

    Layered EIR Provisioning over CAI3G         Ericsson Dynamic Activation 1