2. PROTEI HLR API
Page 2 of 84
Copyright
No part of this document, whether modified or translated to other languages, may be reproduced or
used in any way without prior written permission of PROTEI Scientific Technical Center.
3. PROTEI HLR API
Page 3 of 84
Table of Contents
1 GENERAL INFORMATION.................................................................................... 8
1.1 PURPOSE OF THE DOCUMENT................................................................................................................. 8
1.2 STRUCTURE OF THE DOCUMENT............................................................................................................. 8
1.3 TECHNICAL SUPPORT............................................................................................................................... 9
1.3.1 Manufacturer ....................................................................................................................................... 9
1.3.2 Technical Support Group................................................................................................................... 9
2 JSON OVER HTTP INTERFACE........................................................................... 10
2.1 GENERAL ............................................................................................................................................... 10
2.2 REQUESTS TO PROTEI HLR/HSS API ................................................................................................. 12
2.2.1 Add Subscriber (AddSubscriber).................................................................................................... 12
2.2.2 Delete Subscriber (DeleteSubscriber)........................................................................................... 15
2.2.3 Change Status (ChangeStatus)...................................................................................................... 16
2.2.4 Change MSISDN (SetMSISDN) ..................................................................................................... 17
2.2.5 Change Profile (ProfileControl)....................................................................................................... 18
2.2.6 Get Profile (ProfileControl) .............................................................................................................. 22
2.2.7 Change IMSI (ChangeIMSI)............................................................................................................ 28
2.2.8 Change WhiteBlackLists (ChangeWhiteBlackLists) .................................................................... 29
2.2.9 Add And Activate Empty Subscribers (AddAndActivateEmptySubscribers)............................ 30
2.2.10 Change QoS Profile (ChangeQoSProfile) .................................................................................. 30
2.2.11 Send Cancel Location (SendCancelLocation) ........................................................................... 31
2.2.12 Add Subscriber Batch (AddSubscriberBatch) ............................................................................ 33
2.2.13 Change Application Server (ChangeApplicationServer)........................................................... 34
2.2.14 Get Application Server (GetApplicationServer).......................................................................... 34
2.2.15 Change Service Profile (ChangeServiceProfile)........................................................................ 35
2.2.16 Get Service Profile (GetServiceProfile)....................................................................................... 36
2.2.17 Change IFC Parameters (ChangeIfc).......................................................................................... 36
2.2.18 Get IFC Parameters (GetIfc)......................................................................................................... 37
2.2.19 Change Preffered S-CSCF Set (ChangePrefferedScscfSet)................................................... 38
2.2.20 Get Preffered S-CSCF Set (GetPrefferedScscfSet).................................................................. 38
2.2.21 Change Capabilities Set (ChangeCapabilitiesSet).................................................................... 39
2.2.22 Get Capabilities Set (GetCapabilitiesSet)................................................................................... 40
2.2.23 Change Charging Information (ChangeChargingInformation)................................................. 40
2.2.24 Get Charging Information (GetChargingInformation)................................................................ 41
2.2.25 Change Roaming Agreement (ChangeRoamingAgreement) .................................................. 41
2.2.26 Get Roaming Agreement (GetRoamingAgreement) ................................................................. 42
2.3 DESCRIPTION OF ENTRIES ..................................................................................................................... 43
2.3.1 ODB Parameters............................................................................................................................... 43
2.3.2 CAMEL Parameters ......................................................................................................................... 44
2.3.3 SS Parameters.................................................................................................................................. 48
2.3.4 PDP Parameters............................................................................................................................... 50
2.3.5 EPS Parameters ............................................................................................................................... 52
2.3.6 AUC Parameters............................................................................................................................... 56
2.3.7 Roaming Parameters ....................................................................................................................... 57
2.3.8 Lcs Parameters................................................................................................................................. 58
2.3.9 White List/Black List Parameters.................................................................................................... 58
2.3.10 Value Control Parameters............................................................................................................. 60
2.3.11 Subscriber parameters .................................................................................................................. 60
2.3.12 QoS Parameters............................................................................................................................. 61
2.3.13 IMS Subscription Parameters....................................................................................................... 62
2.3.14 SIP Authentication Parameters .................................................................................................... 63
2.3.15 IMS Public Identity Parаmeters .................................................................................................... 63
2.3.16 Access Restriction Parameters .................................................................................................... 64
2.3.17 Application Server Parameters..................................................................................................... 65
2.3.18 Service Profile Parameters ........................................................................................................... 68
2.3.19 IFC Cut Parameters ....................................................................................................................... 68
2.3.20 IFC Parameters............................................................................................................................... 68
2.3.21 Trigger Point Parameters .............................................................................................................. 69
4. PROTEI HLR API
Page 4 of 84
2.3.22 Service Point Trigger Parameters................................................................................................ 69
2.3.23 Preffered S-CSCF Parameters..................................................................................................... 70
2.3.24 Capabilities Parameters ................................................................................................................ 70
2.3.25 Charging Parameters..................................................................................................................... 71
2.3.26 Roaming Agreement Parameters................................................................................................. 71
2.4 REQUESTS FROM XML-GATE TO HLR ................................................................................................. 73
2.4.1 SendCancelLocation ........................................................................................................................ 73
2.4.2 SendISD............................................................................................................................................. 73
2.4.3 SendISD_SGSN ............................................................................................................................... 75
2.4.4 SendDSD ........................................................................................................................................... 75
APPENDIX........................................................................................................... 77
BEARER SERVICE CODE ................................................................................................................................... 77
TELESERVICE .................................................................................................................................................... 81
SUPPLEMENTARY SERVICE CODES.................................................................................................................. 83
5. PROTEI HLR API
Page 5 of 84
Glossary
Table 1 ‒ List of abbreviations
Definition/Acronym/Abbreviation Description
API Application Programming Interface
APN Access Point Network
AS Application Server
AUC Authentication
CAMEL Customized Applications for Mobile network Enhanced Logic
CLR Cancel Location Request
CS Circuit Switch
CSCF Call Session Control Function
CSI CAMEL Subscription Information
DIAMETER Authentication, authorization and accounting protocol
DL Downlink
DNS Domain Name System
DSD Delete Subscriber Data
DSR Delete Subscriber Data Request
EDGE Enhanced Data rates for GSM Evolution
EPS Evolved Packet System
EUTRAN Evolved Universal Terrestrial Radio Access Network
FQDN Fully Qualified Domain Name
GAN Generative Adversarial network
GERAN GSM EDGE Radio Access Network
GPRS General Packet Radio Service
GSM Global System for Mobile Communications
GT Global Title
HLR Home Location Register
HPLMN Home PLMN
HSM Hardware Security Module
HSS Home Subscriber Server
HTTP HyperText Transfer Protocol
IFC Initial Filter Criteria
6. PROTEI HLR API
Page 6 of 84
Definition/Acronym/Abbreviation Description
IM-SSF IP Multimedia Subsystem Service Switching Function
IMS IP Multimedia Subsystem
IMSI International Mobile Subscriber Identity
IP Internet Protocol
ISD Insert Subscriber Data
IDR Insert Subscriber Data Request
JSON JavaScript Object Notation
LCS Location Service Subscriber
LMSI Local Mobile Subscriber Identity
LTE Long-Term Evolution
MAP Mobile Application Part
MCC Mobile Country Code
M-CSI Mobility Management CAMEL Subscription Information
MNC Mobile Network Code
MME MultiMedia Extensions
MSC Mobile Switching Center
MSISDN Mobile Subscriber Integrated Services Digital Number
O-CSI Originating CAMEL Subscription Information
ODB Operator Determined Barring
OMI Open Messaging Interface
PDN Public Data Network
PDP Packet Data Protocol
PLMN Public Land Mobile Network
PS Packet Switch
QoS Quality of Service
SCCP Signalling Connection Control Part
S-CSCF Serving CSCF
SDP Session Description Protocol
SGSN Serving GPRS Support Node
SIM Subscriber Identification Module
SIP Session Initiation Protocol
7. PROTEI HLR API
Page 7 of 84
Definition/Acronym/Abbreviation Description
SMS Short Message Service
SMSC SMS Center
SRI Send Routing Information
SRIFSM Send Routing Information for Short Message
SS Supplementary Service
T-CSI Terminating CAMEL Subscription Information
TIF-CSI Translation information flag
UE User Equipment
UL Uplink
UMTS Universal Mobile Telecommunications System
URL Universal Resource Locator
USSD Unstructured Supplementary Service Data
UTRAN UMTS Terrestrial Radio Access Network
VLR Visitor Location Register
VPLMN Visited PLMN
3GPP 3rd Generation Partnership Project
8. PROTEI HLR API
Page 8 of 84
1 General Information
1.1 Purpose of the Document
The present document describes JSON API between PROTEI HLR/HSS and 3rd party systems,
that is used to provide, change or delete HLR/HSS subscriber profiles.
1.2 Structure of the Document
This guide comprises the following principal sections:
“General Information” – section, containing information about the purpose of the document,
manufacturer and technical support.
“JSON over HTTP interface” – section, containing specification of JSON over HTTP/HTTPS
interface.
The appendix with different service codes is provided at the end of the guide.
Attention!
Please familiarize yourself with the certificate of the device and the operating documentation prior
to installing and operating the system.
This document must be kept near the device at all times.
9. PROTEI HLR API
Page 9 of 84
1.3 Technical support
Technical support provides the following service levels: support regarding the correction of errors
and solution of problems that may arise during the system operation and any additional consulting about
the system operation.
1.3.1 Manufacturer
PROTEI Scientific Technical Center
Business Center "TELECOM"
60A B.Sampsonievsky pr.
St. Petersburg, 194044, Russia
Tel.: +7 812-449-4727
Fax: +7 812-449-4729
WEB: http://www.protei.com
Е-mail: sales@protei.com
1.3.2 Technical Support Group
PROTEI Scientific Technical Center
Business Center "TELECOM"
60A B.Sampsonievsky pr.
St. Petersburg, 194044, Russia
Tel.: +7 812-449-4727, ext. 5888 (24x7)
Fax: +7 812-449-4729
WEB: http://www.protei.com
Е-mail: mobile.support@protei.com
10. PROTEI HLR API
Page 10 of 84
2 JSON over HTTP interface
2.1 General
Requests are handled in synchronous mode. Each request from the client party is processed by
the server party and the answer is returned on a synchronous basis.
Requests are sent by using HTTP protocol.
The requests and responses are constructed in JSON.
The JSON requests and responses are based on provided JSON schemes. Each request supports
one operation.
Each JSON request and response must be encoded in UTF-8 in order to support multiple
languages in one system.
Profile.json (API Oracle) is provided below.
{
"Profile_id":"<integer>",
"SCA":"<String>",
"O_CSI":"<String>",
"T_CSI":"<String>",
"SMS_CSI":"<String>",
"USSD_CSI":"<String>",
"M_CSI":"<String>",
"GPRS_CSI":"<String>",
"PDP_DATA":"<String>", - id(%n);type(%s);address(%s);
"TeleServices":"<String>",
"Active_SS":"<String>",
"NotActive_SS":"<String>",
"Forced_SS":"<String>",
"SS_TeleServices":"<String>",
"DefaultForwardingNumber":"<String>",
"DefaultForwardingStatus":"<String>",
"Forwarding":"<String>",
"WL_DATA":"<String>",
"BL_DATA":"<String>",
"TK_ID":"<integer>",
"OP_ID":"<integer>",
"AucC_ID":"<integer>",
"AucR_ID":"<integer>",
"EPS_DEF_CONTEXT_ID":"<integer>",
"EPS_CONTEXTS":"<String>", - id(%n);ip4(%s);ip6(%s);
"LCS_ID":"<integer>",
"Group_ID":"<integer>",
"deacticvatePsi":"<integer>",
"baocWithoutCamel":"<integer>",
"qosGprsId":"<integer>",
"qosEpsId":"<integer>"
}
11. PROTEI HLR API
Page 11 of 84
Profile.json (API_BS Mysql/Oracle) is provided below.
{
"Profile_id":"<integer>",
"SCA":"<String>",
"O_CSI":[<integer>],
"T_CSI":[<integer>],
"SMS_CSI":[<integer>],
"USSD_CSI":[<integer>],
"M_CSI":[<integer>],
"GPRS_CSI":[<integer>],
"PDP_DATA":[{"context-
id":"<String>","address":<String>,"type":"<String>"}],
"TeleServices":[<integer>],
"Active_SS":[<integer>],
"NotActive_SS":[<integer>],
"Forced_SS":[<integer>],
"SS_TeleServices":[<integer>],
"DefaultForwardingNumber":"<String>",
"DefaultForwardingStatus":"<String>",
"Forwarding":"<String>",
"WL_DATA":[<integer>],
"BL_DATA":[<integer>],
"TK_ID":<integer>,
"OP_ID":<integer>,
"AucC_ID":<integer>,
"AucR_ID":<integer>,
"EPS_DATA":{"ueApnOiRep":"<String>","ueMaxDl":<integer>,"ueMaxUl":<integer>,"
ratType":<integer>,"ratFreqPriorId":<integer>,"defContextId":<integer>},
"EPS_CONTEXTS":[{"context-
id":"<String>","ipv4":<String>,"ipv6":"<String>"}],
"LCS_ID":<integer>,
"Group_ID":<integer>,
"deacticvatePsi":<integer>,
"baocWithoutCamel":<integer>,
"qosGprsId":<integer>,
"qosEpsId":<integer>,
"roamingNotAllowed":<integer>,
"accessRestrictionData":{"utranNotAllowed":<integer>,"geranNotAllowed":<integ
er>,"ganNotAllowed":<integer>,"iHspaEvolutionNotAllowed":<integer>,"wbEUtranN
otAllowed":<integer>,"hoToNon3GPPAccessNotAllowed":<integer>,"nbIotNotAllowed
":<integer>,"enhancedCoverageNotAllowed":<integer>},
"amfUmts":"<String>",
"amfLte":"<String>",
"amfIms":"<String>"
}
APPLICATION should use one endpoint URL for sending all requests to Protei HLR:
http(s)://<ProteiAPIServer>:<Port>/<path>/
where:
• ProteiAPIServer – Protei HLR server IP number or DNS name;
• Port – IP port number.
12. PROTEI HLR API
Page 12 of 84
The system is using Digest access authentication. Each user is assigned to a set of permissions:
• Read permission controls access to subscriber data via Get Profile command,
• Write permission provides the possibility to add/delete subscribers and change subscriber
profile details),
• Group identifier specifies a group of subscribers that is accessible to a user.
2.2 Requests to Protei HLR/HSS API
2.2.1 Add Subscriber (AddSubscriber)
This command is used to add a new subscriber into HLR/HSS.
Request
/SubscriberService/AddSubscriber
The following POST request JSON data format:
{
"imsi" : "<string>",
"msisdn" : "<string>",
"ki" : "<string>",
"algorithm" : <integer>,
"status" : <integer>,
"hlr_profile_id" : <integer>,
"ForbidReg_WithoutCamel>" : <integer>,
"ssData" : [<ssData>],
"ssForw" : [<ssForw>],
"ssBarring" : [<ssBarring>],
"aucData" : <aucData>,
"epsData" : <epsData>,
"IcsId" : <integer>,
"groupId" : <integer>,
"PDP_DATA" : "<string>",
"EPS_CONTEXTS" : "<string>",
"deactivatePsi" : <integer>,
"baocWithoutCamel" : <integer>,
"qosGprsId" : <integer>,
"qosEpsId" : <integer>,
"accessRestrictionData" : <AccessRestrictionData>,
"NetworkAccessMode" : <integer>,
"chargingCharacteristics" : "<string>",
"IpSmGw" : "<string>",
"ODB" : <odb_param>,
"imsSubscription" : <ImsSubscription>,
"periodicalLauTimer" : <integer>,
"periodicalRatTauTimer" : <integer>,
"aMsisdn" : List<string>,
"hsmId" : <integer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Mandatory String. IMSI of the subscriber
<msisdn> Optional String. MSISDN of the subscriber
<ki> Mandatory String. KI. Secret key is stored in the SIM and AuC
13. PROTEI HLR API
Page 13 of 84
Element/Attribute Mandatory Description
<algorithm> Mandatory Integer. Algorithm 1 – 4:
1 – COMP128 v1 / 2 – COMP128 v2 / 3 – COMP128 v1 /
4-Milenage
<status> Mandatory Integer. The subscriber administrative states. Possible
values:
• 0 ‒ not provisioned (the card is not assigned to
MSISDN);
• 1 ‒ provisioned/locked (the card is assigned to
MSISDN and locked);
• 2 ‒ provisioned/unlocked (in-service);
• 3 ‒ provisioned/suspended (service is stopped, for
example, if the phone was stolen);
• 4 – terminated (the subscriber is deleted)
<hlr_profile_id> Optional Integer. The subscriber identifier
<ForbidReg_
WithoutCamel>
Optional Integer. Flag to prohibit the registration on VLR/SGSN
without necessary CAMEL phases support. Possible
values: 0/1
<ssData> Optional List of Supplementary Services and their parameters. The
format is described in section 2.3.3
<ssForw> Optional List of Forwarding supplementary services and their
parameters. The format is described in section 2.3.3
<ssBarring> Optional List of Barring Supplementary Services and their
parameters. The format is described in section 2.3.3
<epsData> Optional Evolved Packet System Parameters. Format is described
in section 2.3.5
<aucData> Optional List of Authentication parameters. Format is described in
section 2.3.6
<lcsId> Optional Integer. LCS profile identifier to be assigned to a
subscriber
<groupId> Optional Integer. Subscriber group identifier
<PDP_DATA> Optional String. PDP context-ids for addition or removal
Format:
“{<pdp_context_id_1>,<pdp_context_type_1>,<ip_addr_1
>};“{<pdp_context_id_n>,<pdp_context_type_n>,<ip_addr
_n>}”
Example: "{4,f121,};{5,f121,}"
<EPS_CONTEXTS> Optional String. EPS context-ids for addition or removal
Format:
“{<eps_context_id_1>,<static_ipv4_1>,<static_ip_v6_1>};“
“{<eps_context_id_n>,<static_ipv4_n>,<static_ip_v6_n>};“
}”
Example: "{34,,};{16,,};"
<deactivatePsi> Optional Integer. PSI Req won’t be sent if SRI Req is obtained
14. PROTEI HLR API
Page 14 of 84
Element/Attribute Mandatory Description
<baocWithoutCamel> Optional Integer. Registration is not prohibited for the subscriber at
VLR, which doesn’t support CAMEL, but it must be
performed with prohibited roaming
<qosGprsId> Optional Integer. QoS profile identifier for GPRS
<qosEpsId> Optional Integer. QoS profile identifier for EPS
<accessRestrictionData> Optional Access restriction parameters. See description in section
2.3.16
<NetworkAccessMode> Optional Integer. The Network Access Mode defines if the
subscriber is registered to get the access to the CS
domain (non-GPRS/EPS), to the PS domain (GPRS/EPS)
or to both domains by using 3GPP access networks.
Possible values:
• 0 ‒ SC (packetAndCircuit);
• 1 ‒ SP (onlyCircuit);
• 2 ‒ ESP (onlyPacket)
<chargingCharacteristics> Optional String. EPS PDN Connection Charging Characteristics
data: ValueControl(string). See description in section
2.3.10
<IpSmGw> Optional String. The number of IP Short Message Gateway type:
ValueControl(string). The format is described in section
2.3.10
<ODB> Optional ODB parameters. See description in section 2.3.1
<imsSubscription> Optional IMS subscription parameters. See description in section
2.3.13
<aMsisdn> Optional List<string>. List of additional MSISDN (SRI, SRIFSM)
<periodicLauTimer> Optional Integer. Timer for periodical update of Location Area
<periodicRauTauTimer> Optional Integer. Timer for periodical update of Routing and
Tracking Areas
<hsmId> Optional Integer. HSM module identifier
Response
Below is an "AddSubscriber" response format.
{
"status" : "<string>"
}
15. PROTEI HLR API
Page 15 of 84
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The status of the request. Possible values:
• OK ‒ successful;
• NOT_FOUND ‒ object is not found;
• NOT_AVAILABLE ‒ action or object is not
available;
• PERMISSION_DENIED ‒ access error;
• INVALID_AUTH ‒ authorization error;
• INTERNAL_ERROR ‒ internal error;
• ALREADY_EXIST ‒ object already exists;
• INTEGRITY_VIOLATION ‒ integrity volation error;
• OBJECT_BUSY ‒ object is currently busy;
• INCORRECT_PARAMS ‒ incorrect input data;
• TEMPORARY_FAILURE ‒ temporary failure;
• HLR_SERVER_ERROR ‒ HLR server error;
• PARTIAL_OK ‒ request is performed partially
2.2.2 Delete Subscriber (DeleteSubscriber)
This command is used to delete a subscriber from HLR/HSS and AUC. If the subscriber has an
active registration on VLR, SGSN or MME, it is withdrawn by MAP or S6 Cancel location.
Request
/SubscriberService/DeleteSubscriber
POST request JSON data format:
{
"imsi" : "<string>"
}
or
{
"msisdn" : "<string>"
}
The request contains the following parameters: (Conditional means that the request can contain
either IMSI or MSISDN parameter).
Element/Attribute Mandatory Description
<imsi> Conditional String. IMSI of the subscriber
<msisdn> Соnditional String. MSISDN
Response
A "DeleteSubscriber" response format is given below:
{
"status" : "<string>"
}
16. PROTEI HLR API
Page 16 of 84
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
Note: If subscriber administrative state = unlocked, then HLR SendCancelLocation command is
used. The subscriber is not deleted in the reality and its administrative state is set to “terminated”.
2.2.3 Change Status (ChangeStatus)
This command is used to change the state of a subscription in HLR/HSS. If a subscriber whose
state has been changed from provisioned/unlocked state has an active registration on VLR, SGSN or
MME, it is withdrawn by MAP or S6 Cancel location. The same functionality may be achieved by
ProfileControl command.
Request
/SubscriberService/ChangeStatus
POST request JSON data format:
{
"imsi" : "<string>",
"status" : <integer>
}
Or
{
"msisdn" : "<string>",
"status" : <integer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Conditional String. IMSI of the subscriber
<msisdn> Conditional String. MSISDN
<status> Mandatory Integer. The subscriber status. Possible values:
• 0 ‒ not provisioned ‒ card is not assigned to
MSISDN;
• 1 ‒ provisioned/locked ‒ card is assigned to
MSISDN and blocked;
• 2 ‒ provisioned/unlocked ‒ in-service;
• 3 ‒ provisioned/suspended ‒ service is stopped if
for an example a mobile phone is stolen;
• 4 ‒ terminated ‒ subscriber is deleted
Response
A "ChangeStatus" response format is given below.
{
"status" : "<string>"
}
17. PROTEI HLR API
Page 17 of 84
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the response are described in
section 2.2.1
Note: If “unlocked” status is changed to any other status then HLR SendCancelLocation command
is used.
2.2.4 Change MSISDN (SetMSISDN)
This command is used to change the state of a subscription at HLR/HSS and/or MSISDN of a
subscriber. If the subscriber whose state has been changed from provisioned/unlocked state has an active
registration on VLR, SGSN or MME, it is withdrawn by MAP or S6 Cancel location. If the subscriber whose
MSISDN has been changed has an active registration on VLR, SGSN or MME, new MSISDN is sent in
MAP ISD or S6 IDR. The same functionality may be achieved by ProfileControl command.
Request
/ProfileService/SetMSISDN
POST request JSON data format:
{
"imsi" : "<string>",
"msisdn" : "<string>",
"status" : <integer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Mandatory String. IMSI of the subscriber
<msisdn> Mandatory String. MSISDN
<status> Optional Integer. The subscriber states are described in section
2.2.1
Response
A "SetMSISDN" response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
Note: If subscriber administrative-state=unlocked at the beginning of procedure, then HLR
SendCancelLocation command is used.
18. PROTEI HLR API
Page 18 of 84
2.2.5 Change Profile (ProfileControl)
This command is used to change different parameters of a subscription at HLR/HSS. When a
subscriber has an active registration on VLR or SGSN, MAP ISD/DSD or Cancel Location may be initiated
depending on the changed data. If EPS parameters are changed for the subscriber with an active
registration on MME/SGSN, S6 IDR, DSR or CLR may be initiated depending on the changed data.
Request
/ProfileService/ProfileControl
POST request JSON data format:
{
"imsi" : "<string>",
"msisdn" : "<string>",
"newMsisdn" : "<string>",
"status" : <integer>,
"forbid_reg" : <Boolean>,
"odb-param" : "<odb-param>",
"pdp-data" : "<pdp-data>",
"eps-data" : "<eps-data>",
"link-eps-data" : "<link-eps-data>",
"whiteListIds" : [<integer>],
"blackListIds" : [<integer>],
"csi-list" : [<csi>],
"ssData" : [<ssData>],
"ssForw" : [<ssForw>],
"ssBarring" : [<ssBarring>],
"teleserviceList" : [<integer>],
"bearerserviceList" : [<integer>],
"defaultForwNumber" : "<string>",
"defaultForwStatus" : <integer>,
"roamingNotAllowed" : <integer>,
"lcsId" : ValueControl {"value" : <integer>},
"groupId" : ValueControl {"value" : <integer>},
"deactivatePsi" : <integer>,
"baocWithoutCamel" : <integer>,
"ipSmGw" : ValueControl {"value" : "<string>"},
"networkAccessMode" : <integer>,
"qosGprsId" : ValueControl {"value" : <integer>},
"qosEpsId" : ValueControl {"value" : <integer>},
"accessRestrictionData" : "<accessRestrictionData>",
"chargingCharacteristics" : ValueControl {"value" : <integer>},
"imsSubscription" : "<ImsSubscription>",
"aMsisdn" : "List<ValueControl {"value" : <integer>}>",
"periodicalLauTimer" : ValueControl {"value" : <integer>},
"periodicalRatTauTimer" : ValueControl {"value" : <integer>},
"hsmId" : ValueControl {"value" : <integer>}
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Optional String. IMSI of the subscriber
<msisdn> Optional String. Old MSISDN of the subscriber
<newMsisdn> Optional String. New MSISDN of the subscriber
<status> Optional Integer. The subscriber statuses are in section 2.2.1
19. PROTEI HLR API
Page 19 of 84
Element/Attribute Mandatory Description
<forbid_reg> Optional
Boolean. Option to forbid the registration on VLR/SGSN
without necessary CAMEL phases support. Possible
values:
• 0 ‒ not to forbid the registration;
• 1 ‒ to forbid the registration.
Default value is 0
<odb-param> Optional Operator determined barring (ODB) parameters. The
format is described in section 2.3.1
<pdp-data> Optional PDP context list. The format is described in section 2.3.4
<link-eps-data> Optional EPS context-id for addition or removal. The format is
described in section 2.3.5
<eps-data> Optional EPS data. The format is described in section 2.3.5
<whiteListIds> Conditional Integer. White list ids that will replace the current list of
ids
<whiteListsIdsToAdd> Conditional Integer. List of ids for addition to the current list
<whiteListsIdsToDelete> Conditional Integer. List of ids for deletion from the current list
<blackListIds> Conditional Integer. Black list ids that will replace the current list of
ids
<blackListsIdsToAdd> Conditional Integer. List of ids for addition to the current list
<blackListsIdsToDelete> Conditional Integer. List of ids for deletion from the current list
<csi-list> Optional List of CSI. Format is described in section 2.3.2
<ssData> Optional List of Supplementary Services and their parameters.
Format is described in section 2.3.3
<ssForw> Optional
List of Forwarding supplementary services and their
parameters. Format is described in section 2.3.3
<ssBarring> Optional
List of Barring supplementary services and their
parameters. Format is described in section 2.3.3
<teleserviceList> Conditional List of Teleservices, that will replace subscriber’s
teleservices list
<teleservicesToAdd> Conditional List of Teleservices, that will be added to subscriber’s
teleservices list
<teleservicesToDelete> Conditional List of Teleservices, that will be deleted from
subscriber’s teleservices list
<bearerserviceList> Conditional List of Bearerservices, that will replace subscriber’s
bearerservices list
<bearerservicesToAdd> Conditional List of Bearerrvices, that will be added to subscriber’s
bearerservices list
<bearerservicesToDelete> Conditional List of Bearerrvices, that will be deleted from
subscriber’s bearerservices list
20. PROTEI HLR API
Page 20 of 84
Element/Attribute Mandatory Description
<defaultForwNumber> Optional String. Default forwarding number
<defaultForwStatus> Optional
Integer. Default forwarding status value
(Activate(1)/deactivate(0))
<roamingNotAllowed> Optional
Integer. The parameter indicating whether the roaming is
allowed (Activate(1)/deactivate(0))
<lcsId> Optional
Integer. LCS profile id to be assigned to a subscriber:
ValueControl(int). The format is described in section
2.3.10
<groupId> Optional
Integer. GroupId to be assigned to a subscriber:
ValueControl(int)). The format is described in section
2.3.10
<deactivatePsi> Optional Integer. PSI Req won’t be sent if SRI Req is obtained
<baocWithoutCamel> Optional
Integer. Registration is not prohibited for the subscriber
at VLR, which doesn’t support CAMEL, but it must be
performed with prohibited roaming
<ipSmGw> Optional
String. The number of IP Short Message Gateway type:
ValueControl(string). The format is described in section
2.3.10
<networkAccessMode> Optional
Integer. The Network Access Mode defines if the
subscriber is registered to get the access to the CS
domain (non-GPRS/EPS), to the PS domain
(GPRS/EPS) or to both domains by using 3GPP access
networks. Possible values:
• 0 ‒ SC (packetAndCircuit);
• 1 ‒ SP (onlyCircuit);
• 2 ‒ ESP (onlyPacket)
<qosGprsId> Optional
Integer. QoS profile identifier for GPRS type:
ValueControl(integer). The format is described in section
2.3.10
<qosEpsId> Optional
Integer. QoS profile identifier for EPS type:
ValueControl(integer). The format is described in section
2.3.10
<accessRestrictionData> Optional
Access restriction parameters. See description in section
2.3.16
<chargingCharacteristics> Optional
String. EPS PDN Connection Charging Characteristics
data: ValueControl(string). See description in section
2.3.10
<imsSubscription> Optional
IMS subscription parameters. See description in section
2.3.13
<aMsisdn> Optional
List of additional MSISDN: List<ValueControl(String)>.
See description in section 2.3.10
<periodicLauTimer> Optional Integer. Timer for periodical update of Location Area
21. PROTEI HLR API
Page 21 of 84
Element/Attribute Mandatory Description
<periodicRauTauTimer> Optional Integer. Timer for periodical update of Routing and
Tracking Areas
<hsmId> Optional
Integer. HSM module identifier: ValueControl(int). See
description in section 2.3.10
Response
A "ProfileControl" response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
22. PROTEI HLR API
Page 22 of 84
2.2.6 Get Profile (ProfileControl)
This command is used to fetch subscriber’s profile data from HLR/HSS.
Request
/ProfileService/GetProfile
POST request JSON data format (true (1) ‒ data is requested, false (0) ‒ data is not requested):
{
"imsi" : "<string>",
"msisdn" : "<string>",
"impi" : "<string>",
"impu" : "<string>",
"status" : <boolean>,
"forbid_reg" : <boolean>,
"odb-param" : <boolean>,
"pdp-data" : <boolean>,
"eps-context-data" : <boolean>,
"eps-data" : <boolean>,
"csi-list" <boolean>;
"ssData" : <boolean>,
"ssForw" : <boolean>,
"ssBarring" : <boolean>,
"teleserviceList" : <boolean>,
"bearerserviceList" : <boolean>,
"roaming-info" : <boolean>,
"roaming-sgsn-info" : <boolean>,
"defaultForw" : <boolean>,
"whiteLists" : <boolean>,
"blackLists" : <boolean>,
"lcs" : <boolean>,
"tk" : <boolean>,
"group" : <boolean>,
"deactivatePsi" : <boolean>,
"baocWithoutCamel" : <boolean>,
"ipSmGw" : <boolean>,
"networkAccessMode" : <boolean>,
"fullWBL" : <boolean>,
"fullCSI" : <boolean>,
"qosGprsId" : <boolean>,
"qosEpsId" : <boolean>,
"accessRestrictionData" : <boolean>,
"chargingCharacteristics" : <boolean>,
"ims" : <boolean>,
"imsFull" : <boolean>,
"aMsisdn" : <boolean>,
"periodicalLauTimer" : <boolean>,
"periodicalRatTauTimer" : <boolean>,
"hsmId" : <boolean>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Optional String. IMSI of the subscriber
<msisdn> Optional String. Subscriber’s MSISDN
<impi> Optional String. IMS private user identity
23. PROTEI HLR API
Page 23 of 84
Element/Attribute Mandatory Description
<impu> Optional String. IMS public user identity
<status> Optional Boolean. The subscriber status. Possible values: 0/1
<forbid_reg> Optional
Boolean. Registration prohibited without CAMEL flag.
Possible values: 0/1
<odb-param> Optional Boolean. Operator determined barring data parameters.
The format is described in section 2.3.1. Possible values:
0/1
<pdp-data>
Optional Boolean. List of subscriber’s GPRS PDP Context and their
data. The format is described in section 2.3.4. Possible
values: 0/1
<eps-context-data> Optional
Boolean. Subscriber’s list of EPS context and their
parameters. See section 2.3.5. Possible values: 0/1
<eps-data> Optional
Boolean. Subscriber’s EPS parameters. See section
2.3.5. Possible values: 0/1
<csi-list>
Optional Boolean. List of CSI. The format is described in section
2.3.2. Possible values: 0/1
<ssData> Optional Boolean. List of supplementary services. The format is
described in section 2.3.3. Possible values: 0/1
<ssForw>
Optional Boolean. List of forwarding supplementary services. The
format is described in section 2.3.3. Possible values: 0/1
<ssBarring>
Optional Boolean. List of barring supplementary services. The
format is described in section 2.3.3. Possible values: 0/1
<teleserviceList> Optional Boolean. List of teleservices. Possible values: 0/1
<bearerserviceList> Optional Boolean. List of bearerservices. Possible values: 0/1
<roaming-info>
Optional Boolean. MSC/VLR Roaming information. The format is
described in section 2.3.7. Possible values: 0/1
<roaming-sgsn-info> Optional
Boolean. SGSN/MME Roaming information. The format is
described in section 2.3.7. Possible values:0/1
<defaultForw> Optional Boolean. Default forwarding. Possible values: 0/1
<whiteLists> Optional
Boolean. White lists, that allow the registration in selected
PLMNs. The format is described in section 2.3.9. Possible
values: 0/1
<blackLists> Optional
Boolean. Black lists, that prohibit the registration in
selected PLMNs. Possible values: 0/1
<lcs> Optional Boolean. Subscriber’s LCS profile. Possible values: 0/1
<tk> Optional
Boolean. Transport key used to encrypt Ki in AUC 0/1.
Possible values: 0/1
<group>
Optional Boolean. A group to which a subscriber belongs to.
Possible values: 0/1
24. PROTEI HLR API
Page 24 of 84
Element/Attribute Mandatory Description
<deactivatePsi>
Optional Boolean. PSI Req won’t be sent if SRI Req is obtained.
Possible values: 0/1
<baocWithoutCamel>
Optional Boolean. The registration is not prohibited for the
subscriber at the VLR, which doesn’t support CAMEL, but
it must be performed with prohibited roaming. Possible
values: 0/1
<ipSmGw>
Optional Boolean. The number of IP Short Message Gateway.
Possible values: 0/1
<networkAccessMode>
Optional Boolean. Accessible domain of a Mobile network. Possible
values: 0/1
<fullWBL>
Optional Boolean. The parameter determining whether the full list
of WBL (white list / black list) is provided or not. Possible
values: 0/1
<fullCSI>
Optional Boolean. The parameter determining whether the full list
of CSI is provided or not. Possible values: 0/1
<qosGprsId>
Optional Boolean. QoS profile identifier for GPRS. Possible values:
0/1
<qosEpsId>
Optional Boolean. QoS profile identifier for EPS. Possible values:
0/1
<accessRestrictionData>
Optional Boolean. Access restriction parameters. See description
in section 2.3.16. Possible values: 0/1
<chargingCharacteristics>
Optional Boolean. EPS PDN Connection Charging Characteristics
data. Possible values: 0/1
<ims>
Optional Boolean. Brief information about IMS parameters of a
subscriber. Possible values: 0/1
<imsFull>
Optional Boolean. Full information about IMS parameters of a
subscriber. Possible values: 0/1
<aMsisdn>
Optional Boolean. A list of additional MSISDN (SRI, SRIFSM).
Possible values: 0/1
<periodicLauTimer> Optional Boolean. Timer for periodical update of Location Area.
Possible values: 0/1
<periodicRauTauTimer> Optional Integer. Timer for periodical update of Routing and
Tracking Areas. Possible values: 0/1
<hsmId>
Optional Boolean. HSM module identifier.
Possible values: 0/1
26. PROTEI HLR API
Page 26 of 84
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The subscriber statuses are described in section
2.2.1
<imsi> Mandatory String. IMSI of the subscriber
<msisdn> Optional String. Subscriber’s MSISDN
<administrative_state> Optional Integer. Subscriber’s state
<forbid_reg> Optional Integer. Registration prohibited without CAMEL flag
<roaming_not_allowed> Optional Integer. Roaming is not allowed for the subscriber
<odb-param> Optional Operator determined barring data parameters. The format
is described in section 2.3.1
<pdp-data> Optional List of subscriber’s GPRS PDP Context and their data.
The format is described in section 2.3.4
<eps-context-data> Optional Subscriber’s list of EPS context and their parameters. See
section 2.3.5
<eps-data> Optional Subscriber’s EPS parameters. See section 2.3.5
<csi-list> Optional List of CSI. The format is described in section 2.3.2
<oCsi-list> Optional List of oCSI. The format is described in section 2.3.2
<tCsi-list> Optional List of tCSI. The format is described in section 2.3.2
<smsCsi-list> Optional List of smsCSI. The format is described in section 2.3.2
<gprsCsi-list> Optional List of gprsCSI. The format is described in section 2.3.2
<mCsi-list> Optional List of mCSI. The format is described in section 2.3.2
<dCsi-list> Optional List of dCSI. The format is described in section 2.3.2
<ssCsi-list> Optional List of ssCSI. The format is described in section 2.3.2
<ssData> Optional List of supplementary services. The format is described in
section 2.3.3
<ssForw> Optional List of forwarding supplementary services. The format is
described in section 2.3.3
<ssBarring> Optional List of barring supplementary services. The format is
described in section 2.3.3
<lcsPrivacy> Optional Information about LocalServiceSubscriber. The format is
described in section 2.3.8
<lcsMolr> Optional Information about LocalServiceSubscriber. The format is
described in section 2.3.8
<teleserviceList> Optional List of teleservices
<bearerserviceList> Optional List of bearerservices
27. PROTEI HLR API
Page 27 of 84
Element/Attribute Mandatory Description
<roaming-info> Optional
MSC/VLR Roaming information. The format is described
in section 2.3.7
<roaming-sgsn-info> Optional
SGSN/MME Roaming information. The format is
described in section 2.3.7
<defaultForwNumber Optional String. Default forwarding number
<defaultForwStatus>
Optional
Integer. Default forwarding status value. Possible values:
0/1
<whiteLists> Optional White lists, that allow registration in selected PLMNs. The
format is described in section 2.3.9
<blackLists> Optional Blacklists, that prohibit the registration in selected PLMNs.
The format is described in section 2.3.9
<lcsId> Optional Integer. Id of subscriber’s LCS profile
<tkId> Optional Integer. Id of transport key used to encrypt Ki in AUC
<groupId> Optional Integer. Id of a group to which a subscriber belongs to
<deactivatePsi> Optional Integer. PSI Req won’t be sent if SRI Req is obtained
<baocWithoutCamel> Optional Integer. Registration is not prohibited for the subscriber at
VLR, which doesn’t support CAMEL, but it must be
performed with prohibited roaming. Possible values: 0/1
<ipSmGw> Optional String. The number of IP Short Message Gateway type:
ValueControl(string). The format is described in section
2.3.10
<networkAccessMode> Optional Integer. The Network Access Mode defines if the
subscriber is registered to get the access to the CS
domain (non-GPRS/EPS), to the PS domain (GPRS/EPS)
or to both domains by using 3GPP access networks.
Possible values:
• 0 ‒ SC (packetAndCircuit);
• 1 ‒ SP (onlyCircuit);
• 2 ‒ ESP (onlyPacket)
<qosGprsId> Optional Integer. QoS profile identifier for GPRS type:
ValueControl(int). The format is described in section
2.3.10
<qosEpsId> Optional Integer. QoS profile identifier for EPS type:
ValueControl(int). The format is described in section
2.3.10
<accessRestrictionData> Optional List of access restriction parameters. The format is
described in section 2.3.16
<chargingCharacteristics> Optional String. EPS PDN Connection Charging Characteristics
data: ValueControl(string). See description in section
2.3.10
<imsSubscription> Optional List of IMS subscription parameters. The format is
described in section 2.3.13
28. PROTEI HLR API
Page 28 of 84
Element/Attribute Mandatory Description
<imsUserData> Optional String. IMS parameters
<roaming-scscf-info> Optional List of roaming S-CSCF parameters. See description in
section 2.3.7
<aMsisdn> Optional List<string>. List of additional MSISDN (SRI, SRIFSM)
<periodicLauTimer> Optional Integer. Timer for periodical update of Location Area
<periodicRauTauTimer> Optional Integer. Timer for periodical update of Routing and
Tracking Areas
<hsmId> Optional Integer. HSM module identifier
2.2.7 Change IMSI (ChangeIMSI)
This command is used for SIM swap operation, both new (imsi) and old (oldimsi) IMSI should be
provided into HLR/HSS before the command is executed. All profile data including MSISDN is transferred
from “oldimsi” to “imsi”. If a subscriber (“oldimsi”) whose state has been changed from provided/unlocked
state has an active registration on VLR, SGSN or MME, it is withdrawn by MAP or S6 Cancel location.
Request
/ProfileService/ChangeIMSI
POST request JSON data format:
{
"imsi" : "<string>",
"oldimsi" : "<string>",
"msisdn" : "<string>",
"status" : <integer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Mandatory String. New IMSI of the subscriber
<oldimsi> Optional String. Old IMSI of the subscriber
<msisdn> Optional String. MSISDN
<status> Optional Integer. The subscriber states are described in section
2.2.1
Response
A "ChangeIMSI" response format is given below.
{
"status" : "<string>"
}
The response contains following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The states of the request are described in section
2.2.1
29. PROTEI HLR API
Page 29 of 84
Note: The status for the card with oldIMSI is set to “4”. The status for a new card is taken from
input parameters or from old IMSI. If MSISDN is already attached to new IMSI, the error will be shown.
Subscriber profile must be transferred to a new card from old card, for this old IMSI must be replaced by
new IMSI in the database.
2.2.8 Change WhiteBlackLists (ChangeWhiteBlackLists)
This command is used to change the contents of white/black lists.
Request
/ProfileService/ChangeWhiteBlackLists
POST request JSON data format:
{
"whiteLists" : [<wbList>],
"blackLists" : [<wbList>]
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<whiteLists> Optional White lists. The format is described in section 2.3.9
<blackLists> Optional Black lists. The format is described in section 2.3.9
Response
A "ChangeWhiteBlackLists" response format is given below.
{
"status" : "<string>"
}
The response contains following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
30. PROTEI HLR API
Page 30 of 84
2.2.9 Add And Activate Empty Subscribers
(AddAndActivateEmptySubscribers)
This command is used to upload a list of technical subscriptions into HSS for organization of SMS
hub. MT SMS sent to a MSISDN from the list would be forwarded to SMSC GT (SMSC parameter).
Request
/SubscriberService/AddAndActivateEmptySubscribers
POST request JSON data format:
"subscribers":[
{
"imsi": "<string>",
"msisdn": "<string>",
"teleServices": "<string>",
"smsc": "<string>"
},
…
{
"imsi": "<string>",
"msisdn": "<string>",
"teleServices": "<string>",
"smsc": "<string>"
}
]
The request contains the following parameters:
Element/Attribute Mandatory Description
<subscribers> Mandatory List of subscribers. Parameters are described in section
2.3.11
Response
A “AddAndActivateEmptySubscribers” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.10 Change QoS Profile (ChangeQoSProfile)
This command is used to change GPRS/EPS contents of QoS profiles.
Request
/ProfileService/ChangeQosProfile
POST request JSON data format:
{
"action" : "<string>",
"qosGprs" : {<qosGprs>}
}
Or
31. PROTEI HLR API
Page 31 of 84
{
"action" : "<string>",
"qosEps" : {<qosEps>}
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<action> Mandatory String. Action name. Possible values: create/modify/delete
<qosGprs> Conditional QoS profile for GPRS type. The format is described in
2.3.12
<qosEps> Conditional QoS profile for EPS type. The format is described in
2.3.12
Response
A “ChangeQosProfile” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.11 Send Cancel Location (SendCancelLocation)
This command is used for sending CancelLocation request to a certain domain.
Request
/SubscriberService/SendCancelLocation
The following POST request JSON data format:
{
"imsi" : "<string>",
"domain" : "<string>"
}
Or
{
"msisdn" : "<string>",
"domain" : "<string>"
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<imsi> Conditional String. IMSI of the subscriber
<msisdn> Conditional String. MSISDN of the subscriber
32. PROTEI HLR API
Page 32 of 84
Element/Attribute Mandatory Description
<domain> Optional String. Domain, to which Cancel VLR/SQSN/MME is sent.
Possible values: CS (circuit switch) /PS (packet switch)
/EPS (evolved packet switch).
Note: If the parameter isn’t specified it is sent to all
domains
Response
A "SendCancelLocation" response format is given below:
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
33. PROTEI HLR API
Page 33 of 84
2.2.12 Add Subscriber Batch (AddSubscriberBatch)
This command is used to add a batch of subscribers.
Request
/SubscriberService/AddSubscriberBatch
The following POST request JSON data format:
"requests":[
{
"imsi" : "<string>",
"msisdn" : "<string>",
"ki" : "<string>",
"algorithm" : <integer>,
"status" : <integer>,
"hlr_profile_id" : <integer>,
"ForbidReg_WithoutCamel>" : <integer>,
"ssData" : [<ssData>],
"ssForw" : [<ssForw>],
"ssBarring" : [<ssBarring>],
"aucData" : <aucData>,
"epsData" : <epsData>,
"IcsId" : <integer>,
"groupId" : <integer>,
"PDP_DATA" : "<string>",
"EPS_CONTEXTS" : "<string>",
"deactivatePsi" : <integer>,
"baocWithoutCamel" : <integer>,
"qosGprsId" : <integer>,
"qosEpsId" : <integer>,
"accessRestrictionData" : <AccessRestrictionData>,
"NetworkAccessMode" : <integer>,
"chargingCharacteristics" : "<string>",
"IpSmGw" : "<string>",
"ODB" : <odb_param>,
"imsSubscription" : <ImsSubscription>,
"periodicalLauTimer" : <integer>,
"periodicalRatTauTimer" : <integer>,
"aMsisdn" : List<string>,
"hsmId" : <integer>
},
…
{}
]
The request contains the following parameters:
Element/Attribute Mandatory Description
<requests> Mandatory List of “Add subscriber” requests. See description in
section 2.2.1
Response
A “AddSubscriberBatch” response format is given below.
{
"status" : "<string>"
}
34. PROTEI HLR API
Page 34 of 84
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.13 Change Application Server (ChangeApplicationServer)
This command is used to change an application server.
Request
/ProfileService/ControlAs
The following POST request JSON data format:
{
"Action" : "<string>",
"As" : <ApplicationServer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Action> Mandatory String. Action type. Possible values: create/modify/delete
<As> Mandatory Application server parameters. See description in section
2.3.17
Response
A “ChangeApplicationServer” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.14 Get Application Server (GetApplicationServer)
This command is used to get an application server.
Request
/ProfileService/GetAs
The following POST request JSON data format:
{
"ServerName" : "<string>"
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<ServerName> Mandatory String. Server name
35. PROTEI HLR API
Page 35 of 84
Response
A “GetApplicationServer” response format is given below.
{
"status" : "<string>",
"As" : <ApplicationServer>
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<As> Mandatory Application server parameters. See description in section
2.3.17
2.2.15 Change Service Profile (ChangeServiceProfile)
This command is used to change a service profile.
Request
/ProfileService/ControlServiceProfile
The following POST request JSON data format:
{
"Action" : "<string>",
"ServiceProfile" : <ServiceProfile>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Action> Mandatory String. Action type. Possible values: create/modify/delete
<ServiceProfile> Mandatory Service profile parameters. See description in section
2.3.18
Response
A “ChangeServiceProfile” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
36. PROTEI HLR API
Page 36 of 84
2.2.16 Get Service Profile (GetServiceProfile)
This command is used to get a service profile.
Request
/ProfileService/GetServiceProfile
The following POST request JSON data format:
{
"Name" : "<string>"
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Name> Mandatory String. Service name
Response
A “GetServiceProfile” response format is given below.
{
"status" : "<string>",
"ServiceProfile" : <ServiceProfile>
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<ServiceProfile> Mandatory Service profile parameters. See description in section
2.3.18
2.2.17 Change IFC Parameters (ChangeIfc)
This command is used to change IFC parameters.
Request
/ProfileService/ControlIfc
The following POST request JSON data format:
{
"Action" : "<string>",
"Ifc" : <Ifc>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Action> Mandatory String. Action type. Possible values: create/modify/delete
<Ifc> Mandatory IFC parameters. See description in section 2.3.20
37. PROTEI HLR API
Page 37 of 84
Response
A “GetServiceProfile” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.18 Get IFC Parameters (GetIfc)
This command is used to get IFC parameters.
Request
/ProfileService/GetIfc
The following POST request JSON data format:
{
"Name" : "<string>"
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Name> Mandatory String. Name of IFC parameter
Response
A “GetIfc” response format is given below.
{
"status" : "<string>",
"Ifc" : <Ifc>
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<Ifc> Mandatory IFC parameters. See description in section 2.3.20
38. PROTEI HLR API
Page 38 of 84
2.2.19 Change Preffered S-CSCF Set (ChangePrefferedScscfSet)
This command is used to change preffered S-CSCF set.
Request
/ProfileService/ControlPrefferedScscfSet
The following POST request JSON data format:
{
"Action" : "<string>",
"SetId" : <integer>,
"Scscfs" : [<PrefferedScscf>]
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Action> Mandatory String. Action type. Possible values: create/modify/delete
<SetId> Mandatory Integer. Set identifier
<Scscfs> Mandatory Preffered S-CSCF parameters. See description in section
2.3.23
Response
A “ChangePrefferedScscfSet” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.20 Get Preffered S-CSCF Set (GetPrefferedScscfSet)
This command is used to get preffered S-CSCF set.
Request
/ProfileService/GetPrefferedScscfSet
The following POST request JSON data format:
{
"SetId" : <integer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<SetId> Mandatory Integer. Set identifier
39. PROTEI HLR API
Page 39 of 84
Response
A “GetPrefferedScscfSet” response format is given below.
{
"status" : "<string>",
"Scscfs" : <PrefferedScscf>
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<Scscfs> Mandatory Preffered S-CSCF parameters. See description in section
2.2.23
2.2.21 Change Capabilities Set (ChangeCapabilitiesSet)
This command is used to change capabilities set.
Request
/ProfileService/ControlCapabilitiesSet
The following POST request JSON data format:
{
"Action" : "<string>",
"SetId" : <integer>,
"Capabilities" : [<Capability>]
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Action> Mandatory String. Action type. Possible values: create/modify/delete
<SetId> Mandatory Integer. Set identifier
<Capabilities> Mandatory Capabilities parameters. See description in section 2.3.24
Response
A “ChangeCapabilitiesSet” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
40. PROTEI HLR API
Page 40 of 84
2.2.22 Get Capabilities Set (GetCapabilitiesSet)
This command is used to get capabilities set.
Request
/ProfileService/GetCapabilities
The following POST request JSON data format:
{
"SetId" : <integer>
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<SetId> Mandatory Integer. Set identifier
Response
A “ChangeCapabilitiesSet” response format is given below.
{
"status" : "<string>",
"Capabilities" : [<Capability>]
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<Capabilities> Mandatory Capabilities parameters. See description in section 2.3.24
2.2.23 Change Charging Information (ChangeChargingInformation)
This command is used to change charging information.
Request
/ProfileService/ControlChargingInformation
The following POST request JSON data format:
{
"Action" : "<string>",
"ChargingInformation" : [<ChargingInformation>]
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Action> Mandatory String. Action type. Possible values: create/modify/delete
<ChargingInformation> Mandatory Charging parameters. See description in section 2.3.25
41. PROTEI HLR API
Page 41 of 84
Response
A “ChangeChargingInformation” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.24 Get Charging Information (GetChargingInformation)
This command is used to get charging information.
Request
/ProfileService/GetChargingInformation
The following POST request JSON data format:
{
"Name" : "<string>"
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<Name> Mandatory String. Name of charging parameter
Response
A “GetChargingInformation” response format is given below.
{
"status" : "<string>",
"ChargingInformation" : <ChargingInformation>
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<ChargingInformation> Mandatory Charging parameters. See description in section 2.3.25
2.2.25 Change Roaming Agreement (ChangeRoamingAgreement)
This command is used to change roaming agreement.
Request
/ProfileService/ControlRoamingAgreement
The following POST request JSON data format:
{
"Vlrs" : [<RoamingAgreement>]
}
42. PROTEI HLR API
Page 42 of 84
The request contains the following parameters:
Element/Attribute Mandatory Description
<Vlrs> Mandatory Roaming agreement parameters. See description in
section 2.3.26
Response
A “ChangeRoamingAgreement” response format is given below.
{
"status" : "<string>"
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
2.2.26 Get Roaming Agreement (GetRoamingAgreement)
This command is used to get roaming agreement.
Request
/ProfileService/GetChargingInformation
The following POST request JSON data format:
{
"vlrMask" : "<string>"
}
The request contains the following parameters:
Element/Attribute Mandatory Description
<vlrMask> Optional String. VLR mask.
Note: if this parameter is absent then the whole VLR list
will be provided
Response
A “GetChargingInformation” response format is given below.
{
"status" : "<string>",
"Vlrs" : [<RoamingAgreement>]
}
The response contains the following parameters:
Element/Attribute Mandatory Description
<status> Mandatory String. The statuses of the request are described in
section 2.2.1
<Vlrs> Mandatory Roaming agreement parameters. See description in
section 2.3.26
43. PROTEI HLR API
Page 43 of 84
2.3 Description of entries
2.3.1 ODB Parameters
A format of <odb-param> parameter of /ProfileService/ProfileControl is given below.
"odb-param" :
{
"general-list" : [<integer>],
"hplmn-list" : [<integer>],
"action" : <integer>,
"SubscriberStatus" : <integer>
}
Element/Attribute Mandatory Description
<general-list> Optional List of ODB-General-Data (0-28)
<hplmn-list> Optional List of ODB-HPLMN-Data (0-3)
<action> Optional Integer. Action status. Possible values:
• 1 ‒ activate;
• 0 ‒ deactivate
<SubscriberStatus> Mandatory Integer. Subscriber status. Possible values:
• 0 ‒ service Granted;
• 1 ‒ ODB
A format of <odb-param> parameter of /ProfileService/GetProfile is given below.
"odb-param" :
{
"subscriber-status" : <integer>,
"general" : <integer>,
"hplmn" : <integer>,
"hl-general-list" : [<integer>],
"hl-hplmn-list" : [<integer>]
}
Element/Attribute Mandatory Description
<subscriber-status> Mandatory Integer. Subscriber status (Service Granted(0) / ODB (1))
<general> Optional Integer. Call servicing is prohibited for all networks.
Binary-string in dec-format
<hplmn> Optional Integer. Call servicing is prohibited for home network.
Binary-string in dec-format
<hl-general-list> Optional The parameter determining whether general-odp
parameters are displayed as a bitmask
<hl-hplmn-list> Optional The parameters determining whether hplmn-odp
parameters are displayed as a bitmask
44. PROTEI HLR API
Page 44 of 84
2.3.2 CAMEL Parameters
A format for <csi-list> parameter is given below.
"csi-list" :
{
"type-id" : <integer>,
"profile-id" : <integer>
}
Element/Attribute Mandatory Description
<type-id> Mandatory Integer. Type of CAMEL profile. Possible values:
• 0 ‒ O-CSI;
• 1 ‒ T-CSI;
• 2 ‒ SMS-CSI;
• 3 ‒ GPRS-CSI;
• 4 ‒ M-CSI;
• 5 ‒ D-CSI;
• 6 ‒ TIF-CSI;
• 7 ‒ SS-CSI;
• 8 ‒ USSD-CSI
<profile-id> Mandatory Integer. identifier of CAMEL profile
Note: In order to delete csi parameter, <profile-id> must be unavailable (in this case FUNCTION
FN_DeleteCSI (vIMSI in varchar2, vCSI in varchar2) RETURN varchar2 is called and sendDSD is sent).
A format for <xCsi-list> parameter is given below.
"xCsi-list" :
{
"id" : <integer>,
"camelCapabilityHandling" : <integer>,
"notificationToCse" : <integer>,
"csiActive" : <integer>,
"ssNotificationToCse" : <integer>,
"ssCsiActive" : <integer>,
"csiTdps" : [<csiTdps>],
"csiCriterias" : [<csiCriterias>],
"csiMts" : [<csiMts>]
}
Element/Attribute Mandatory Description
<id> Mandatory Integer. xCsi list identifier
<camelCapabilityHandling> Optional Integer. Supported CAMEL phase
<notificationToCse> Optional Integer. Notification about changed profile
<csiActive> Optional Integer. Active csi
45. PROTEI HLR API
Page 45 of 84
Element/Attribute Mandatory Description
<ssNotificationToCse> Optional Integer. Notification about changed ssCsi profile
<ssCsiActive> Optional Integer. Active ssCsi
<csiTdps> Optional List of csiTdp
<csiCriterias> Optional List of csiCriteria
<csiMts> Optional List of csiMt
A format for <csiTdp> parameter is given below.
"csiTdp" :
{
"tdpId" : <integer>,
"serviceKey" : <integer>,
"gsmScfAddress" : "<string>",
"defaultCallHandling" : <integer>,
"csiTdpDnCriterias" : [<csiTdpDnCriterias>],
"csiTdpBsCriterias" : [<csiTdpBsCriterias>],
"csiTdpCtCriterias" : [<csiTdpCtCriterias>],
"csiTdpCvCriterias" : [<csiTdpCvCriterias>]
}
Element/Attribute Mandatory Description
<tdpId> Mandatory Integer. CsiTdp list identifier
<serviceKey> Optional Integer. The parameter is responsible for emergency
service calls
<gsmScfAddress> Optional String. IM – SSF address
<defaultCallHandling> Optional Integer. Default Call Handling
<csiTdpDnCriterias> Optional List of csiTdpDnCriteria
<csiTdpBsCriterias> Optional List of csiTdpBsCriteria
<csiTdpCtCriterias> Optional List of csiTdpCtCriteria
<csiTdpCvCriterias> Optional List of csiTdpCvCriteria
A format for <csiTdpDnCriteria> parameter is given below.
"csiTdpDnCriteria" :
{
"matchType" : <integer>,
"sciTdpDnCriteriaDns" : [<csiTdpDnCriteriaDns>],
"sciTdpDnCriteriaDnls" : [<csiTdpCriteriaDnls>]
}
46. PROTEI HLR API
Page 46 of 84
Element/Attribute Mandatory Description
<matchType> Mandatory Integer. Match type
<sciTdpDnCriteriaDns> Optional List of sciTdpDnCriteriaDns
<sciTdpDnCriteriaDnls> Optional List of sciTdpDnCriteriaDnls
A format for <csiTdpDnCriteriaDn> parameter is given below.
"csiTdpDnCriteriaDn" :
{
"destNumber" : "<string>"
}
Element/Attribute Mandatory Description
<destNumber> Mandatory String. Destination number
A format for <csiTdpDnCriteriaDnl> parameter is given below.
"csiTdpDnCriteriaDnl" :
{
"length" : <integer>
}
Element/Attribute Mandatory Description
<length> Mandatory Integer. Destination number length
A format for <csiTdpBsCriteria> parameter is given below.
"csiTdpBsCriteria" :
{
"serviceType" : <integer>,
"basicService" : <integer>
}
Element/Attribute Mandatory Description
<serviceType> Mandatory Integer. Service type
<basicService> Mandatory Integer. Service code
A format for <csiTdpCtCriteria> parameter is given below.
"csiTdpCtCriteria" :
{
"callTypeCriteria" : <integer>
}
47. PROTEI HLR API
Page 47 of 84
Element/Attribute Mandatory Description
<callTypeCriteria> Mandatory Integer. Call type
A format for <csiTdpCvCriteria> parameter is given below.
"csiTdpCtCriteria" :
{
"causeValue" : <integer>
}
Element/Attribute Mandatory Description
<causeValue> Mandatory Integer. Call rejection error from Q.850 recommendation
A format for <csiCriteria> parameter is given below.
"csiTdpCtCriteria” :
{
"dialledNumber" : "<string>",
"serviceKey" : <integer>,
"gsmScfAddress" : "<string>",
"defaultCallHandling" : <integer>,
"ssCode" : <integer>
}
Element/Attribute Mandatory Description
<dialledNumber> Optional String. Called subscriber number
<serviceKey> Optional Integer. The parameter is responsible for emergency
service calls
<gsmScfAddress> Optional String. IM-SSF address
<defaultCallHandling> Optional Integer. Default call handling
<ssCode> Optional Integer. Supplementary service code
A format for <csiMt> parameter is given below.
"csiTdpCtCriteria" :
{
"mmCode" : <integer>
}
Element/Attribute Mandatory Description
<mmCode> Mandatory Integer. Mobile event
48. PROTEI HLR API
Page 48 of 84
2.3.3 SS Parameters
A format for <ssData> parameter is given below.
"ssData" :
{
"ss_Code" : <integer>,
"ss_Status" : <integer>,
"tele_service" : [<integer>],
"bearer_service" : [<integer>],
"new_tele_service" : <integer>,
"sub_option_type" : <integer>,
"sub_option" : <integer>
}
Element/Attribute Mandatory Description
<ss_Code> Mandatory Integer. Code of supplementary service (TS 29.002
17.7.5). Possible values: 17, 18, 65, 66, 81, 245
<ss_Status> Mandatory Integer. Status of supplementary service (GSM 03.11)
<sub_option_type> Optional Integer. Service Option type. Possible values:
• 0 ‒ cliRestrictionOption;
• 1 ‒ overrideCategory
<sub_option> Optional Integer. Service option. For cliRestrictionOption:
• 0 ‒ permanent;
• 1 ‒ temporaryDefaultRestricted;
• 2 ‒ temporaryDefaultAllowed.
For overrideCategory:
• 0 ‒ overrideEnabled;
• 1 ‒ overrideDisabled
<tele_service> Optional Teleservice code (TS 29.002 17.7.9). Possible values: 0,
16, 32, 96, 112, 128, 144
<bearer_service> Optional Bearerservice code (TS 29.002 17.7.10)
<new_tele_service> Optional Integer. New teleservice code. Possible values: -1, 0, 16,
32, 96, 112, 128, 144
Note: It calls PG_HLR.FN_ChangeSS (vAPI=1, vIMSI, vSS_Code, vSS_Status, vServiceType,
vBS, vType, vSubscriptionOption, vSubscriberID out, vISD out) function in the database, after that checks
that SS_Code parameter is set (Result=success) and if ISD (ISD=1) must be sent, then the optionset will
be generated and transferred to HLR via OMI in SendISD command. The optionset is generated by
selecting from TM_PROVISIONED_SS and TM_PROVISIONED_SS_BS tables according to SubscriberID
(the procedure returns) and lUpdate = 1.
Only one tele_service value from the array which is assigned to a certain ss_Code parameter can
be replaced. The same tele_service value can be replaced for several ss_Code parameters, in this case
ss_Code parameter is not specified. If it is necessary to replace only one tele_service value it is enough to
specify one tele_service value in the array, new_tele_service parameter and one ss_Code parameter. If
ss_Code and ss_Status parameters are specified, after tele_service value replacement changeSS function
is called.
49. PROTEI HLR API
Page 49 of 84
A format for <ssForw> parameter is given below.
"ssForw” :
{
"ss_Code" : <integer>,
"ss_Status" : <integer>,
"tele_service" : <integer>,
"bearer_service" : <integer>,
"new_tele_service" : <integer>,
"forwardedToNumber" : "<string>",
"forwardSubAddress" : "<string>",
"longforwardedToNumber" : "<string>",
"forwardingOptions" : <integer>,
"noReplyConditionTime" : <integer>
}
Element/Attribute Mandatory Description
<ss_Code> Mandatory Integer. Code of supplementary service (TS 29.002
17.7.5). Possible values: 32, 33, 41-44
<ss_Status> Mandatory Integer. Status of supplementary service (GSM 03.11)
<forwardedToNumber> Optional String. Forwarding number
<forwardSubAddress> Optional String. Forwarding address
<longforwardedToNumber> Optional String. Long forwarding number
<forwardingOptions> Optional Integer. Forwarding Options (TS 29.002 7.6.3.18, 17.5
Ext-ForwOptions)
<noReplyConditionTime> Optional Boolean. Option, indicating whether the conditions for
response time are set. NoReplyConditionTime value in
seconds
<tele_service> Optional Teleservice code (TS 29.002 17.7.9). Possible values: 0,
16, 32, 96, 112, 128, 144
<bearer_service> Optional Bearerservice code (TS 29.002 17.7.10)
<new_tele_service> Optional Integer. The parameter serves for TS replacement.
Possible values: 0, 16, 32, 96, 112, 128, 144
Note: It calls RG_HLR.FN_ChangeSS (vAPI=1, vIMSI, vSS_Code, vSS_Status, vServiceType,
vBS, vFTN, vFTS, vNoReplyCT, vDefPrio, vNBR, vLongFTN, vForwOpt, vSubscriberID out, vISD out)
function, after that checks that SS_Code is set (Result=success) and if ISD (ISD=1) must be sent, then the
optionset must be generated and transferred to HLR via OMI in SendISD command. The optionset is
generated by selecting from TM_PROVISIONED_SS and TM_PROVISIONED_SS_BS tables according to
SubscriberID (the procedure returns) and lUpdate = 1.
The same tele_service value can be replaced for several ss_Code parameters, in this case
ss_Code parameter is not specified. If it is necessary to replace only one tele_service value, it is enough to
specify one tele_service value in the array, new_tele_service parameter and one ss_Code parameter. If
ss_Code and ss_Status parameters are specified, after tele_service value replacement changeSS function
is called.
50. PROTEI HLR API
Page 50 of 84
A format for <ssBarring> parameter is given below.
"ssBarring" :
{
"ss_Code" : <integer>,
"ss_Status" : <integer>,
"tele_service" : <integer>,
"bearer_service" : <integer>,
"new_tele_service" : <integer>
}
Element/Attribute Mandatory Description
<ss_Code> Mandatory Code of supplementary service (TS 29.002 17.7.5).
Possible values: 144-148, 153-155
<ss_Status> Mandatory Status of supplementary service (GSM 03.11)
<tele_service> Optional Teleservice code (TS 29.002 17.7.9). Possible values: 0,
16, 32, 96, 112, 128, 144
<bearer_service> Optional Bearerservice code (TS 29.002 17.7.10)
<new_tele_service> Optional The parameter serves for TS replacement. Possible
values: 0, 16, 32, 96, 112, 128, 144
Note: It calls RG_HLR.FN_ChangeSS (vAPI=1, vIMSI, vSS_Code, vSS_Status, vServiceType,
vBS, vType, vSubscriptionOption, vSubscriberID out, vISD out) in the database, after that checks that
SS_Code is set (Result=success) and if ISD (ISD=1) must be sent, then the optionset must be generated
and transferred to HLR via OMI in SendISD command. The optionset is generated by selecting from
TM_PROVISIONED_SS and TM_PROVISIONED_SS_BS tables according to SubscriberID (the procedure
returns) and lUpdate = 1.
The same tele_service value can be replaced for several ss_Code parameters, in this case
ss_Code parameter is not specified. If it is necessary to replace only one tele_service value it is enough to
specify one tele_service value in the array, new_tele_service parameter and one ss_Code parameter. If
ss_Code and ss_Status parameters are specified, after tele_service value replacement changeSS function
is called.
2.3.4 PDP Parameters
The format for <pdp-data> parameter of /ProfileService/ProfileControl request is given below.
"pdp-data": {
"context-id": <integer>,
"context-ids": [<integer>],
"type": "<string>",
"address": "<string>",
"delete": <Boolean>
}
Element/Attribute Mandatory Description
<context-id> Optional Integer. PDP context identifier. Context should exist in HLR
<context-ids> Optional List of PDP context identifiers
<type> Mandatory String. PDP type
51. PROTEI HLR API
Page 51 of 84
Element/Attribute Mandatory Description
<address> Optional String. PDP IP address
<delete> Optional
Boolean. Deletion of the context from subscriber's profile.
Possible values:
• True ‒ to delete a context;
• False ‒ not to delete a context
Note: At least one of the parameters (context-id or context-ids) must be available.
The format of <pdp-data> parameter of /ProfileService/GetProfile response is given below.
"pdp-data": [
{
"context-id": <integer>,
"type": "<string>",
"address": "<string>",
"qosSubscribed": "<string>",
"vplmnAddressAllowed": <integer>,
"apn": "<string>",
"extQosSubscribed": "<string>",
"pdpChargingCharacteristics": "<string>",
"extPdpAddress": "<string>",
"extPdpType": "<string>",
"ext2QosSubscribed": "<string>",
"ext3QosSubscribed": "<string>",
"ext4QosSubscribed": "<string>"
}
]
Element/Attribute Mandatory Description
<context-id> Mandatory Integer. PDP context identifier
<type> Optional String. PDP context type. Can be IPV4 – F121, IPV6 –
F157. 3GPP TS 23.060
<address> Optional String. Address of the data protocol. For dynamic
allocation it should be set to null. 3GPP TS 23.060
<vplmnAddressAllowed> Mandatory Integer. This parameter specifies whether the MS is
allowed to use a dynamic address allocated in the
VPLMN. It is defined in 3GPP TS 23.060. Possible values:
• 1 – Allowed;
• 0 – Not allowed
<apn> Mandatory String. Access Point Name
<pdpCharging
Characteristics>
Mandatory Octet string. Charging characteristics. Octets are coded
according to 3GPP TS 32.215
<qosSubscribed> Optional String. Supported quality of service. Octets are coded
according to TS 3GPP TS 24.008 Quality of Service
Octets 3-5
52. PROTEI HLR API
Page 52 of 84
Element/Attribute Mandatory Description
<extQosSubscribed> Optional Octet string. Supported quality of service. OCTET 1:
Allocation/Retention Priority (This octet encodes each
priority level defined in 23.107 as the binary value of the
priority level, declaration in 29.060).
Octets 2-9 are coded according to 3GPP TS 24.008
Quality of Service Octets 6-13
<ext2QosSubscribed> Optional Octet string. Supported quality of service (extended
value). Octets 1-3 are coded according to 3GPP TS
24.008 Quality of Service Octets 14-16.
If Quality of Service information is structured with 14 octet
length, then Octet 1 is coded according to 3GPP TS
24.008 Quality of Service Octet 14
<ext3QosSubscribed> Optional Octet string. Supported quality of service (extended
value). Octets 1-2 are coded according to 3GPP TS
24.008 Quality of Service Octets 17-18
<ext4QosSubscribed> Optional Octet string. Supported quality of service (extended
value). Octet 1:
Evolved Allocation/Retention Priority. This octet encodes
the Priority Level (PL), the Preemption Capability (PCI)
and Preemption Vulnerability (PVI) values, as described in
3GPP TS 29.060
<extPdpType> Optional String. PDP context type (extended value). Octets are
coded, similarly to PDP Type, according to TS 3GPP TS
29.060.
Only the value IPv4v6 is allowed for this parameter
<extPdpAddress> Optional String. PDP context address (extended value). This
parameter indicates an additional address of the data
protocol, and it is included if the PDP supports dual-stack
(IPv4v6).
It is an extension to PDP-Address and it is encoded in the
same way. IPv4 or IPv6 address types can be used in this
parameter but, when both parameters are present, each of
them shall contain different address types
2.3.5 EPS Parameters
A format for <epsData> parameter is given below.
"epsData": {
"ueApnOiRep":<integer>,
"ueMaxDl":<integer>,
"ueMaxUl":<integer>,
"ratType":<integer>,
"ratFreqPriorId":<integer>,
"defContextId":<integer>,
"defIpv4":"<string>",
"defIpv6":"<string>"
}
53. PROTEI HLR API
Page 53 of 84
Element/Attribute Mandatory Description
<ueApnOiRep> Optional Integer. APN OI (APN Operator Identifier) Replacement
<ueMaxDl> Optional Integer. Max Requested Bandwidth DL
<ueMaxUl> Optional Integer. Max Requested Bandwidth UL
<ratType> Optional Integer. Radio Access Technology Type:
• 1000 ‒ UTRAN;
• 1001 ‒ GERAN;
• 1004 ‒ EUTRAN
<ratFreqPriorId> Optional Integer. RAT Frequency Selection Priority Id
<defContextId> Mandatory Integer. Default EPS context identifier (default APN
configuration). Default context should be one of the
subscriber's linked EPS contexts. EPS context with wild
card APN cannot de default EPS context
<defIpv4> Optional String. Ipv4 used for assignment of default context
<defIpv6> Optional String. Ipv6 used for assignment of default context
A format for <eps-data> parameter is given below.
"eps-data": {
"delete" : <Boolean>,
"data" : {
"ueApnOiRep":"<string>",
"ueMaxDl":<integer>,
"ueMaxUl":<integer>,
"ratType":<integer>,
"ratFreqPriorId":<integer>,
"defContextId":<integer>
}
}
Element/Attribute Mandatory Description
<data> Mandatory Contents are analogue of <epsData> in “AddSubscriber”
<delete> Optional Boolean. Deletion of a parameter. Possible values:
• True ‒ to delete a parameter;
• False ‒ not to delete a parameter
A format for <link-eps-data> parameter is given below.
"link-eps-data": {
"context-id":<integer>,
"delete": <Boolean>,
"ip4": "<string>",
"ip6": "<string>"
}
54. PROTEI HLR API
Page 54 of 84
Element/Attribute Mandatory Description
<context-id> Mandatory Integer. EPS context identifier
<delete> Optional
Boolean. Deletion of a parameter. Possible values:
• True ‒ to delete a parameter;
• False ‒ not to delete a parameter
<ip4> Optional String. IP address (Version 4)
<ip6> Optional String. IP address (Version 6)
A format for <eps-context-data> parameter is given below.
"eps-context-data": [
{
"context-id": <integer>,
"serviceSelection": "<string>",
"vplmnDynamicAddressAllowed": <integer>,
"ip4": "<string>",
"ip6": "<string>",
"qosClassId": <integer>,
"allocRetPriority": <integer>,
"pdnGwType": <integer>,
"mip6ip4": "<string>",
"mip6ip6": "<string>",
"mip6AgentHost": "<string>",
"mip6AgentRealm": "<string>",
"visitedNetworkId": "<string>",
"chargingCharacteristics": "<string>",
"apnOiRep": "<string>",
"maxDl": <integer>,
"maxUl": <integer>,
"pdnType": <integer>
}
]
Element/Attribute Mandatory Description
<context-id> Mandatory Integer. EPS context identifier. The value should be
greater than zero
<serviceSelection> Mandatory String. The Service-Selection shall contain either the APN
Network Identifier (i.e. an APN without the Operator
Identifier) per 3GPP TS 23.003, clauses 9.1 & 9.1.1, or it
shall contain the wild card value per 3GPP TS 23.003,
clause 9.2.1, and 3GPP TS 23.008, clause 2.13.6).
The contents of the Service-Selection shall be formatted
as a character string composed of one or more labels
separated by dots ("."), or as the wild card APN, i.e.,
consisting of only one ASCII label, "*"
55. PROTEI HLR API
Page 55 of 84
Element/Attribute Mandatory Description
<vplmnDynamicAddress
Allowed>
Mandatory Integer. Flag that shall indicate whether for this APN, the
UE is allowed to use the PDN GW in the domain of the
HPLMN only, or additionally, the PDN GW in the domain
of the VPLMN. If value is not set, this means that the UE
is not allowed to use PDN GWs in the domain of the
VPLMN.
The following values are defined:
• NOTALLOWED (0);
• ALLOWED (1)
<ip4> Optional String. Static IPv4 address allocated to the UE
<ip6> Optional String. Static IPv6 address allocated to the UE
<qosClassId> Optional Integer. QoS Class Identifier ‒ a scalar that is used as a
reference to a specific packet forwarding behaviour (e.g.
packet loss rate, packet delay budget) to be provided to a
SDF.
Applicable values: 5 -9.
3GPP TS 23.203 Table 6.1.7.
The values allowed for EPS are only those associated to
non-GBR bearers, as indicated in 3GPP TS 23.008; e.g.,
values QCI_1, QCI_2, QCI_3 and QCI_4, which are
associated to GBR bearers, cannot be used
<allocRetPriority> Optional Integer. Allocation priority. Defined in 3GPP TS 29.212
<pdnGwType> Optional Integer. PDN GW type. Indicate whether the PDN GW
address included in MIP6-Agent-Info has been statically
allocated (i.e. provisioned in the HSS by the operator), or
dynamically selected by other nodes. The following values
are defined:
• STATIC (0);
• DYNAMIC (1)
<mip6ip4> Optional String. IPv4 address of the PDN GW
<mip6ip6> Optional String. IPv6 address of the PDN GW
<mip6AgentHost> Optional String. The host name of the PDN GW, formatted as
described in 3GPP TS 29.303, clause 4.3.2
<mip6AgentRealm> Optional String. Destination-Realm of the PDN GW formatted as:
epc.mnc<MNC>.mcc<MCC>.3gppnetwork.org,
where MNC and MCC values indicate the PLMN where
the PDN GW is located
<visitedNetworkId> Optional String. Identifies the PLMN in which the PDN GW is
located. It shall be present when the PDN GW Identity is
present and does not contain an FQDN
<chargingCharacteristics> Mandatory String. EPS PDN Connection Charging Characteristics
data: ValueControl(string). See description in section
2.3.10
56. PROTEI HLR API
Page 56 of 84
Element/Attribute Mandatory Description
<apnOiRep> Optional String. Domain name to replace the APN OI for the non-
roaming case and the home routed roaming case when
constructing the APN, and the APN-FQDN upon which to
perform a DNS resolution. See 3GPP TS 23.003 and
3GPP TS 29.303.
The contents of the APN-OI-Replacement shall be
formatted as a character string composed of one or more
labels separated by dots (".")
<maxDl> Optional Integer. Max Requested Bandwidth DL
<maxUl> Optional Integer. Max Requested Bandwidth UL
<pdnType> Optional Integer. Indicates the address type of the PDN, when it is
IP based. Possible values:
• IPv4 (0);
• IPv6 (1);
• IPv4v6 (2);
• IPv4_OR_IPv6 (3)
2.3.6 AUC Parameters
A format for <aucData> parameter is given below.
"aucData": {
"opId":<integer>,
"cId":<integer>,
"rId":<integer>,
"tkId":<integer>
"amfUmts":"<string>",
"amfLte":"<string>",
"amfIms":"<string>"
}
Element/Attribute Mandatory Description
<opId> Optional Integer. Operator key ID
<cId> Optional Integer. C parameter ID
<rId> Optional Integer. R parameter ID
<tkId> Optional Integer. Transport Key ID
<amfUmts> Optional String. Authentication Management Field for UMTS
<amfLte> Optional String. Authentication Management Field for LTE
<amfIms> Optional String. Authentication Management Field for IMS