09. Ratezone

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.
ratezoneId should be sourced via GET Ratezone or from the Create Ratezone response.
Ratezones define the commercial and roaming context by linking Destination Groups and Roaming Profiles.
Ratezones are referenced by Tariffs and Plans.
Before deleting a Ratezone, check Tariff usage with GET Tariff.
Before deleting a Ratezone, check Plan usage with GET Query Rate Plan.

Ratezone - Create

Path: Ratezone / Ratezone - Create

Method: POST

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

Description

This API will be used to Create Rate Zone. MVNE, MVNO, Reseller and Enterprise can create Rate Zone. Only 1 rate zone can be created per API call.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details
ratezoneDetails	M	Rate Zone Details

Input ratezoneDetails Parameters

Field	Optional/Mandatory	Description
name	M	Rate Zone Name
destGroupId	M	DestinationListId or Destination Group Id from which ratezone should be derived
Status	M	Rate Zone Status <br>1-Active <br>0-Inactive
operatorIdList	M	List of operator details

Input operatorIdList Parameters

Field	Optional/Mandatory	Description
operatorId	M	Operator Id
sponsorId	M	categoryGroupId or Sponsor 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
rateZoneId	O	Rate Zone 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
1208	Duplicate ratezone name
1209	Create ratezone success
1210	Create ratezone failure
1369	Ratezone already exists for these operators
10239	Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not.
10240	Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not.

Headers

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

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "ratezoneDetails":{  
            "name":"NewRateZone",
            "destGroupId":"14",
            "status":"1",
            "operatorIdList":[  
               {  
                  "operatorId":"8",
                  "sponsorId":"SP1903"
               }
            ]
         }
      }
   }
}

Response Examples

Create Ratezone Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "45871645620626203",
        "responseTimestamp": "04/05/2020 04:11:43",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1209",
            "resultDescription": "Create ratezone success"
        },
        "rateZoneId": "5183"
    }
}

Create RateZone Failure - {Duplicate ratezone name} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45874229406551998",
        "responseTimestamp": "04/05/2020 04:54:47",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1208",
            "resultDescription": "Duplicate ratezone name"
        }
    }
}

Create Ratezone Failure - {Ratezone already exists for these operators} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45870970688123690",
        "responseTimestamp": "04/05/2020 04:00:29",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1369",
            "resultDescription": "Ratezone already exists for these operators"
        }
    }
}

Create RateZone Failure - {Duplicate operator} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45874298512280013",
        "responseTimestamp": "04/05/2020 04:55:56",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1415",
            "resultDescription": "Duplicate operator"
        }
    }
}

Create Ratezone - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1210",
            "resultDescription": "Create ratezone failure"
        }
    }
}

Ratezone

Path: Ratezone / Ratezone

Method: GET

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

Description

This API will be used to fetch the rate zone details.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Query Parameters

Field	Optional/ Mandatory	Description
destGroupId	O	Destination Group Id
tadig	O	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
responseParam	O	Object of the Rate Zone 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
rateZoneList	O	Object of the Rate Zone

Output rateZoneList Parameters

Field	Optional/ Mandatory	Description
name	O	Rate Zone Name
id	O	ID assigned / configured in the system against each Rate Zone
status	O	Status of Rate Zone Possible Values: <br>0 – Inactive <br>1 - Active
destGroupId	O	Destination Group Id
operatorIdList	O	List of operators

Output operatorIdList Parameters

Field	Optional/ Mandatory	Description
operatorId	O	Operator Id
sponsorId	O	Sponsor Id
operatorName	O	Operator Name
categoryId	O	Category, it is a supplier category <br>0 - IR <br>1 - OC <br>2 - Direct
tadig	O	Tadig Code
sponsorName	O	Sponsor Name
countryId	O	Country Id
countryName	O	Country Name
supportedNetworkTypes	O	Network types supported by the network, separated by a pipe

Result Codes

Result Codes	Description	Next Steps
1211	Get ratezone success
1212	Get ratezone failure

Headers

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

Response Examples

Get Ratezone - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1212",
            "resultDescription": "Get ratezone failure"
        }
    }
}

Get Ratezone - Success - {Specific Destination Group}

JSON

{
    "Response": {
        "responseId": "45304110421127583",
        "responseTimestamp": "27/04/2020 02:32:48",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1211",
            "resultDescription": "Get ratezone success"
        },
        "responseParam": {
            "rateZoneList": [
                {
                    "id": "4985",
                    "name": "Ent_RZ_India",
                    "status": "1",
                    "destGroupId": "14",
                    "operatorIdList": [
                        {
                            "operatorId": "8",
                            "sponsorId": "SP1903",
                            "operatorName": "Airtel india",
                            "categoryId": "0",
                            "tadig": "INDSC",
                            "sponsorName": "IR1",
                            "countryId": "96",
                            "countryName": "India",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ]
                },
                {
                    "id": "4986",
                    "name": "Ent_RZ_Belgium",
                    "status": "1",
                    "destGroupId": "14",
                    "operatorIdList": [
                        {
                            "operatorId": "3",
                            "sponsorId": "1",
                            "operatorName": "Proximus",
                            "categoryId": "1",
                            "tadig": "BELTB",
                            "sponsorName": "OC1",
                            "countryId": "22",
                            "countryName": "Belgium",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ]
                }
            ]
        }
    }
}

Get Ratezone - Success - {Specific TADIG}

JSON

{
    "Response": {
        "responseId": "45304110421127583",
        "responseTimestamp": "27/04/2020 02:32:48",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1211",
            "resultDescription": "Get ratezone success"
        },
        "responseParam": {
            "rateZoneList": [
                {
                    "id": "4986",
                    "name": "Ent_RZ_Belgium",
                    "status": "1",
                    "destGroupId": "14",
                    "operatorIdList": [
                        {
                            "operatorId": "3",
                            "sponsorId": "1",
                            "operatorName": "Proximus",
                            "categoryId": "1",
                            "tadig": "BELTB",
                            "sponsorName": "OC1",
                            "countryId": "22",
                            "countryName": "Belgium",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ]
                }
            ]
        }
    }
}

Get Ratezone - Success - {All} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45304110421127583",
        "responseTimestamp": "27/04/2020 02:32:48",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1211",
            "resultDescription": "Get ratezone success"
        },
        "responseParam": {
            "rateZoneList": [
                {
                    "id": "4985",
                    "name": "Ent_RZ_India",
                    "status": "1",
                    "destGroupId": "14",
                    "operatorIdList": [
                        {
                            "operatorId": "8",
                            "sponsorId": "SP1903",
                            "operatorName": "Airtel india",
                            "categoryId": "0",
                            "tadig": "INDSC",
                            "sponsorName": "IR1",
                            "countryId": "96",
                            "countryName": "India",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ]
                },
                {
                    "id": "4986",
                    "name": "Ent_RZ_Belgium",
                    "status": "1",
                    "destGroupId": "14",
                    "operatorIdList": [
                        {
                            "operatorId": "3",
                            "sponsorId": "1",
                            "operatorName": "Proximus",
                            "categoryId": "1",
                            "tadig": "BELTB",
                            "sponsorName": "OC1",
                            "countryId": "22",
                            "countryName": "Belgium",
                            "supportedNetworkTypes": "2G|3G|4G"
                        }
                    ]
                }
            ]
        }
    }
}

Ratezone - Modify

Path: Ratezone / Ratezone - Modify

Method: POST

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

Description

This API will be used to Modify Rate Zone.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details
ratezoneDetails	M	Rate Zone Details

Input ratezoneDetails Parameters

Field	Optional/Mandatory	Description
Id	M	Rate Zone Id
operatorIdList	O	List of operators to be added
removeOperatorIdList	O	List of operators to be removed

Input operatorIdList Parameters

Field	Optional/Mandatory	Description
operatorId	M	Operator Id
sponsorId	M	Sponsor Id

Input removeOperatorIdList Parameters

Field	Optional/Mandatory	Description
operatorId	M	Operator Id
sponsorId	M	Sponsor 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
1224	Modify ratezone success
1225	Modify ratezone failure
8213	Invalid ratezone
8211	Ratezone already linked to rateplan tariffs
8233	Ratezone already attached with benefit
10239	Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not.
10240	Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not.

Headers

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

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "ratezoneDetails":{  
            "id":"5183",
            "operatorIdList":[  
               {  
                  "operatorId":"3",
                  "sponsorId":"1"
               }
            ]
         }
      }
   }
}

Response Examples

Modify Ratezone Success - {operatorIdList} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45987983801056212",
        "responseTimestamp": "05/05/2020 12:30:42",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1224",
            "resultDescription": "Modify ratezone success"
        }
    }
}

Modify Ratezone Success - {Remove Operator} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45989583402235349",
        "responseTimestamp": "05/05/2020 12:57:21",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1224",
            "resultDescription": "Modify ratezone success"
        }
    }
}

Modify Ratezone - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1225",
            "resultDescription": "Modify ratezone failure"
        }
    }
}

Ratezone - Delete

Path: Ratezone / Ratezone - Delete

Method: POST

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

Description

Delete Rate Zone API will be used to delete existing Rate Zone.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details

Input Request Parameters

Field	Optional/ Mandatory	Description
rateZoneId	M	Rate Zone 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
1222	Delete ratezone success
1223	Delete ratezone failure
8211	Ratezone already linked to rateplan tariffs	Delete the plan which is attached to the Ratezone and then try Service profile deletion
8213	Invalid ratezone
8233	Ratezone already attached with benefit
10239	Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not.
10240	Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not.

Headers

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

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "rateZoneId":"4985"
      }
   }
}

Response Examples

Delete Ratezone - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1223",
            "resultDescription": "Delete ratezone failure"
        }
    }
}

Delete Ratezone - Failure - {Rate zone already attached with benefit} — 200 — OK

JSON

{
    "Response": {
        "responseId": "47768624431666721",
        "responseTimestamp": "26/05/2020 03:08:02",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "8233",
            "resultDescription": "Ratezone already attached with benefit"
        }
    }
}

Delete Ratezone - Failure {Ratezone already linked to rateplan tariffs} — 200 — OK

JSON

{
    "Response": {
        "responseId": "45988835890878835",
        "responseTimestamp": "05/05/2020 12:44:54",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "8211",
            "resultDescription": "Ratezone already linked to rateplan tariffs"
        }
    }
}

Delete Ratezone - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "45988766536818744",
        "responseTimestamp": "05/05/2020 12:43:44",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1222",
            "resultDescription": "Delete ratezone success"
        }
    }
}