Ratezone [APIs]

Ratezone

Ratezones define the commercial and roaming context by linking Destination Groups and Roaming Profiles. Ratezones are then referenced by Tariffs and Plans.

POST Ratezone – Create

Endpoint

CODE

POST /api/createRatezone

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: ratezoneInfo

Field	Mandatory	Description
ratezoneName	Yes	Ratezone name
destinationGroupId	Yes	Destination group id
roamingProfileId	Yes	Roaming profile id
status	Yes	`0` = Inactive, `1` = Active

Result codes (selected)

Code	Description
1401	Create ratezone success
1402	Create ratezone failure
1403	Duplicate ratezone name
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

GET Ratezone

Endpoint

CODE

GET /api/GetRatezone

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Query parameters

Parameter	Mandatory	Description
ratezoneId	No	Fetch a specific ratezone

Response (selected)

Returned under responseParam.rows[]:

Field	Description
ratezoneId	Ratezone id
ratezoneName	Ratezone name
destinationGroupId	Linked destination group
roamingProfileId	Linked roaming profile
status	Ratezone status

Result codes (selected)

Code	Description
1404	Get ratezone success
1405	Get ratezone failure
1359	No data available

POST Ratezone – Modify

Endpoint

CODE

POST /api/modifyRatezone

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: ratezoneInfo

Field	Mandatory	Description
ratezoneId	Yes	Ratezone id
ratezoneName	No	Updated name
destinationGroupId	No	Updated destination group
roamingProfileId	No	Updated roaming profile
status	No	Updated status

Result codes (selected)

Code	Description
1406	Modify ratezone success
1407	Modify ratezone failure
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

POST Ratezone – Delete

Endpoint

CODE

POST /api/deleteRatezone

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: ratezoneInfo

Field	Mandatory	Description
ratezoneId	Yes	Ratezone id

Result codes (selected)

Code	Description	Next steps
1408	Delete ratezone success	—
1409	Delete ratezone failure	—
1410	Ratezone attached to tariff	Use GET Tariff
1411	Ratezone attached to plan	Use GET Query Rate Plan

Cross-API parameter sourcing

destinationGroupId: via GET Destination Group
roamingProfileId: via GET Roaming Profile
ratezoneId: via GET Ratezone or Create response
Dependency checks:
- Tariff usage: GET Tariff
- Plan usage: GET Query Rate Plan