Destination Group [APIs]

Destination Group

Destination Groups are used to group visited networks (operators) via TADIG codes. Destination Lists can be attached to endpoints (via plans / ratezones) to control where endpoints are allowed to roam.

Account access

Reseller: Yes
Enterprise: No

Note (from the API documentation): Use the Get network list lookup API to fetch attached network details that can be used for creating/modifying Destination Groups.

POST Destination Group – Create

Create a Destination Group.

Endpoint

CODE

POST /api/createDestinationGroup

Headers

CODE

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

Request body

Top-level object: destinationGroupinfo

Field	Mandatory	Description
destinationGroupName	Yes	Destination group name
tadigCodeList	Yes	List of networks (TADIGs)

tadigCodeList[] items:

Field	Mandatory	Description
categoryGroupId	Yes	Supplier / sponsor id
tadigCode	Yes	Operator TADIG code

Result codes (selected)

Code	Description
10032	Create destination group success
10033	Create destination group failure
10044	Operator already exists in the list
10098	Failure: destination group name already exists
10057	Unexpected error occurred, please try again
10042	Destination not attached with account

GET Destination Group

Fetch Destination Group information (operators, TADIG codes, etc.).

Endpoint

CODE

GET /api/GetDestinationLists

Headers

CODE

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

Query parameters

Parameter	Mandatory	Description
destinationListId	No	Destination List Id / Destination Group Id (fetch only that list)
tadigCode	No	Fetch destination lists for a given operator TADIG
destinationListOnly=TRUE	No	Fetch only destinationListName + destinationListId (no tadig details)

Response (selected)

Returned under responseParam.rows[]:

Field	Description
destinationListName	Destination list name
destinationListId	Destination list id / group id
tadigList	List of TADIGs

Result codes (selected)

Code	Description
10029	Get destination list success
10030	Get destination list failure
10031	No Data Found

POST Destination Group – Modify

Modify a Destination Group by adding/removing operators.

Endpoint

CODE

POST /api/modifyDestinationGroup

Headers

CODE

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

Request body

Top-level object: destinationGroupinfo

Field	Mandatory	Description
destinationGroupId	Yes	Destination group id
addTadigCodeList	Cond.	List of TADIGs to add
removeTadigCodeList	Cond.	List of TADIGs to remove

addTadigCodeList[] / removeTadigCodeList[] items:

Field	Mandatory	Description
categoryGroupId	Yes	Supplier / sponsor id
tadigCode	Yes	Operator TADIG code

Notes

If a destination group is modified by adding an operator, then the child Default Roaming Profile will automatically get updated with the new operator.

Result codes (selected)

Code	Description
10034	Modify destination group success
10035	Modify destination group failure
10043	Operator cannot be removed (single operator present)
10044	Operator already exists in the list
10045	Operator already exists in the destination group

POST Destination Group – Delete

Delete a Destination Group.

Endpoint

CODE

POST /api/deleteDestinationGroup

Headers

CODE

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

Request body

Top-level object: destinationGroupinfo

Field	Mandatory	Description
destinationGroupId	Yes	Destination group id

Result codes (selected)

Code	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 usage (or delete the plan)
10041	Destination group already attached with ratezone	Use GET Ratezone (or delete the ratezone)

Cross-API parameter sourcing

destinationGroupId / destinationListId: via GET Destination Group (/api/GetDestinationLists)
tadigCode + categoryGroupId: via Get network list lookup API (reference/lookup)
For deletion blockers:
- Plan usage: GET Query Rate Plan
- Ratezone usage: GET Ratezone