07. Destination Group

This page contains all documentation under this Postman category.

Additional usage notes

destinationGroupId / destinationListId can be obtained via GET Destination Group (/api/GetDestinationLists).
tadigCode and categoryGroupId should be sourced from the Get network list lookup API.
Destination Groups group visited networks/operators using TADIG codes.
Destination Lists can be attached to endpoints through plans/ratezones to control where endpoints are allowed to roam.
When a Destination Group is modified by adding an operator, the child Default Roaming Profile is automatically updated with the new operator.
Before deleting a Destination Group, check plan usage with GET Query Rate Plan.
Before deleting a Destination Group, check ratezone usage with GET Ratezone.

Destination Group - Create

Path: Destination Group / Destination Group - Create

Method: POST

URL: https://sft.bics.com/api/createDestinationGroup

Description

This API will be used to Create Destination Groups. MVNE, MVNO and reseller can create destination group.

Note: Using Get network list lookup API we can fetch attached network details from Reseller/Enterprise login. This details can be used for creation of Destination Group.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
destinationGroupinfo	M	Object of the Destination Group info

Input destinationGroupinfo Parameters

Field	Optional/Mandatory	Description
destinationGroupName	M	Destination group 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
destinationGroupId	O	Destination group 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
10032	Create destination group success
10033	Create destination group failure
10044	Operator already exists in the list
10098	Failure!! destination group name already exists in the system
10057	Unexpected error occured.Please try again..!!
10042	Destination Not Attached With Account

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "destinationGroupinfo":{  
      "destinationGroupName":"NewDestinationGroup21312786313128712893712893789127893127893728912783121",
      "tadigCodeList":[  
         {  
            "categoryGroupId":"SP1903",
            "tadigCode":"INDSC"
         },
         {  
            "categoryGroupId":"SP1903",
            "tadigCode":"INDHM"
         }
       ]
   }
}

Response Examples

Create Destination Group - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10032",
            "resultDescription": "Create destination group success"
        },
        "resultCode": "0",
        "responseId": "1589306469481",
        "responseTimestamp": "12/05/2020 18:01:12",
        "destinationGroupId": "340"
    }
}

Create Destination Group - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10033",
            "resultDescription": "Create destination group failure"
        },
        "resultCode": "1",
        "responseId": "1589306497288",
        "responseTimestamp": "12/05/2020 18:01:37"
    }
}

Create Destination Group - Failure - {Failure!! destination group name already exist in the system.} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10098",
            "resultDescription": "Failure!! destination group name already exists in the system"
        },
        "resultCode": "1",
        "responseId": "1589306497288",
        "responseTimestamp": "12/05/2020 18:01:37"
    }
}

Destination Group

Path: Destination Group / Destination Group

Method: GET

URL: https://sft.bics.com/api/GetDestinationLists

Description

This API is used to fetch Destination group information like Operators, TADIG codes, IP address list, GT list, Realm etc. Destination Lists can then be attached to the endpoint to control in which visited networks they are allowed to roam.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	No

Input

Query Parameters

Field	Optional/ Mandatory	Description
destinationListId	O	Destination List Id or Destination groupID. <br>This will fetch only the information for a specific destination list.
tadigCode	O	tadigCode of the operator. <br>This will fetch all the destinationListName's and destinationListId's of the given tadigCode
destinationListOnly=TRUE	O	Will fetch all the destinationListNames and destinationListId without any information for the tadig

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
responseParam	O	Object of Destination Group details

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	It includes the Destination group parameters such as Destination List name, Destination ListID, and tadig List.

Output Rows Parameters

Field	Optional/Mandatory	Description
destinationListName	O	Name of destination list
destinationListId	O	Destination List Id or Destination groupID
tadigList	O	List of TADIGs

Output TadigList Parameters

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, Status 1 is showing that operator is barred and 0 is showing operator is unbarred
supportedNetworkTypes	O	Network types supported by the network, separated by a pipe
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
10029	Get destination list success
10030	Get destination list failure
10031	No Data Found

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Get Destination Group - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10030",
            "resultDescription": "Get destination list failure"
        },
        "resultCode": "1",
        "responseId": "1589306497288",
        "responseTimestamp": "12/05/2020 18:01:37"
    }
}

Get Destination Group - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10029",
            "resultDescription": "Get destination list success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                {
                    "tadigList": [
                        {
                            "tadigCode": "INDSC",
                            "operatorId": "8",
                            "operatorName": "Airtel india",
                            "category": "0",
                            "categoryGroupName": "IR1",
                            "categoryGroupId": "SP1903",
                            "countryName": "India",
                            "mccMnc": "40410,40495,40445",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ],
                    "destinationListName": "MVNEDEST1",
                    "destinationListId": "76"
                },
                {
                    "tadigList": [
                        {
                            "tadigCode": "INDSC",
                            "operatorId": "8",
                            "operatorName": "Airtel india",
                            "category": "0",
                            "categoryGroupName": "IR1",
                            "categoryGroupId": "SP1903",
                            "countryName": "India",
                            "mccMnc": "40410,40495,40445",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G"
                        },
                        {
                            "tadigCode": "INDHM",
                            "operatorId": "7",
                            "operatorName": "Vodafone india",
                            "category": "0",
                            "categoryGroupName": "IR1",
                            "categoryGroupId": "SP1903",
                            "countryName": "India",
                            "mccMnc": "40420,40486",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G"
                        },
                        {
                            "tadigCode": "BELTB",
                            "operatorId": "3",
                            "operatorName": "Proximus",
                            "category": "1",
                            "categoryGroupName": "OC1",
                            "categoryGroupId": "1",
                            "countryName": "Belgium",
                            "mccMnc": "20601",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ],
                    "destinationListName": "MVNEDEST2",
                    "destinationListId": "14"
                }
            ]
        },
        "responseId": "45988633192395342",
        "responseTimestamp": "05/05/2020 12:41:29"
    }
}

Destination Group - Success {TEST Destination }

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10029",
            "resultDescription": "Get destination list success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                {
                    "tadigList": [
                        {
                            "tadigCode": "BELTB",
                            "operatorId": "3",
                            "operatorName": "Proximus",
                            "category": "0",
                            "categoryGroupName": "IR1",
                            "categoryGroupId": "SP1903",
                            "countryName": "Belgium",
                            "mccMnc": "20601,206001",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G|5G"
                        }
                    ],
                    "destinationListName": "TEST - test_palnDG1",
                    "destinationListId": "2287"
                },
                {
                    "tadigList": [
                        {
                            "tadigCode": "BELTB",
                            "operatorId": "3",
                            "operatorName": "Proximus",
                            "category": "0",
                            "categoryGroupName": "IR1",
                            "categoryGroupId": "SP1903",
                            "countryName": "Belgium",
                            "mccMnc": "20601,206001",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G|5G"
                        }
                    ],
                    "destinationListName": "TEST - testplan_DG",
                    "destinationListId": "2288"
                },
                {
                    "tadigList": [
                        {
                            "tadigCode": "INDSC",
                            "operatorId": "8",
                            "operatorName": "Airtel india",
                            "category": "0",
                            "categoryGroupName": "IR1",
                            "categoryGroupId": "SP1903",
                            "countryName": "India",
                            "mccMnc": "40410,40445,40449,40495",
                            "barredUnbarredStatus": "0",
                            "supportedNetworkTypes": "2G|3G|4G|5G "
                        },
                        {
                            "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"
                        }
                    ],
                    "destinationListName": "Custom_DG",
                    "destinationListId": "2289"
                }
            ]
        },
        "responseId": "4245103012544745",
        "responseTimestamp": "26/05/2021 19:18:48"
    }
}

Destination Group-Success {destinationListId}

JSON

{
	"Response": {
		"resultParam": {
			"resultCode": "10029",
			"resultDescription": "Get destination list success"
		},
		"resultCode": "0",
		"responseParam": {
			"rows": [{
				"tadigList": [{
					"tadigCode": "UKRRS",
					"operatorId": "219",
					"operatorName": "URSBeeline",
					"category": "0",
					"categoryGroupName": "IR1",
					"categoryGroupId": "SP14073",
					"countryName": "Ukraine",
					"mccMnc": "25502",
					"barredUnbarredStatus": "0",
					"supportedNetworkTypes": "2G|3G"
				}],
				"destinationListName": "MVNEDEST76",
				"destinationListId": "7651"
			}]
		},
		"responseId": "24811687829079238",
		"responseTimestamp": "27/08/2021 18:06:19"
	}
}

Destination Group-Success {tadigCode}

JSON

{
	"Response": {
		"resultParam": {
			"resultCode": "10029",
			"resultDescription": "Get destination list success"
		},
		"resultCode": "0",
		"responseParam": {
			"rows": [

				{
					"destinationListName": "BICS_Automation_Account_utjg",
					"destinationListId": "8198"
				}
			]
		},
		"responseId": "24811728280792483",
		"responseTimestamp": "27/08/2021 18:06:59"
	}
}

Destination Group-Success {Supplier priority}

JSON

{
  "Response": {
    "resultParam": {
      "resultCode": "10029",
      "resultDescription": "Get destination list success"
    },
    "resultCode": "0",
    "responseParam": {
      "rows": [
        {
          "tadigList": [
            {
              "tadigCode": "BELTB",
              "operatorId": "3",
              "operatorName": "Proximus",
              "category": "0",
              "categoryGroupName": "IR1",
              "categoryGroupId": "SP1903",
              "countryName": "Belgium",
              "mccMnc": "20601,206001",
              "barredUnbarredStatus": "0",
              "supportedNetworkTypes": "2G|3G|4G|5G",
              "supplierPriority":"1"
            }
          ],
          "destinationListName": "TEST - test_palnDG1",
          "destinationListId": "2287"
        },
        {
          "tadigList": [
            {
              "tadigCode": "BELTB",
              "operatorId": "3",
              "operatorName": "Proximus",
              "category": "0",
              "categoryGroupName": "IR1",
              "categoryGroupId": "SP1903",
              "countryName": "Belgium",
              "mccMnc": "20601,206001",
              "barredUnbarredStatus": "0",
              "supportedNetworkTypes": "2G|3G|4G|5G",
            }
          ],
          "destinationListName": "TEST - testplan_DG",
          "destinationListId": "2288"
        },
        {
          "tadigList": [
            {
              "tadigCode": "INDSC",
              "operatorId": "8",
              "operatorName": "Airtel india",
              "category": "0",
              "categoryGroupName": "IR1",
              "categoryGroupId": "SP1903",
              "countryName": "India",
              "mccMnc": "40410,40445,40449,40495",
              "barredUnbarredStatus": "0",
              "supportedNetworkTypes": "2G|3G|4G|5G ",
              "supplierPriority":"2"
            },
            {
              "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",
              "supplierPriority":"3"
            }
          ],
          "destinationListName": "Custom_DG",
          "destinationListId": "2289"
        }
      ]
    },
    "responseId": "4245103012544745",
    "responseTimestamp": "26/05/2021 19:18:48"
  }
}

Destination Group-Success {destinationListOnly=TRUE}

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10029",
            "resultDescription": "Get destination list success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                
                {
                    "destinationListName": "BICS_Automation_Account_utjg",
                    "destinationListId": "8198"
                }
            ]
        },
        "responseId": "24811728280792483",
        "responseTimestamp": "27/08/2021 18:06:59"
    }
}

Destination Group - Modify

Path: Destination Group / Destination Group - Modify

Method: POST

URL: https://sft.bics.com/api/modifyDestinationGroup

Description

This API will be used for modifying destination group, It means adding or deleting tadig in destination group.

Note: Using Get network list lookup API we can fetch attached network details from Reseller/Enterprise login. This details can be used for Modify Destination Group.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
destinationGroupinfo	M	Object of the destination group info

Input destinationGroupinfo Parameters

Field	Optional/Mandatory	Description
destinationGroupId	M	Destination group id
addTadigCodeList	CM	List of tadig code to add in destination group <br>NOTE - If a destination group is modified by adding an oprerator then the child Default roaming profile will automatically get added with the new operator.
removeTadigCodeList	CM	List of tadig code to remove from destination group

Input addTadigCodeList Parameters

Field	Optional/Mandatory	Description
categoryGroupId	M	Category Group Id, it is a supplier id
tadigCode	M	Tadig Code

Input removeTadigCodeList 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
10034	Modify destination group success
10035	Modify destination group failure
10043	Operator cannot be removed, as single operator is present in destination group	Add one more operator to the same Destination Group and then remove the required operator
10044	Operator already exists in the list
10045	Operator already exist in the destination group

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "destinationGroupinfo":{  
      "destinationGroupId":"14",

      "removeTadigCodeList":[  
         {  
            "categoryGroupId":"SP1903",
            "tadigCode":"INDHM"
         }
      ]

   }
}

Response Examples

Modify Destination Group - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10035",
            "resultDescription": "Modify destination group failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

Modify Destination Group - Failure - {Adding operator which is already present in DG} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10045",
            "resultDescription": "Operator already exist in the destination group"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

Modify Destination Group - Success - {Remove Operator} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10034",
            "resultDescription": "Modify destination group success"
        },
        "resultCode": "0",
        "responseId": "1589306636698",
        "responseTimestamp": "12/05/2020 18:03:58"
    }
}

Modify Destination Group - Success - {Add and Remove Operators} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10034",
            "resultDescription": "Modify destination group success"
        },
        "resultCode": "0",
        "responseId": "1589307086726",
        "responseTimestamp": "12/05/2020 18:11:31"
    }
}

Modify Destination Group - Success - {Add Operator} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10034",
            "resultDescription": "Modify destination group success"
        },
        "resultCode": "0",
        "responseId": "1589306732929",
        "responseTimestamp": "12/05/2020 18:05:34"
    }
}

Destination Group - Delete

Path: Destination Group / Destination Group - Delete

Method: POST

URL: https://sft.bics.com/api/deleteDestinationGroup

Description

This API will be used to delete destination group.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
destinationGroupinfo	M	Object of the Destination Group info

Input destinationGroupinfo Parameters

Field	Optional/Mandatory	Description
destinationGroupId	M	Destination group Id

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
10036	Delete destination group success
10037	Delete destination group failure
10040	Destination group already attached with plan	Use GET Query Rate Plan to identify in which all Destination Group is used for plans or Delete the plan which is attached to the same Destination Group and then try delete Destination Group API
10041	Destination group already attached with ratezone	Use GET Ratezone API <br>to identify in which all Destination Group is used for Ratezones or Delete the ratezone which is attached to the same Destination Group and then try delete Destination Group API

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "destinationGroupinfo":{  
      "destinationGroupId":"342"
   }
}

Response Examples

Delete Destination Group - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10037",
            "resultDescription": "Delete destination group failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

Delete Destination Group - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10036",
            "resultDescription": "Delete destination group success"
        },
        "resultCode": "0",
        "responseId": "1589307197370",
        "responseTimestamp": "12/05/2020 18:13:17"
    }
}

Delete Destination Group - Failure - {Destination group already attached with plan.} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10040",
            "resultDescription": "Destination group already attached with plan"
        },
        "resultCode": "1",
        "responseId": "1590461400566",
        "responseTimestamp": "26/05/2020 02:50:00"
    }
}