Service Profile [APIs]

Service Profile

This section covers APIs to create, query, modify, and delete Service Profiles.

Service Profiles define a combination of supported services (e.g., DATA, SMS, NB-IoT) and (when applicable) the RAT / access type.

POST Service Profile – Create

Create a Service Profile with a combination of existing services.

Endpoint

CODE

POST /api/CreateServiceProfile

Headers

CODE

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

Request Body

CODE

Request.requestParam.serviceProfile

Field	Mandatory	Description
name	Yes	Service Profile name
category	Yes	`0` = Base, `1` = Addon
status	Yes	`0` = Inactive, `1` = Active
service	Yes	Supported services (pipe-separated). Example: `4\|2\|3`
accessType	Cond.	RAT type. Mandatory only if one of the services is DATA / MO-SMS / MT-SMS

accessType values

01 – 2G/3G
02 – 2G
06 – 2G/3G/4G
10 – 2G/3G/4G/5G

Response (success)

Field	Description
serviceProfile	Returned Service Profile Id

Result codes (selected)

Code	Description
1323	Create service profile success
1324	Create service profile failure
6554	Duplicate service profile name
6565	Invalid child config for service profile
10111	Obsolete access type value
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

Parameter dependency

The serviceProfileId used in other APIs can be obtained from GET Service Profile.

GET Service Profile

Retrieve all Service Profiles, or a specific one.

Endpoint

CODE

GET /api/GetServiceProfile

Headers

CODE

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

Query Parameters

Parameter	Mandatory	Description
serviceProfileId	No	If provided, returns only the specified Service Profile

Response fields (selected)

Field	Description
profileId	Unique ID in the system
profileName	Service Profile name
serviceName	Supported services
ratTypeName	Returned only when DATA / MO-SMS / MT-SMS is configured
category	Service Profile category

Result codes (selected)

Code	Description
1331	Get service profile success
1328	Get service profile failure
1359	No data available

POST Service Profile – Modify

Modify an existing Service Profile.

Endpoint

CODE

POST /api/ModifyServiceProfile

Headers

CODE

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

Request Body

CODE

Request.requestParam.serviceProfile

Field	Mandatory	Description
id	Yes	Service Profile Id (e.g., `SP_343`)
name	No	Service Profile name
status	No	`0` = Inactive, `1` = Active
accessType	No	RAT type (see Create)
service	No	Service list (pipe-separated)

Notes

From reseller level, the system supports modification only to a higher RAT type if the profile is already attached to a customer.

Result codes (selected)

Code	Description
1325	Modify service profile success
1326	Modify service profile failure
6554	Duplicate service profile name
6565	Invalid child config for service profile
10085	Service profile change denied due to RAT privileges conflict
10100	Service modification not allowed for addon service
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

POST Service Profile – Delete

Delete an existing Service Profile.

Endpoint

CODE

POST /api/DeleteServiceProfile

Headers

CODE

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

Request Body

CODE

Request.requestParam.serviceProfile

Field	Mandatory	Description
id	Yes	Service Profile Id

Result codes (selected)

Code	Description
1329	Delete service profile success
1330	Delete service profile failure
1338	Service profile attached to plan (delete plan first)
10239	Operation failed (verify completion)
10240	Operation timeout (verify completion)

Cross-API parameter sourcing

serviceProfileId: obtained via GET Service Profile, and returned when creating a profile.