.jpg)
08. Roaming Profile
This page contains all documentation under this Postman category.
Additional usage notes
-
destinationGroupId should be sourced via GET Destination Group.
-
roamingProfileId should be sourced via GET Roaming Profile.
-
Roaming Profiles define where an endpoint is allowed to roam.
-
Roaming Profiles typically reference Destination Groups and are attached to Ratezones / Plans.
-
Before deleting or modifying dependencies, check Ratezone usage with GET Ratezone.
-
Before deleting or modifying dependencies, check Plan usage with GET Query Rate Plan.
Roaming Profile - Create
Path: Roaming Profile / Roaming Profile - Create
Method: POST
URL: https://sft.bics.com/api/createRoamingProfile
Description
This API will be used to Create Roaming Profile. Enterprise can only create roaming profile and later on it will be attached with endpoint.
Note: Using Get network list lookup API we can fetch attached network details from Enterprise login. This details can be used for creation of Roaming profile.
Account Access
|
Account Type |
Access |
Comments |
|---|---|---|
|
Reseller |
No |
|
|
Enterprise |
Yes |
|
Input
Input Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
roamingProfileInfo |
M |
Object of the roaming profile info |
Input roamingProfileInfo Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
roamingProfileName |
M |
Roaming profile name |
|
tadigCodeList |
M |
List of tadig code |
Input tadigCodeList Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
categoryGroupId |
M |
Category Group Id, it is a supplier id |
|
tadigCode |
M |
Tadig Code |
Output
Output Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
Response |
M |
Object of response details |
Output Response Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Result code <br>0 – Success <br>1 – Failure |
|
responseId |
M |
Response Transaction ID |
|
responseTimestamp |
M |
Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
|
resultParam |
M |
Object of transaction result |
|
roamingProfileId |
O |
Roaming profile id |
Output ResultParam Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Status/Error Code |
|
resultDescription |
M |
Status/Error Description |
Result Codes
|
Result Codes |
Description |
Next Steps |
|---|---|---|
|
10017 |
Create roaming profile success |
|
|
10018 |
Create roaming profile failure |
|
Headers
|
Header |
Value |
|---|---|
|
|
|
|
|
|
|
|
|
Request Body
{
"roamingProfileInfo":{
"roamingProfileName":"NewRoamingprofile",
"tadigCodeList":[
{
"categoryGroupId":"SP848",
"tadigCode":"NLDPN"
},
{
"categoryGroupId":"SP848",
"tadigCode":"DEUD2"
}
]
}
}
Response Examples
Create Roaming Profile - Success — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10017",
"resultDescription": "Create roaming profile success"
},
"resultCode": "0",
"responseId": "1588686206401",
"responseTimestamp": "05/05/2020 13:43:37",
"roamingProfileId": "424"
}
}
Create Roaming Profile - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "10018",
"resultDescription": "Create roaming profile failure"
}
}
}
Roaming Profile
Path: Roaming Profile / Roaming Profile
Method: GET
URL: https://sft.bics.com/api/GetRoamingProfiles
Description
This API is used to fetch Roaming profile information like Operators, TADIG codes, IP address list, GT list, Realm etc. Roaming profiles can then be attached to the endpoints to control in which visited networks they are allowed to roam.
Account Access
|
Account Type |
Access |
Comments |
|---|---|---|
|
Reseller |
No |
|
|
Enterprise |
Yes |
|
Input
Query Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
roamingProfileId |
O |
Roaming Profile Id |
Output
Output Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
Response |
M |
Object of response details |
Output Response Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
responseId |
M |
Response Transaction ID |
|
responseTimestamp |
M |
Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
|
resultCode |
M |
Result code <br>0 – Success <br>1 – Failure |
|
resultParam |
M |
Object of transaction result |
|
responseParam |
O |
Object of transaction result. <br>Note: "responsParam" would be returned in case API response success” |
Output ResultParam Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Status/Error Code |
|
resultDescription |
M |
Status/Error Description |
Output responseParam Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
rows |
O |
Object of Roaming Profile |
Output rows Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
roamingProfileName |
O |
Name of roaming profile |
|
roamingProfileId |
O |
ID of roaming profile |
|
tadigList |
M |
List of TADIGs |
Output tadigList Parameter
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
tadigCode |
O |
TADIG Code |
|
operatorId |
O |
Id of Operator |
|
operatorName |
O |
Name of Operator |
|
category |
O |
Category, it is a supplier category <br>0 - IR <br>1 - OC <br>2 - Direct |
|
categoryGroupName |
O |
Reference to network relation |
|
categoryGroupId |
O |
Category Group ID |
|
countryName |
O |
Country Name |
|
mccMnc |
O |
MCC MNC |
|
barredUnbarredStatus |
O |
Barred Unbarred Status <br>0 - Unbarred <br>1 - barred |
|
supportedNetworkTypes |
O |
Network types supported by the network, separated by a pipe |
|
barredRATs |
M |
List of Barred Radio Access Technologies for that operator in that roaming profile. <br> <br>The possible values are {2G,3G,4G,NBIOT} |
|
supplierPriority |
O |
Determines the priority of a given network. <br>Available values being 1, 2, and 3—where 1 is the highest priority. <br> <br>Additionally, the value "B" indicates that the Network-Sponsor should be used solely as bootstrap, meaning that this sponsor should only be used to download the preferred IMSI for the country <br> <br>This parameter is applicable only to customers using NextGenSIM and has no function for those without it. |
Result Codes
|
Result Codes |
Description |
Next Steps |
|---|---|---|
|
10009 |
Get roaming profile success |
|
|
10010 |
Get roaming profile failure |
|
|
10031 |
No Data Found |
|
Headers
|
Header |
Value |
|---|---|
|
|
|
|
|
|
|
|
|
Response Examples
Get Roaming Profile - Success — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10009",
"resultDescription": "Get roaming profile success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"tadigList": [
{
"tadigCode": "BELTB",
"operatorId": "7",
"operatorName": "Proximus",
"category": "1",
"categoryGroupName": "OC1",
"categoryGroupId": "SP848",
"countryName": "Belgium",
"mccMnc": "20601",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "2G"
}
],
"roamingProfileId": "3198",
"roamingProfileName": "DEFAULT"
},
{
"tadigList": [
{
"tadigCode": "BELTB",
"operatorId": "3",
"operatorName": "Proximus",
"category": "1",
"categoryGroupName": "IR1",
"categoryGroupId": "SP848",
"countryName": "Belgium",
"mccMnc": "20601",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "_"
}
],
"roamingProfileId": "3199",
"roamingProfileName": "TEST"
}
]
},
"responseId": "97355000109057887",
"responseTimestamp": "21/01/2022 07:59:35"
}
}
Get Roaming Profile - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "10010",
"resultDescription": "Get roaming profile failure"
}
}
}
Get Roaming Profile - Failure - {Insufficient Privilege} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10002",
"resultDescription": "Insufficient privilege"
},
"resultCode": "1",
"responseId": "45991722886529405",
"responseTimestamp": "05/05/2020 13:32:59"
}
}
Get Roaming Profile - Success - {Specific} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10009",
"resultDescription": "Get roaming profile success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"tadigList": [
{
"tadigCode": "FRAF1",
"operatorId": "10",
"operatorName": "Orange",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP848",
"countryName": "France",
"mccMnc": "20802,20801",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "2G"
},
{
"tadigCode": "FRAF2",
"operatorId": "11",
"operatorName": "Societe Francaise du Radiotelephone -SFR sa",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP848",
"countryName": "France",
"mccMnc": "20809,20810,20813,20811",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "_"
}
],
"roamingProfileId": "375",
"roamingProfileName": "FranceRP"
}
]
},
"responseId": "47362432103359115",
"responseTimestamp": "21/06/2020 17:10:05"
}
}
GET Roaming Profile - Success (Test Roaming Profile)
{
"Response": {
"resultParam": {
"resultCode": "10009",
"resultDescription": "Get roaming profile success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"tadigList": [
{
"tadigCode": "INDHM",
"operatorId": "7",
"operatorName": "Vodafone india",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "India",
"mccMnc": "40446,40420,40486",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "2G"
},
{
"tadigCode": "BELTB",
"operatorId": "3",
"operatorName": "Proximus",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "Belgium",
"mccMnc": "20601,206001",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "_"
},
{
"tadigCode": "INDSC",
"operatorId": "8",
"operatorName": "Airtel india",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "India",
"mccMnc": "40410,40445,40495,40449",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "_"
}
],
"roamingProfileId": "2215",
"roamingProfileName": "DEFAULT"
},
{
"tadigList": [
{
"tadigCode": "INDSC",
"operatorId": "8",
"operatorName": "Airtel india",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "India",
"mccMnc": "40410,40445,40495,40449",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "_"
},
{
"tadigCode": "INDHM",
"operatorId": "7",
"operatorName": "Vodafone india",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "India",
"mccMnc": "40446,40420,40486",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "_"
},
{
"tadigCode": "BELTB",
"operatorId": "3",
"operatorName": "Proximus",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "Belgium",
"mccMnc": "20601,206001",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "_"
}
],
"roamingProfileId": "2216",
"roamingProfileName": "TEST"
},
{
"tadigList": [
{
"tadigCode": "INDHM",
"operatorId": "7",
"operatorName": "Vodafone india",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "India",
"mccMnc": "40446,40420,40486",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "_"
},
{
"tadigCode": "BELTB",
"operatorId": "3",
"operatorName": "Proximus",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP1903",
"countryName": "Belgium",
"mccMnc": "20601,206001",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT|LTE-M ",
"barredRATs": "2G"
}
],
"roamingProfileId": "2257",
"roamingProfileName": "Custom_Roaming_Profile"
}
]
},
"responseId": "4220523436520834",
"responseTimestamp": "26/05/2021 12:29:09"
}
}
GET Roaming Profile - Success (Supplier priority)
{
"Response": {
"resultParam": {
"resultCode": "10009",
"resultDescription": "Get roaming profile success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"tadigList": [
{
"tadigCode": "BELTB",
"operatorId": "7",
"operatorName": "Proximus",
"category": "1",
"categoryGroupName": "OC1",
"categoryGroupId": "SP848",
"countryName": "Belgium",
"mccMnc": "20601",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "2G",
"supplierPriority":"3"
}
],
"roamingProfileId": "3198",
"roamingProfileName": "DEFAULT"
},
{
"tadigList": [
{
"tadigCode": "BELTB",
"operatorId": "3",
"operatorName": "Proximus",
"category": "1",
"categoryGroupName": "IR1",
"categoryGroupId": "SP848",
"countryName": "Belgium",
"mccMnc": "20601",
"barredUnbarredStatus": "0",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "_",
"supplierPriority":"B"
}
],
"roamingProfileId": "3199",
"roamingProfileName": "TEST"
}
]
},
"responseId": "97355000109057887",
"responseTimestamp": "21/01/2022 07:59:35"
}
}
Roaming Profile - Modify
Path: Roaming Profile / Roaming Profile - Modify
Method: POST
URL: https://sft.bics.com/api/modifyRoamingProfile
Description
This API will be used for modifying roaming profile, It means adding or deleting TADIG in roaming profile.
Note: Using Get network list lookup API we can fetch attached network details from Enterprise login. This details can be used for Modify Roaming profile.
Account Access
|
Account Type |
Access |
Comments |
|---|---|---|
|
Reseller |
No |
|
|
Enterprise |
Yes |
|
Input
Input Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
roamingProfileInfo |
M |
Object of the roaming profile info |
Input roamingProfileInfo Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
roamingProfileId |
M |
Roaming profile id |
|
addTadigCodeList |
CM |
List of tadig code to add in roaming profile <br>NOTE: For OEM enabled Accounts addition of tadig code for TEST roaming profile is restricted. |
|
removeTadigCodeList |
CM |
List of tadig code to remove from roaming profile <br>NOTE: For OEM enabled Accounts deletion of tadig code for TEST roaming profile is restricted. |
Input addTadigCodeList Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
categoryGroupId |
M |
Category Group Id, it is a supplier id |
|
tadigCode |
M |
TADIG Code |
Input remove TadigCodeList Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
categoryGroupId |
M |
Category Group Id, it is a supplier id |
|
tadigCode |
M |
TADIG Code |
Output
Output Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
Response |
M |
Object of response details |
Output Response Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Result code <br>0 – Success <br>1 – Failure |
|
responseId |
M |
Response Transaction ID |
|
responseTimestamp |
M |
Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
|
resultParam |
M |
Object of transaction result |
Output ResultParam Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Status/Error Code |
|
resultDescription |
M |
Status/Error Description |
Result Codes
|
Result Codes |
Description |
Next Steps |
|---|---|---|
|
10019 |
Modify roaming profile success |
|
|
10020 |
Modify roaming profile failure |
|
|
10002 |
Insufficient privilege |
|
Headers
|
Header |
Value |
|---|---|
|
|
|
|
|
|
|
|
|
Request Body
{
"roamingProfileInfo":{
"roamingProfileId":"424",
"addTadigCodeList":[
{
"categoryGroupId":"SP848",
"tadigCode":"NLDPN"
}
],
"removeTadigCodeList":[
{
"categoryGroupId":"SP848",
"tadigCode":"ESPRT"
}
]
}
}
Response Examples
Modify Roaming Profile - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "10020",
"resultDescription": "Modify roaming profile failure"
}
}
}
Modify Roaming Profile - Failure {TEST roaming profile}
{
"Response": {
"resultParam": {
"resultCode": "10103",
"resultDescription": "Insufficient privilege"
},
"resultCode": "1",
"responseId": "1609328098757",
"responseTimestamp": "30/12/2020 11:34:58"
}
}
Modify Roaming Profile - Success — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10019",
"resultDescription": "Modify roaming profile success"
},
"resultCode": "0",
"responseId": "1588686562060",
"responseTimestamp": "05/05/2020 13:49:43"
}
}
Roaming Profile - Delete
Path: Roaming Profile / Roaming Profile - Delete
Method: POST
URL: https://sft.bics.com/api/deleteRoamingProfile
Description
This API is used to delete an existing Roaming Profile for the account.
Account Access
|
Account Type |
Access |
Comments |
|---|---|---|
|
Reseller |
No |
|
|
Enterprise |
Yes |
|
Input
Input Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
Request |
M |
Object of request details |
Input roamingProfileInfo Parameters
|
Field |
Optional/Mandatory |
Description |
|---|---|---|
|
roamingProfileId |
M |
The Id of the roaming Profile you want to delete. You can use "GETRoaming Profile " to find the value of the roamingProfileId. |
Output
Output Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
Response |
M |
Object of response details |
Output Response Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Result code <br>0 – Success <br>1 – Failure |
|
responseId |
M |
Response Transaction ID |
|
responseTimestamp |
M |
Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
|
resultParam |
M |
Object of transaction result |
Output ResultParam Parameters
|
Field |
Optional/ Mandatory |
Description |
|---|---|---|
|
resultCode |
M |
Status/Error Code |
|
resultDescription |
M |
Status/Error Description |
Result Codes
|
Result Codes |
Description |
Next Steps |
|---|---|---|
|
10127 |
Delete Roaming Profile is not allowed. Roaming profile is assigned to the following plans listed below. |
|
|
10128 |
Delete roaming profile SUCCESS |
|
|
10129 |
Delete roaming profile FAILURE |
|
Headers
|
Header |
Value |
|---|---|
|
|
|
|
|
|
|
|
|
Request Body
{
"Request":{
"roamingProfileId": "8891"
}
}
Response Examples
Delete Roaming Profile - Success — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10128",
"resultDescription": "Delete roaming profile SUCCESS"
},
"resultCode": "0",
"responseId": "8046020768876520",
"responseTimestamp": "18/05/2022 16:36:24"
}
}
Delete Roaming Profile - Failure
{
"Response": {
"resultParam": {
"resultCode": "10129",
"resultDescription": "Delete roaming profile FAILURE"
},
"resultCode": "1",
"responseId": "8046415016700862",
"responseTimestamp": "18/05/2022 16:43:01"
}
}
Delete Roaming Profile - Failure{"Delete Roaming Profile is not allowed. Roaming profile should not be assigned to any plan."} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10127",
"resultDescription": "Delete Roaming Profile is not allowed.Roaming profile is assigned to the following plans listed below."
},
"plan": [
{
"planId": "567561",
"planName": "MVNE_POSTPAID_PLAN",
"planTypeName": "Postpaid"
},
{
"planId": "567562",
"planName": "MVNE_PREPAID PLAN",
"planTypeName": "Prepaid"
}
],
"resultCode": "1",
"responseId": "8045937618808058",
"responseTimestamp": "18/05/2022 16:35:01"
}
}