06. Service Profile

This page contains all documentation under this Postman category.

Additional usage notes

serviceProfileId can be obtained via GET Service Profile.
serviceProfileId is also returned when creating a Service Profile.
serviceProfileId is used by related APIs such as Modify/Delete Service Profile and by downstream commercial objects such as Tariff, Plan, and Endpoint.
For Create Service Profile, accessType is mandatory only if one of the services is DATA, MO-SMS, or MT-SMS.
For Modify Service Profile, from reseller level the system supports modification only to a higher RAT type if the profile is already attached to a customer.
Before deleting a Service Profile, check whether it is attached to a plan.

Service Profile - Create

Path: Service Profile / Service Profile - Create

Method: POST

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

Description

Create Service Profile API is used to create service profile with the combination of existing services.

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 Service Profile details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
serviceProfile	M	Service profile details

Input serviceProfile Parameters

Field	Optional/Mandatory	Description
name	M	Service Profile Name
category	M	Service Profile Category <br>0 – Base <br>1 - Addon
status	M	Service Profile Status <br>0 - Inactive <br>1 - Active
accessType	CM	Service Profile Access Type (RAT Type) <br>01 – 2G/3G <br>02 – 2G <br>06 - 2G/3G/4G <br>10 - 2G/3G/4G/5G <br> <br>Note: RAT type is only mandatory when one of the services DATA, MO-SMS or MT-SMS is provided. It is rejected with error message 'Obsolete access type value' when other services are provided.
service	M	Service Profile belonging to which service <br>2 – MO-SMS <br>3 – MT-SMS <br>4 – DATA <br>5 - NB-IOT <br> <br> <br>Multiple service can be selected by using pipe separation

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
serviceProfile	O	Service Profile 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
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 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":{  
         "serviceProfile":{  
            "name":"MVNE-AddOnServiceProfile",
            "category":"1",
            "status":"1",
            "accessType":"10",
            "service":"4|2|3"
         }
      }
   }
}

Response Examples

Create Service Profile - Failure - {Duplicate service profile name} — 200 — OK

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "6554",
            "resultDescription": "Duplicate service profile name"
        }
    }
}

Create Service Profile - Failure - {Invalid child config for service profile} — 200 — OK

JSON

{
    "Response": {
        "responseId": "10147764379525102309",
        "responseTimestamp": "26/05/2020 01:57:17",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "6565",
            "resultDescription": "Invalid child config for service profile"
        }
    }
}

Create Service Profile - Success - Addon Plan — 200 — OK

JSON

{
    "Response": {
        "responseId": "10138073456409416125",
        "responseTimestamp": "29/04/2020 05:48:26",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1323",
            "resultDescription": "Create service profile success"
        },
        "serviceProfile": "SP_355"
    }
}

Create Service Profile - Success - Base Plan — 200 — OK

JSON

{
    "Response": {
        "responseId": "10138073232754356404",
        "responseTimestamp": "29/04/2020 05:44:43",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1323",
            "resultDescription": "Create service profile success"
        },
        "serviceProfile": "SP_354"
    }
}

Create Service Profile - Failure — 200 — OK

JSON

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

Create Service Profile - Success - {With NB-IOT service type }

JSON

{
    "Response": {
        "responseId": "10138073232754356404",
        "responseTimestamp": "09/03/2021 05:44:43",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1323",
            "resultDescription": "Create service profile success"
        },
        "serviceProfile": "SP_554"
    }
}

Create Service Profile - Failure - {Obsolete access type value}

JSON

{
    "Response": {
        "responseId": "1018426381071250460",
        "responseTimestamp": "07/06/2021 04:09:06",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "10111",
            "resultDescription": "Obsolete access type value"
        }
    }
}

Service Profile

Path: Service Profile / Service Profile

Method: GET

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

Description

Get Service Profile API is used to get all the service profile available. If service profile id is specified in the request, response will contain only details of that specified service profile. If not specified, details of all service profile will be given in the response.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Query Parameters

Field	Optional/ Mandatory	Description
serviceProfileId	O	Service profile Id - received when service profile is created

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 Service Profile List

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Output responseParam Parameters

Field	Optional/Mandatory	Description
totalCount	O	Count of Service Profile
serviceProfileList	O	List of Service Profile Object

Output serviceProfileList Parameters

Field	Optional/Mandatory	Description
profileId	O	Profile Id, Auto generated Unique Id in the system
profileName	O	Service Profile Name
serviceName	O	Services supported by corresponding service profile <br>Multiple services are separated by '
ratTypeName	O	RAT Type Name <br>Below are the rat type names <br>2G <br>2G/3G <br>2G/3G/4G <br>2G/3G/4G/5G <br>Note:- Parameter ratTypeName will only be returned when one of the services DATA, MO-SMS or MT-SMS is configured, not when only service NB-IoT is configured.
category	O	Service Profile Category <br>0 - Base <br>1 - Addon
status	O	Service Profile Status <br>0 - Inactive <br>1 - Active

Result Codes

Result Codes	Description	Next Steps
1328	Get service profile failure
1331	Get service profile success
1359	No data available

Headers

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

Response Examples

Get Service Profile - Success - Specific Service Profile — 200 — OK

JSON

{
    "Response": {
        "responseId": "38069526535776562",
        "responseTimestamp": "29/04/2020 04:42:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1331",
            "resultDescription": "Get service profile success"
        },
        "responseParam": {
            "totalCount": "1",
            "serviceProfileList": [
                {
                    "profileId": "SP_2",
                    "profileName": "DEFAULT",
                    "status": "1",
                    "serviceName": "DATA|MO-SMS|MT-SMS",
                    "ratTypeName": "2G/3G/4G/5G",
                    "category": "0"
                }
            ]
        }
    }
}

Get Service Profile - Failure

JSON

{
    "Response": {
        "responseId": "45442500402900470",
        "responseTimestamp": "29/04/2020 04:59:18",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1328",
            "resultDescription": "Get service profile failure"
        }
    }
}

Get Service Profile - Failure - No Data Available — 200 — OK

JSON

{
    "Response": {
        "responseId": "45442500402900470",
        "responseTimestamp": "29/04/2020 04:59:18",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1359",
            "resultDescription": "No data available"
        }
    }
}

Get Service Profile - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "38066413981654128",
        "responseTimestamp": "29/04/2020 03:51:04",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1331",
            "resultDescription": "Get service profile success"
        },
        "responseParam": {
            "totalCount": "19",
            "serviceProfileList": [
                {
                    "profileId": "SP_2",
                    "profileName": "DEFAULT",
                    "status": "1",
                    "serviceName": "DATA|MO-SMS|MT-SMS",
                    "ratTypeName": "2G/3G/4G/5G",
                    "category": "0"
                },
                {
                    "profileId": "SP_352",
                    "profileName": "MVNEServiceProfile-Base",
                    "status": "1",
                    "serviceName": "DATA|MO-SMS|MT-SMS",
                    "ratTypeName": "2G/3G/4G/5G",
                    "category": "0"
                },
                {
                    "profileId": "SP_353",
                    "profileName": "MVNEServiceProfile-Addon",
                    "status": "1",
                    "serviceName": "DATA|MO-SMS|MT-SMS",
                    "ratTypeName": "2G/3G/4G",
                    "category": "1"
                }
            ]
        }
    }
}

Get Service Profile - Success - {With NB-IOT service type}

JSON

{
    "Response": {
        "responseId": "787961171566710",
        "responseTimestamp": "09/03/2021 12:51:57",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1331",
            "resultDescription": "Get service profile success"
        },
        "responseParam": {
            "totalCount": "2",
            "serviceProfileList": [
                {
                    "profileId": "SP_6274",
                    "profileName": "DEFAULT",
                    "status": "1",
                    "serviceName": "NB-IOT",
                    "category": "0"
                },
                {
                    "profileId": "SP_6288",
                    "profileName": "addonn",
                    "status": "1",
                    "serviceName": "NB-IOT",
                    "category": "1"
                }
            ]
        }
    }
}

Serivce Profile - Modify

Path: Service Profile / Serivce Profile - Modify

Method: POST

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

Description

Modify Service Profile API is used to modify existing service profile.

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 service profile details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
serviceProfile	M	Service profile details

Input serviceProfile Parameters

Field	Optional/Mandatory	Description
name	O	Service Profile Name
status	O	Service Profile Status <br>0 - Inactive <br>1 - Active
accessType	O	Service Profile Access Type (RAT Type) <br>01 - 2G/3G <br>02 - 2G <br>06 - 2G/3G/4G <br>10 - 2G/3G/4G/5G <br> <br>Note:System will support modification only to higher rat Type from Reseller level if it’s already attached to a customer
service	O	Service Profile belonging to which service <br>2 - MO-SMS <br>3 - MT-SMS <br>4 - DATA <br>5 - NB-IOT <br> <br> <br>Multiple service can be given using pipe seperation <br>Note:System will support modification, we can add/remove services from the base Service profiles <br>Add - service addition will be cascaded to the child levels and paticular service will be added in all the Defaults <br>Remove - Service removal will be cascaded to the child levels and will be removed from Defaults,Addon and Custom service profiles
id	M	Service Profile 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
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 conflicting RAT privileges assigned by (child-entity-name). Please first update the service profile(s) of (child-entity-name)
10100	Service modification not allowed for the addon - service
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":{  
         "serviceProfile":{  
            "name":"MVNE-BaseServiceProfile",
            "status":"1",
            "accessType":"06",
            "service":"3",
            "id":"SP_343"
         }
      }
   }
}

Response Examples

Modify Serivce Profile - Failure

JSON

{
    "Response": {
        "responseId": "10238085510799164831",
        "responseTimestamp": "29/04/2020 09:09:21",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1326",
            "resultDescription": "Modify service profile failure"
        }
    }
}

Modify Serivce Profile - Base Plan — 200 — OK

JSON

{
    "Response": {
        "responseId": "10238085510799164831",
        "responseTimestamp": "29/04/2020 09:09:21",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1325",
            "resultDescription": "Modify service profile success"
        }
    }
}

Modify Serivce Profile - AddOn Plan — 200 — OK

JSON

{
    "Response": {
        "responseId": "10238085657940987139",
        "responseTimestamp": "29/04/2020 09:11:48",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1325",
            "resultDescription": "Modify service profile success"
        }
    }
}

Modify Serivce Profile - Failure - {Invalid child config for service profile} — 200 — OK

JSON

{
    "Response": {
        "responseId": "10247766007138127813",
        "responseTimestamp": "26/05/2020 02:24:25",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "6565",
            "resultDescription": "Invalid child config for service profile"
        }
    }
}

Modify Serivce Profile- Base Plan - Failure - accessType Modification

JSON

{
    "Response": {
        "responseId": "1022355583667111116",
        "responseTimestamp": "08/07/2020 01:50:00",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10085",
            "resultDescription": "Service profile change denied due to conflicting RAT privileges assigned by Reseller_11. Please first update the service profile(s) of Reseller_11."
        }
    }
}

Modify Serivce Profile - Failure {Service modification not allowed for addons}

JSON

{
    "Response": {
        "responseId": "102722891455643523",
        "responseTimestamp": "08/03/2021 18:47:28",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "10100",
            "resultDescription": "Service modification not allowed for the addon - service"
        }
    }
}

Modify Serivce Profile - Success - {with NB-IOT service type }

JSON

{
    "Response": {
        "responseId": "10238085510799164831",
        "responseTimestamp": "09/03/2021 09:09:21",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1325",
            "resultDescription": "Modify service profile success"
        }
    }
}

Serivce Profile - Delete

Path: Service Profile / Serivce Profile - Delete

Method: POST

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

Description

Delete Service Profile API is used to delete existing service profile.

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 service profile details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
serviceProfile	M	Service profile details

Input serviceProfile Parameter

Field	Optional/Mandatory	Description
id	M	Service Profile 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
1329	Delete service profile success
1330	Delete service profile failure
1338	Service profile attached to plan, so deletion failure	Delete the plan which is attached to the service profile and then try Service profile deletion
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":{  
         "serviceProfile":{  
            "id":"SP_12"
         }
      }
   }
}

Response Examples

Delete Serivce Profile - Failure

JSON

{
    "Response": {
        "responseId": "10538086952840933965",
        "responseTimestamp": "29/04/2020 09:33:23",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1330",
            "resultDescription": "Delete service profile failure"
        }
    }
}

Delete Serivce Profile - Failure - {Service profile attached to plan, so deletion failure} — 200 — OK

JSON

{
    "Response": {
        "responseId": "10538087280048878609",
        "responseTimestamp": "29/04/2020 09:38:50",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "8196",
            "resultDescription": "Service profile attached to plan, so deletion failure"
        }
    }
}

Delete Serivce Profile - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "10538086952840933965",
        "responseTimestamp": "29/04/2020 09:33:23",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1329",
            "resultDescription": "Delete service profile success"
        }
    }
}