13. Organisation

This page contains all documentation under this Postman category.

Additional usage notes

organisationId should be sourced via GET Organisation.
Organisation APIs expose information about the account hierarchy, organisation details, and identifiers used across SFT.
Organisation identifiers are referenced by Enterprise APIs, Endpoint APIs, reporting, and usage queries.
Resellers can view child organisations using this API.
Enterprise users can retrieve their own organisation details.

Organization - Create

Path: Organisation / Organization - Create

Method: POST

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

Description

This API is used to create organization.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of End Point details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
name	M	Name of Organization
tierId	M	Tier Id <br>3 – RESELLER <br>4 – ENTERPRISE
customerType	M	Customer Type <br>1 – SFT <br>2 – M2MIC <br>3 – Travel SIM <br>4 -2nd SFT
userType	M	User Type <br>1 – Trial <br>2 - Commercial
subscriberType	M	Connection Type <br>0 – Prepaid <br>1 – Postpaid
currencyId	M	Currency Id, You can fetch the list of possible currencyId using "GetCurrency" API.
countryId	M	Country Id, You can fetch the list of possible countryId using "GetCountries" API.
timeZoneId	M	Time Zone Id, You can fetch the list of possible timeZoneId using "GetTimeZone" API.
email	O	Email Id
monthlyLimit	O	Monthly Limit, applicable only for postpaid customer
launchDate	O	Launch Date of organization <br>Format: dd/mm/yyyy hh:mm:ss. Note:Launch date is considered only in case of trial customers, trial customer will convert to commercial based on launch date.
rdbCode	CM	RDB Code, Mandatory if customer is commercial.The minimum number of characters required for the “rdbCode” in the POST Organization Create API is 2. if less than 2 then “The minimum number of characters required is 2" is displayed for both Commercial and Trial User Types. <br>Note-: we can create account with RDB code same as already existing account but with different country
extIdentifier	O	External Identifier for the customer
isOemEnabled	O	This parameter is used to create OEM accounts <br>true - to create OEM accounts(Reseller/Enterprise) <br>false - to create NON-OEM accounts <br>NOTE: Create organization without this parameter will create a non-OEM account

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
accountId	O	Unique ID of organization
resultParam	M	Object of transaction result
extIdentifier	O	Object of External Identifier

Output resultParam Parameters

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

Result Codes

Result Codes	Description	Next Steps
1333	Create organization success
1334	Create organization failure
1410	Duplicate RDB code- Customer Type
1390	Duplicate RDB code- Customer Type
7022	Customer is in low balance provisioning not allowed
7025	Duplicate external identifier
10082	The minimum number of characters required is 2
10234	Child reseller creation is not possible
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":{  
         "name":"MVNE_ENTERPRISE_PREPAID",
         "tierId":"4",
         "customerType":"1",
         "userType":"2",
         "subscriberType":"0",
         "currencyId":"1",
         "countryId":"2",
         "timeZoneId":"2",
         "email":"mvneemail@mail.com",
         "language":"1",
         "monthlyLimit":"1000",
         "launchDate":"11/05/2020 00:00:00",
         "rdbCode":"777771111"
      }
   }
}

Response Examples

Create Organization - Failure

JSON

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

Create Organization - Success - {Reseller Postpaid} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46479015411516550",
        "responseTimestamp": "11/05/2020 04:54:33",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1333",
            "resultDescription": "Create organization success"
        },
        "accountId": "31171007"
    }
}

Create Organization - Failure - {Duplicate RDB Code} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46479819436825836",
        "responseTimestamp": "11/05/2020 05:07:57",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1410",
            "resultDescription": "Duplicate RDB code"
        }
    }
}

Create Organization - Failure - {Customer Name Already Exists} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46481943158469294",
        "responseTimestamp": "11/05/2020 05:43:21",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1390",
            "resultDescription": "Customer name already exists"
        }
    }
}

Create Organization - Success - {Enterprise Prepaid} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46479778457423916",
        "responseTimestamp": "11/05/2020 05:07:16",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1333",
            "resultDescription": "Create organization success"
        },
        "accountId": "41171008"
    }
}

Create Organization -Failure - {RDB Code validation}

JSON

{
    "Response": {
        "responseId": "4916231221765398",
        "responseTimestamp": "23/09/2020 04:26:42",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "10082",
            "resultDescription": "The minimum number of characters required is 2"
        }
    }
}

Create Organisation - Success {OEM Enabled Enterprise}

JSON

{
"Response": {
"responseId": "46479015411516550",
"responseTimestamp": "26/05/2021 04:54:33",
"resultCode": "0",
"resultParam": {
"resultCode": "1333",
"resultDescription": "Create organization success"
},
"accountId": "41171017"
}
}

Create Organisation - Success {OEM Enabled Reseller}

JSON

{
    "Response": {
        "responseId": "46479015411516550",
        "responseTimestamp": "26/05/2021 04:54:33",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1333",
            "resultDescription": "Create organization success"
        },
        "accountId": "41171017"
    }
}

Assign APN to Account

Path: Organisation / Assign APN to Account

Method: POST

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

Description

This API is used to assign APN to an existing pre-active account.

Account Access

Account Type	Access	Comments
Reseller	Yes	Account is in pre-active state
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of APN details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
accountId	M	Account ID
attachedAPNNameList	M	List of APN Names to be attached (comma sepparated withint double quotes) <br>Example: <br>{"apn1","apn2","apn3"] <br> <br>Note: For a Reseller account user can retrieve the available APN names using the Get Account Profile API
defaultAPNName	CM	Name of the DEFAULT APN for DEFAULT APN GROUP <br> <br>Note: Available only for Enterprise accounts (tierId=4)

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
accountId	O	Unique ID of organization
resultParam	M	Object of transaction result
extIdentifier	O	Object of External Identifier

Output resultParam Parameters

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

Result Codes

Result Codes	Description	Next Steps
3005	Update endpoint/customer success
3005	Update endpoint/customer failure	Operational failure, try after sometime or kindly verify all mandatory parameters in the API request else contact the system administrator.
10208	APN already attached

Headers

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

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "accountId":"443721",
         "attachedAPNNameList":["bicsapn","IoTSIM","asia.bics"],
         "defaultAPNName":"bicsapn"
      }
   }
}

Response Examples

Assign APN to Account - Failure

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "3006",
      "resultDescription": "Update endpoint/customer failure"

 
    }
  
  }
}

Assign APN to Account - Success

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "3005",
      "resultDescription": "Update endpoint/customer success"
    },
  
  }
}

Assign Plans to Account

Path: Organisation / Assign Plans to Account

Method: POST

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

Description

This API is used to assign Plans to an existing pre-active account.

Can be used to assign Base plan and Test and Inventory plans for OEM customers.

If account is an Enterprise OEM, then a single Test & Inventory plans. can be assigned
If account is a Reseller OEM then multiple Test & Inventory plans are supported.

Account Access

Account Type	Access	Comments
Reseller	Yes	Account is in pre-active state and Before Plan assign mandatoty to Attach APN to account
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Plan details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
accountId	M	Account ID
testPlanId	CM	For reseller account (tierId=3) <br> <br>Comma separated list of test plan Ids <br> <br>Plan must match the subscriberType (prepaid/postpaid) <br> <br>For Enterprise account (tierId=4) <br> <br>Single test plan id <br> <br>Plan must match the subscriberType (prepaid/postpaid) and currency <br> <br>NOTE: Available only for OEM enable accounts
inventoryPlanId	CM	For reseller account (tierId=3) <br> <br>comma separated list list of inventory plan Ids <br> <br>Plan must match the subscriberType (prepaid/postpaid) <br> <br>For Enterprise account (tierId=4) <br> <br>Single inventory plan id <br> <br>Plan must match the subscriberType (prepaid/postpaid) and currency <br> <br>NOTE: Available only for OEM enable accounts
basePlanId	M	Single base plan id <br> <br>Plan must match the subscriberType (prepaid/postpaid) and currency
dynamicBenefitonly	O	Applicable only for Enterprises <br> <br>Values: <br>- true <br>- false <br> <br>Default If omitted is false

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
JobId	M	Unique ID generated for each Plan assign to Account. Used as input in the “Get job details” API. to check the status of the transaction

Output resultParam Parameters

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

Result Codes

Result Codes	Description	Next Steps
10054	Success!! request has sent for processing
1001	Wrong Input Parameter - {Parameter Name}
10214	Plan attach limit reached for enterprise - testPlanId/inventoryPlanId	Attach only one test and inventory PlanId
10211	APN not attached	First Attach APN, then Assign plan to Account
10212	Plan already attached

Headers

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

Request Body

JSON

{
"Request":{  
      "requestParam":{  
          "accountId":"443721",
          "testPlanId":"555,666",
          "inventoryPlanId":"888,777",
          "basePlanId":"999",
          "dynamicBenefitonly":"false"
      }
}
}

Response Examples

Assign Plans to Account - Success

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "10054",
      "resultDescription": "Success!! Request has sent for processing"
    },
    "JobId": "1032"
  }
}

Assign Plans to Account - Failure

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "1001",
      "resultDescription": "Wrong input parameter – dynamicBenefitonly"
    }
  }
}

Assign Plans to Account - Failure (Attaching multiple test and inventory Plans for Enterprise)

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "10214",
      "resultDescription": "Plan attach limit reached for enterprise - testPlanId"
    }
  }
}

Assign Users to Account

Path: Organisation / Assign Users to Account

Method: POST

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

Description

This API is used to assign the first user to an existing pre-active Account

Account Access

Account Type	Access	Comments
Reseller	Yes	Before Assign users to Account, APN and Plan should attach for the Account
Enterprise	No

Input

Input Request Parameters

Field	Optional/ Mandatory	Description
userInfo	M	Object of User details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
accountId	M	Account ID
loginUserId	M	Unique reference ID of the user used for login
email	M	The email address of the user
name	M	The name of the user <br> <br>Note: this is to identify the account and it is not used for login

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
accountId	O	Unique ID of organization
resultParam	M	Object of transaction result
extIdentifier	O	Object of External Identifier

Output resultParam Parameters

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

Result Codes

Result Codes	Description	Next Steps
11014	Assign users to account success
11016	LoginUserId already exist
11017	Plan is not attached for the account	First Attach Plan to Account
11018	User already exist
11020	Assign users to account failure	Operational failure, try after sometime or kindly verify all mandatory parameters in the API request else contact the system administrator.

Headers

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

Request Body

JSON

{
    "userInfo": {
        "accountId": "443721",
        "loginUserId": "ent1",
        "email": "abc@gmail.com",
        "name": "Test Enterprise"
    }
}

Response Examples

Assign Users to Account - Success

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "11014",
      "resultDescription": "Assign users to account success"
    }
  }
}

Assign Users to Account - Failure

JSON

{
  "Response": {
    "responseId": "298017118206010",
    "responseTimestamp": "14/06/2020 06:17:06",
    "resultCode": "0",
    "resultParam": {
      "resultCode": "11020",
      "resultDescription": "Assign users to account failure"
    }
  }
}

createCustomUser

Path: Organisation / createCustomUser

Method: POST

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

Description

This API is used to create new users under own account. It cannnot be used to create the first (default) user of the account but only for additional users. First user is created with the "Assign Users to Account" API

Account Access

Account Type	Access	Comments
Reseller	Yes	Default user must have been assigned to account
Enterprise	Yes	Default user must have been assigned to account

Input

Input Request Parameters

Field	Optional/ Mandatory	Description
userInfo	M	Object of User details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
loginUserId	M	Unique reference ID of the user used for login
email	M	The email address of the user
name	M	The name of the user <br> <br>Note: this is to identify the account and it is not used for login
roleId	M	Most common Role IDs can be found below in the table "Role IDs" <br>Full list can be retrieved from the " Privilege groups" which can be found under the Account CRM page.

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

Role IDs

Role Name	roleId
Reseller Admin User	19
Reseller_ReadOnly	1537
Enterprise_Admin	11
Enterprise_ReadOnly	9

Result Codes

Result Codes	Description	Next Steps
11029	User created successfully !
10002	Insufficient privilege
11028	Invalid Role Id
11031	From API default user can not be created"
11027	User already exists for the specified User ID
11043	User CreationLimit Reached.

Headers

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

Request Body

JSON

{
    "userInfo": {
        "accountId": "443721",
        "loginUserId": "ent1",
        "email": "abc@gmail.com",
        "name": "Test Enterprise"
    }
}

Response Examples

createCustomUser-success

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "11029",
            "resultDescription": "User created successfully !"
        },
        "resultCode": "0",
        "responseId": "4928703806841947",
        "responseTimestamp": "06/06/2024 09:45:13"
    }
}

createCustomUser-Insufficient privilege

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10002",
            "resultDescription": "Insufficient privilege"
        },
        "resultCode": "1",
        "responseId": "4934543417792123",
        "responseTimestamp": "06/06/2024 11:22:32"
    }
}

createCustomUser-Invalid Role Id

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "11028",
            "resultDescription": "Invalid Role Id"
        },
        "resultCode": "1",
        "responseId": "4934577400045396",
        "responseTimestamp": "06/06/2024 11:23:06"
    }
}

createCustomUser

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "11031",
            "resultDescription": "From API default user can not be created"
        },
        "resultCode": "1",
        "responseId": "4934857883996981",
        "responseTimestamp": "06/06/2024 11:27:46"
    }
}

createCustomUser -User already exist

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "11027",
            "resultDescription": "User already exists for the specified User ID"
        },
        "resultCode": "1",
        "responseId": "4942500390658440",
        "responseTimestamp": "06/06/2024 13:35:39"
    }
}

Bulk SIM Transfer

Path: Organisation / Bulk SIM Transfer

Method: POST

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

Description

Used for bulk transferring SIMs between accounts. Maximum number of SIMs that can be transferred in one API call is 4000.

Note: This is an ASYNC API and the process is completed asynchronously in the backend. You can verify the status of request by calling “Get bulk Job details” API.

Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	No

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of End Point details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
resourceType	M	Used for defining the type of information that will be provided under the parameter "valuelist" or "valuerange" (see below) <br>Possible values: <br>- imsi <br>- iccid <br>- msisdn <br>
valuelist	CM	List of resourceType (Max4000) <br> <br>Note: Mandatory if valueRange is not available
valueRange	CM	Range of iccid or msisdn or imsi based on the selection on the resourceType <br> <br>Note: Mandatory if valuelist is not available
accountId	M	Account id to who the SIM will be transferred
associateTestPlanId	O	Plan Id of the Test Plan <br> <br>Optional. To be used if target account is OEM
callbackResults	O	True: uses the Callback SIM Transfer URL to sent results to customer DC. <br> <br>False: don't sent results with Callback <br> <br>If ommited it is assumed as False . <br> <br>Note: To receive Bulk SIM Transfer results from the Callback API, customer has to provide Callback=True on the API and Callback process URL is correctly configured on the Callback GUI Screen.

StartFragment

INPUT `valueRange`PARAMETERS

EndFragment

Field	Optional/ Mandatory	Description
start	M	Start of the range using <br> <br>An imsi or iccid or msisdn based on the selection on the resourceType <br>
end	M	End of the range <br> <br>An imsi or iccid or msisdn based on the selection on the resourceType

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
JobId	M	Unique ID generated for each bulk modification. Used as input in the “Get bulk Job details” API. to check the status of the transaction

Output resultParam Parameters

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

Result Codes

Result Codes	Description	Next Steps
10054	Success!! request has sent for processing
10074	Failure!! Unrecognized field-resourcetype	Verify in the API request resourcetype filed is correct or not ( imsi , iccid , msisdn )
1001	Wrong Input Parameter - {Parameter Name}
10142	SIM Transfer failure - Start range or end range is not valid

Headers

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

Request Body

JSON

{
       "Request":{  
      "requestParam":{  
         "resourceType":"imsi",
         "valuelist":["206281000010297","206281000010298","206281000010299","2062810000102300"],
         "accountId":"41094429",
         "associateTestPlanId":"30115133090",
         "callbackResults":"True"
      }
   }
}

Response Examples

SIMTransfer- Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10054",
            "resultDescription": "Success !! request has sent for processing"
        },
        "resultCode": "0",
        "responseId": "5612788159500217",
        "responseTimestamp": "13/07/2022 18:23:31",
        "JobId": "30977"
    }
}

SIMTransfer - Success (with Value Range) — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10054",
            "resultDescription": "Success !! request has sent for processing"
        },
        "resultCode": "0",
        "responseId": "4249476337703202",
        "responseTimestamp": "03/08/2022 15:23:59",
        "JobId": "1884"
    }
}

SIMTransfer- Failure — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "1001",
            "resultDescription": "Wrong input parameter -associateTestPlan"
        },
        "resultCode": "1",
        "responseId": "4249926502620072",
        "responseTimestamp": "03/08/2022 15:31:26",
        "JobId": ""
    }
}

SIMTransfer - Failure (with Value Range) — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10142",
            "resultDescription": "SIM Transfer failure - Start range or end range is not valid"
        },
        "resultCode": "1",
        "responseId": "4248627419190697",
        "responseTimestamp": "03/08/2022 15:09:47",
        "JobId": ""
    }
}

ChangeCustomerPlan

Path: Organisation / ChangeCustomerPlan

Method: POST

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

Description

This API is used to change the plan for the existing customer account (Reseller/Enterprise) in BICS and Reseller level. this api can be used for the resller level but not for the enterprise.

Account Access

Account Type	Access	Comments
Reseller	Yes	plan changre for the accounts under reseller can be changed
Enterprise	No	plan changre for the the enterprise account by loging in cannot be accessable

Input

Input Request Parameters

Field	Optional/ Mandatory	Description
accountId	M	Account Id of the Reseller/Enterprise

Input requestParam Parameters

Field	Optional/ Mandatory	Description
planId	M	Plan id which needs to be changed to the respected account

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
1241	Plan change success. will be effective from next billcycle
7001	Plan change success

Headers

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

Request Body

JSON

{  
   "Request":{  
      "accountId":"41079193",
      "requestParam":{  
         "planId":"560082"
      }
   }
}

Response Examples

ChangeCustomerPlan for postpaid plan with charges success

JSON

{
    "Response": {
        "responseId": "702051391060931",
        "responseTimestamp": "14/08/2024 12:52:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7001",
            "resultDescription": "Plan change success. will be effective from next billcycle"
        }
    }
}

ChangeCustomerPlan for postpaid plan with charges success

JSON

{
    "Response": {
        "responseId": "702051391060931",
        "responseTimestamp": "14/08/2024 12:52:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7001",
            "resultDescription": "Plan change success"
        }
    }
}

ChangeCustomerPlan for prepaid plan success

JSON

{
    "Response": {
        "responseId": "702051391060931",
        "responseTimestamp": "14/08/2024 12:52:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7001",
            "resultDescription": "Plan change success"
        }
    }
}

ChangeCustomerPlan - failure

JSON

{
    "Response": {
        "responseId": "706755372378623",
        "responseTimestamp": "14/08/2024 14:11:20",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1000",
            "resultDescription": "Mandatory parameter missing - PlanId"
        }
    }
}

AccountID

Path: Organisation / AccountID

Method: GET

URL: https://sft.bics.com/api/GetAccountId?accountName=Mvnedemo&extIdentifier=101010

Description

GetAccountId API is used to fetch the Account Id based on the Account Name.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Query Parameters

Field	Optional/Mandatory	Description
accountName	CM	At least one query parameter should be present in the URI, Mandatory if extIdentifier is not used. Use "accountName=" to get a list of all accounts or “accountName=xyz” to search for account names that containing “xyz”’
extIdentifier	CM	At least one query parameter should be present in the URI, Mandatory if accountName is not used

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 Account 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
account	O	List of Account object

Output account Parameters

Field	Optional/Mandatory	Description
accountId	O	Account ID
accountName	O	Name of the account
parentAccountId	O	Parent Account ID
extIdentifier	O	Object of the External Identifier

Result Codes

Result Codes	Description	Next Steps
5110	Get account ID success
5111	Get account ID failure
1359	No data available

Headers

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

Query Parameters

Parameter	Value	Description
`accountName`	`Mvnedemo`
`extIdentifier`	`101010`

Response Examples

Get AccountID - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "38632206445177123",
        "responseTimestamp": "05/05/2020 05:00:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "5110",
            "resultDescription": "Get account ID success"
        },
        "responseParam": {
            "account": [
                {
                    "accountId": "41026931",
                    "accountName": "Mvnedemo",
                    "parentAccountId": "100000",
                    "extIdentifier": "MvnoExtidentifier"
                }
            ]
        }
    }
}

Get AccountID - Failure

JSON

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

Get AccountID - Success - {Query all Accounts}

JSON

{
    "Response": {
        "responseId": "38632206445177123",
        "responseTimestamp": "05/05/2020 05:00:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "5110",
            "resultDescription": "Get account ID success"
        },
        "responseParam": {
            "account": [
                {
                    "accountId": "41026931",
                    "accountName": "Mvnedemo1",
                    "parentAccountId": "100000",
                    "extIdentifier": "A100001"
                },
                {
                    "accountId": "41026932",
                    "accountName": "Mvnedemo2",
                    "parentAccountId": "100000",
                    "extIdentifier": "A100002"
                },
                {
                    "accountId": "41026933",
                    "accountName": "Mvnedemo3",
                    "parentAccountId": "100000",
                    "extIdentifier": "A100003"
                }
            ]
        }
    }
}

Get AccountID - Failure - {No Data Available} — 200 — OK

JSON

{
    "Response": {
        "responseId": "39104460420016882",
        "responseTimestamp": "11/05/2020 04:11:50",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1359",
            "resultDescription": "No Data Available"
        }
    }
}

Customer Profile

Path: Organisation / Customer Profile

Method: GET

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

Description

Get Customer Profile API is used to fetch the Customer details from the platform.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes	Only in case of scenario 2

Input

Query Parameters

Field	Optional/Mandatory	Description
customerId	O	Customer 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
Info	O	Object of Customer Info details

Output resultParam Parameters

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

Output info Parameters

Field	Optional/ Mandatory	Description
basicInfo	O	Object of Basic Info
benefitInfo	O	List of benefit Objects
promotionalPlans	O	List of Promotional Plans
counter	O	List of counter Objects

Output basicInfo Parameters

Field	Optional/ Mandatory	Description
maBalance	O	Main Account Balance
name	O	Name of Customer
creationDate	O	Date of Creation
currentStatus	O	Customer current status <br>A – Active <br>S – Suspend <br>PA – PreActive <br>D - Deactivate
currentStatusName	O	Customer current status Name <br>Active <br>Suspend <br>PreActive <br>Deactivate
ocExpiryDate	O	Customer Expiry Date. After OC Expiry Date system will move the Customer to the next lifecycle <br>Format: dd/mm/yyyy hh:mm:ss
planId	O	Base Plan ID
planName	O	Base Plan Name
subscriberType	O	Customer Type <br>0 - Prepaid <br>1 - Postpaid
subscriberTypeName	O	Customer Type Name <br>Prepaid <br>Postpaid
customerId	O	Customer ID. Unique ID generated for each Customer
creditLimit	O	Credit Limit of the Postpaid Customer
parentEntityId	O	Parent Entity Id. Parent Customer ID
nextBillingDate	O	Next Bill Cycle Date for the Postpaid Customer
planEffectiveDate	O	Plan Effective Date <br>Format: dd/mm/yyyy hh:mm:ss
planExpiryDate	O	Plan Expiry Date <br>Format: dd/mm/yyyy hh:mm:ss
currencyId	O	Currency Id of the customer. We can get the corresponding currency details from the API GetCurrency
currencyType	O	Type of Currency
tierId	O	Tier or Hierarchy ID refers to the customer hierarchy <br>4 - Enterprise <br>3 - Reseller
customerType	O	Customer Type <br>SFT <br>TravelSIM <br>M2MIC <br>2nd SFT
apn	O	Access Point Name, multiple apns will be ';' separated
blockService	O	Block Service Flag
destGroupId	O	Destination Group Id of the customer
customerExpiryDate	O	Expiry Date of Customer
timeZoneId	O	TimeZone Id of the customer. We can get the corresponding timeZone details from the API GetTimeZone
YCode	O	YCode
launchDate	O	Launch Date
enterpriseAccountStatus	O	Indicates the enterprise account Status <br>Enabled - Active <br>Disabled - InActive
enterpriseDataService	O	Indicates the corresponding parent's Data service status
enterpriseSMSService	O	Indicates the corresponding parent's SMS service status
enterpriseNbiotService	O	Indicates the corresponding parent's NB-IOT service status
readyForSms	O	Indicates the SMS service <br>Yes - SMS services are available <br>No - SMS services are not available
onBoardType	O	Onboard Type of the customer <br>1 – Trial <br>2 – Commmercial
dependendRatType	O	Multiple RatTypes will be pipeline "
dynamicBenefitEnable	O	Flag indicating if the “Dynamic Benefit only” option is enabled for the account to enforce linking a Dynamic Benefit before Endpoint activation.
benefits	O	Comma-separated list of pooled and non-pooled Dynamic Benefit names.
benefitIds	O	Comma-separated list of pooled and non-pooled Dynamic Benefit IDs.
testPlanName	O	Name of the Test plan (valid only for OEM enabled Accounts)
testPlanId	O	ID of the Test plan (valid only for OEM enabled Accounts)
inventoryPlanName	O	Name of the Inventory plan (valid only for OEM enabled Accounts)
inventoryPlanId	O	ID of the Inventory plan (valid only for OEM enabled Accounts)
testRoamingProfileName	O	Name of the Test Roaming profile (valid only for OEM enabled Accounts)
testRoamingProfileId	O	ID of the Test Roaming profile (valid only for OEM enabled Accounts)
rdbCode	O	RDB code (Available only if the account is directly under Admin)
countryISO3	O	ISO3 code of the country
enterpriseNbiotService	O	enterpriseNbiotService
suspensionDate	O	Suspension date and time for the suspended accounts

Output benefitInfo Parameters

Field	Optional/ Mandatory	Description
benefit	O	List of benefit associated with Customer
dynamicBenefitsDetails	O	List with details of pooled or non-pooled Dynamic Benefits associated with the assigned Base Plan.

Output benefit Parameters

Field	Optional/ Mandatory	Description
id	O	Benefit ID
name	O	Benefit Name
startDate	O	Start Date <br>Format: dd/mm/yyyy hh:mm:ss
expiryDate	O	Expiry Date <br>Format: dd/mm/yyyy hh:mm:ss
balance	O	Current available balance in least unit (bytes, cents)
unitType	O	Unit Type
type	O	Type Possible Values: <br>ADDON-ACCOUNT (MONEY) <br>ADDON-ACCOUNT (FREE) <br>Main Account
actualBalance	O	Account initial balance in least unit (bytes, cents)
rateZoneId	O	Rate Zone Id
dynamicBenefitId	O	Reference to the pooled Dynamic Benefits

Output promotionalPlans Parameters

Field	Optional/ Mandatory	Description
Plan	O	List of Add-on Plans Plans associated with the Customer

Output plan Parameters

planId	O	Add-on Plan ID
planName	O	Add-on Plan Name
planServiceId	O	Add-on Plan Service ID <br>2 - Data <br>9 - SMS <br>4 - COMBO
planServiceName	O	Add-on Plan Service Name
planDesc	O	Add-on Plan Description
planStartDate	O	Add-on Plan Start Date <br>Format:dd/mm/yyyy hh:mm:ss
planExpiryDate	O	Add-on Plan Expiry Date <br>Format:dd/mm/yyyy hh:mm:ss

OUTPUT DYNAMICBENEFITSDETAILS PARAMETERS

Field	Optional/ Mandatory	Description
level	O	Level ID of the Dynamic Benefits. <br>1 - Created by the current account within the plan. (Only possible when querying child account.) <br>2 - Created by a parent account and attached to the plan.
dynamicBenefitsId	O	ID of the Dynamic Benefits.
name	O	Name of the Dynamic Benefits.
category	O	Category ID <br>1 - Pooled <br>2 – Non-Pooled
simBenefitFee	O	Fee charged on a one-time or recurring basis for Endpoints subscribed to the Dynamic Benefits.
simActivationFee	O	Fee charged at activation for Endpoints subscribed to the Dynamic Benefits.
activatedBy	O	Action triggering the charging of the fees <br>0 - Subscription <br>1 - Usage
autoRenewal	O	Flag indicating whether the Dynamic Benefits are auto-renewed (recurring) or one-time. <br>Recurring if set to true.
factor	O	Factor multiplying the Validity. Numeric value.

validity	O	Validity <br>2 – Month <br>3 – Year
benefitList	O	Object of benefits details.
priority	O	Priority of the Dynamic Benefits as integer (smallest value = highest priority)

OUTPUT COUNTER PARAMETERS

Field	Optional/ Mandatory	Description
counterId	O	ID of the counter.
counterName	O	counter Name
usage	O	Left over Usage in MB
action	O	Action
thresholdUnit	O	Threshold unit
thresholdValue	0	Threshold value
frequency	O	Frequeycy
factor	O	Factor
resetDate	O	When the counter will be reset. Format: dd/mm/yyyy hh:mm:ss

OUTPUT BENEFITLIST PARAMETERS

Field	Optional/ Mandatory	Description
benefitId	O	ID of the benefit.
benefit	CM	Benefit type <br>1 – DATA <br>2 -NB-IOT
ratezone	O	Ratezone ID.
value	O	Amount of benefit given. Depending on the selection of the Benefit <br>DATA → “MB”.
overageTariff	O	Tariff to be charged in this Ratezone after exhaustion of the benefit. Depending on the selection of the Benefit <br>DATA → “per MB”.
priority	O	Priority of the benefit as integer (smallest value = highest priority)

Result Codes

Result Codes	Description	Next Steps
1059	Get customer profile success
1060	Get customer profile failure

Headers

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

Response Examples

Get Customer Profile - Failure

JSON

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

Get Customer Profile - Success - {Specific} — 200 — OK

JSON

{
    "Response": {
        "responseId": "39105931662589666",
        "responseTimestamp": "11/05/2020 04:36:21",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1059",
            "resultDescription": "Get customer profile success"
        },
        "info": {
            "basicInfo": {
                "maBalance": "972913.5997724533",
                "creationDate": "16/07/2019 11:17:44",
                "currentStatus": "A",
                "currentStatusName": "Active",
                "ocExpiryDate": "10/07/2020 00:00:00",
                "planId": "TRIALSGEN",
                "planName": "TRIALS_GEN",
                "subscriberType": "1",
                "subscriberTypeName": "Postpaid",
                "creditLimit": "1000000.0000",
                "customerId": "41026931",
                "parentEntityId": "100000",
                "nextBillingDate": "01/06/2020 00:00:00",
                "planEffectiveDate": "16/07/2019 11:17:44",
                "planExpiryDate": "31/12/2099 00:00:00",
                "currencyId": "44",
                "currencyType": "EUR",
                "tierId": "4",
                "customerType": "SFT",
                "destGroupId": "32",
                "apn": "abc.apn;xyz.apn;bel.apn",
                "customerExpiryDate": "10/07/2020 00:00:00",
                "onBoardType": "1",
                "timeZoneId": "295",
                "name": "MVNE DEMO",
                "enterpriseAccountStatus": "Enabled",
                "enterpriseDataService": "Active",
                "enterpriseSMSService": "Active",
                "enterpriseNbiotService": "Active",
                "readyForSms": "Yes",
                "dependendRatType": "02|01|06",
                "dynamicBenefitEnable": "true",
                "benefits": "Demo_1,Demo_2",
                "benefitIds": "582,584",
                "rdbCode": "1245",
                "countryISO3": "BEL",
                "suspensionDate": "15/08/2024 08:22:57"
            },
            "benefitInfo": {
                "benefit": [
                    {
                        "id": "PostpaidMA",
                        "name": "Postpaid Main Account",
                        "startDate": "16/07/2019 11:17:44",
                        "expiryDate": "01/06/2020 00:00:00",
                        "balance": "972913.5997724533",
                        "unitType": "MONEY",
                        "type": "Main Account",
                        "actualBalance": "1000000.0000"
                    },
                    {
                        "id": "76",
                        "name": "Demo_1",
                        "startDate": "01/05/2020 00:01:11",
                        "expiryDate": "01/06/2020 00:00:00",
                        "balance": "0",
                        "unitType": "Mb",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "0"
                    }
                ]
            }
        }
    }
}

Get Customer Profile - Success - {Own} — 200 — OK

JSON

{
    "Response": {
        "responseId": "40207525193634295",
        "responseTimestamp": "28/02/2020 14:49:43",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1059",
            "resultDescription": "Get customer profile success"
        },
        "info": {
            "basicInfo": {
                "maBalance": "57501.10",
                "creationDate": "06/11/2019 17:53:26",
                "currentStatus": "A",
                "currentStatusName": "Active",
                "ocExpiryDate": "31/12/2099 00:00:00",
                "planId": "1000000001",
                "planName": "MVNE_PLAN",
                "subscriberType": "0",
                "subscriberTypeName": "Prepaid",
                "customerId": "41047984",
                "parentEntityId": "100000",
                "planEffectiveDate": "06/11/2019 17:53:26",
                "planExpiryDate": "31/12/2099 00:00:00",
                "currencyId": "44",
                "currencyType": "EUR",
                "tierId": "4",
                "customerType": "SFT",
                "destGroupId": "768",
                "apn": "sft1;sft2;sft3",
                "customerExpiryDate": "31/12/2099 00:00:00",
                "onBoardType": "2",
                "timeZoneId": "301",
                "YCode": "Y333355",
                "name": "MVNENAME",
                "enterpriseAccountStatus": "Enabled",
                "enterpriseDataService": "Active",
                "enterpriseSMSService": "Active",
                "enterpriseNbiotService": "Active",
                "readyForSms": "Yes",
                "dependendRatType": "02|01|06",
                "dynamicBenefitEnable": "false",
                "rdbCode": "1245",
                "countryISO3": "BEL",
                "suspensionDate": "15/08/2024 08:22:57"
            },
            "promotionalPlans": {
                "plan": [
                    {
                        "planId": "zambia1",
                        "planName": "zambia",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2020-02-09 17:00:14",
                        "planExpiryDate": "2020-03-10 17:00:00"
                    },
                    {
                        "planId": "100505",
                        "planName": "MVNE100MB",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2020-02-15 14:00:19",
                        "planExpiryDate": "2020-03-16 14:00:00"
                    },
                    {
                        "planId": "africa1",
                        "planName": "africa",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2019-11-13 16:09:35",
                        "planExpiryDate": "2119-10-20 00:00:00"
                    },
                    {
                        "planId": "Rwanda1",
                        "planName": "Rwanda",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2019-12-11 16:42:47",
                        "planExpiryDate": "2119-11-17 17:00:00"
                    },
                    {
                        "planId": "Rwanda1",
                        "planName": "Rwanda",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2019-11-08 16:02:43",
                        "planExpiryDate": "2119-10-15 00:00:00"
                    },
                    {
                        "planId": "zambia1",
                        "planName": "zambia",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2020-02-11 17:19:53",
                        "planExpiryDate": "2020-03-12 18:00:00"
                    },
                    {
                        "planId": "zambia1",
                        "planName": "zambia",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2020-02-15 14:00:19",
                        "planExpiryDate": "2020-03-16 14:00:00"
                    },
                    {
                        "planId": "zambia1",
                        "planName": "zambia",
                        "planServiceId": "2",
                        "planServiceName": "DATA",
                        "planStartDate": "2020-02-11 17:18:57",
                        "planExpiryDate": "2020-03-12 18:00:00"
                    },
                    {
                        "planId": "456",
                        "planName": "MVNE_addon_prepaid",
                        "planServiceId": "4",
                        "planServiceName": "COMBO",
                        "planStartDate": "2020-02-16 18:00:18",
                        "planExpiryDate": "2020-03-17 18:00:00",
                        "planDesc": "erty"
                    }
                ]
            },
            "benefitInfo": {
                "benefit": [
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "11/02/2020 17:19:53",
                        "expiryDate": "12/03/2020 18:00:00",
                        "balance": "52428800",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "52428800",
                        "rateZoneId": "4404"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "11/02/2020 17:18:57",
                        "expiryDate": "12/03/2020 18:00:00",
                        "balance": "52428800",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "52428800",
                        "rateZoneId": "4404"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "15/02/2020 14:00:19",
                        "expiryDate": "16/03/2020 14:00:00",
                        "balance": "52428800",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "52428800",
                        "rateZoneId": "4404"
                    },
                    {
                        "id": "1991",
                        "name": "DATA",
                        "startDate": "15/02/2020 14:00:19",
                        "expiryDate": "16/03/2020 14:00:00",
                        "balance": "104857600",
                        "unitType": "Mb",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "104857600",
                        "rateZoneId": "4287"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "09/02/2020 17:00:14",
                        "expiryDate": "10/03/2020 17:00:00",
                        "balance": "52428800",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "52428800",
                        "rateZoneId": "4404"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "11/12/2019 16:42:47",
                        "expiryDate": "17/11/2119 17:00:00",
                        "balance": "1572864000",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "1572864000",
                        "rateZoneId": "4411"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "13/11/2019 16:09:35",
                        "expiryDate": "20/10/2119 00:00:00",
                        "balance": "1048576000",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "1048576000",
                        "rateZoneId": "4437"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "08/11/2019 16:02:43",
                        "expiryDate": "15/10/2119 00:00:00",
                        "balance": "1572864000",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "1572864000",
                        "rateZoneId": "4411"
                    },
                    {
                        "id": "MA",
                        "name": "Main Account",
                        "startDate": "06/11/2019 17:53:26",
                        "expiryDate": "31/12/2099 00:00:00",
                        "balance": "57501.10",
                        "unitType": "MONEY",
                        "type": "Main Account",
                        "actualBalance": "210001.1"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "06/11/2019 17:53:26",
                        "expiryDate": "31/12/2099 00:00:00",
                        "balance": "1048576000",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "1048576000",
                        "rateZoneId": "4287"
                    },
                    {
                        "id": "1992",
                        "name": "SMS",
                        "startDate": "16/02/2020 18:00:18",
                        "expiryDate": "17/03/2020 18:00:00",
                        "balance": "5",
                        "unitType": "COUNT",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "5"
                    }
                ]
            }
        }
    }
}

Customer Profile - Success {OEM enabled account}

JSON

{
    "Response": {
        "responseId": "7750085106966968",
        "responseTimestamp": "30/12/2020 13:15:19",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1059",
            "resultDescription": "Get customer profile success"
        },
        "info": {
            "basicInfo": {
                "maBalance": "UNLIMITED",
                "creationDate": "13/11/2020 09:02:06",
                "currentStatus": "A",
                "currentStatusName": "Active",
                "ocExpiryDate": "31/12/2099 00:00:00",
                "planId": "30115135212",
                "planName": "OEM_BASE_PLN",
                "subscriberType": "1",
                "subscriberTypeName": "Postpaid",
                "creditLimit": "UNLIMITED",
                "customerId": "41594755",
                "parentEntityId": "100000",
                "nextBillingDate": "01/12/2020 00:00:00",
                "planEffectiveDate": "13/11/2020 09:02:06",
                "planExpiryDate": "31/12/2099 00:00:00",
                "currencyId": "44",
                "currencyType": "EUR",
                "tierId": "4",
                "customerType": "SFT",
                "destGroupId": "7284",
                "apn": "abc.apn,xyz.apn,bel.apn",
                "customerExpiryDate": "31/12/2099 00:00:00",
                "onBoardType": "2",
                "timeZoneId": "301",
                "name": "OEM_ACCT",
                "enterpriseAccountStatus": "Enabled",
                "enterpriseDataService": "Active",
                "enterpriseSMSService": "Active",
                "enterpriseNbiotService": "Active",
                "readyForSms": "Yes",
                "dependendRatType": "02|01|06|08",
                "dynamicBenefitEnable": "false",
                "testPlanName": "OEM_TEST_PLAN",
                "testPlanId": "30115135213",
                "inventoryPlanName": "OEM_INVTRY_PLAN",
                "inventoryPlanId": "30115135214",
                "testRoamingProfileName": "OEM_TEST_RP",
                "testRoamingProfileId": "7285",
                "rdbCode": "1245",
                "countryISO3": "BEL",
                "suspensionDate": "15/08/2024 08:22:57"
            },
            "benefitInfo": {
                "benefit": [
                    {
                        "id": "PostpaidMA",
                        "name": "Postpaid Main Account",
                        "startDate": "13/11/2020 09:02:06",
                        "expiryDate": "01/12/2020 00:00:00",
                        "balance": "UNLIMITED",
                        "unitType": "MONEY",
                        "type": "Main Account",
                        "actualBalance": "UNLIMITED"
                    }
                ]
            }
        }
    }
}

Customer Profile - Success {OEM enabled account having multiple TEST and INVENTORY plans}

JSON

{
    "Response": {
        "responseId": "10342755511531416",
        "responseTimestamp": "29/06/2021 08:28:41",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1059",
            "resultDescription": "Get customer profile success"
        },
        "info": {
            "basicInfo": {
                "maBalance": "UNLIMITED",
                "creationDate": "29/06/2021 07:38:22",
                "currentStatus": "A",
                "currentStatusName": "Active",
                "ocExpiryDate": "31/12/2099 00:00:00",
                "planId": "562312",
                "planName": "New_plan",
                "subscriberType": "1",
                "subscriberTypeName": "Postpaid",
                "creditLimit": "UNLIMITED",
                "customerId": "31599712",
                "parentEntityId": "100000",
                "nextBillingDate": "01/07/2021 00:00:00",
                "planEffectiveDate": "29/06/2021 07:38:22",
                "planExpiryDate": "31/12/2099 00:00:00",
                "currencyId": "44",
                "currencyType": "EUR",
                "tierId": "3",
                "customerType": "SFT",
                "destGroupId": "2440",
                "apn": "apn",
                "customerExpiryDate": "31/12/2099 00:00:00",
                "onBoardType": "2",
                "timeZoneId": "301",
                "name": "OEM_RES_ACCT",
                "enterpriseAccountStatus": "Enabled",
                "enterpriseDataService": "Active",
                "enterpriseNbiotService": "Active",
                "enterpriseSMSService": "Active",
                "readyForSms": "Yes",
                "dependendRatType": "02|01|06",
                "dynamicBenefitEnable": "false",
                "rdbCode": "LOUHWA",
                "countryISO3": "BEL",
                "suspensionDate": "15/08/2024 08:22:57",
                "testPlanList": [
                    {
                        "testPlanName": "test_plan_1",
                        "testPlanId": "561520",
                        "testRoamingProfileName": "test_plan_DG1",
                        "testRoamingProfileId": "1770"
                    },
                    {
                        "testPlanName": "test_plan_2",
                        "testPlanId": "561522",
                        "testRoamingProfileName": "test_plan_DG2",
                        "testRoamingProfileId": "1771"
                    }
                ],
                "inventoryPlanList": [
                    {
                        "inventoryPlanName": "OEM_Inventory_1",
                        "inventoryPlanId": "30115135334"
                    },
                    {
                        "inventoryPlanName": "OEM_Inventory_1",
                        "inventoryPlanId": "562035"
                    }
                ]
            },
            "benefitInfo": {
                "benefit": [
                    {
                        "id": "PostpaidMA",
                        "name": "Postpaid Main Account",
                        "startDate": "29/06/2021 07:38:22",
                        "expiryDate": "01/07/2021 00:00:00",
                        "balance": "UNLIMITED",
                        "unitType": "MONEY",
                        "type": "Main Account",
                        "actualBalance": "UNLIMITED"
                    }
                ]
            }
        }
    }
}

Get Customer Profile - Success - {non-pooled/pooled Dynamic Benefits}

JSON

{
    "Response": {
        "responseId": "19865133355281760",
        "responseTimestamp": "17/10/2021 13:34:59",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1059",
            "resultDescription": "Get customer profile success"
        },
        "info": {
            "basicInfo": {
                "maBalance": "UNLIMITED",
                "creationDate": "12/10/2021 04:12:33",
                "currentStatus": "A",
                "currentStatusName": "Active",
                "ocExpiryDate": "31/12/2099 00:00:00",
                "planId": "571842",
                "planName": "plan_pool",
                "subscriberType": "1",
                "subscriberTypeName": "Postpaid",
                "creditLimit": "UNLIMITED",
                "customerId": "41661396",
                "parentEntityId": "31661387",
                "nextBillingDate": "01/11/2021 00:00:00",
                "planEffectiveDate": "12/10/2021 04:12:33",
                "planExpiryDate": "31/12/2099 00:00:00",
                "currencyId": "44",
                "currencyType": "EUR",
                "tierId": "4",
                "customerType": "SFT",
                "destGroupId": "15083",
                "apn": "sft1",
                "customerExpiryDate": "31/12/2099 00:00:00",
                "onBoardType": "2",
                "timeZoneId": "301",
                "name": "Enterprise_pooled",
                "enterpriseAccountStatus": "Enabled",
                "enterpriseDataService": "Active",
                "enterpriseNbiotService": "Active",
                "enterpriseSMSService": "Active",
                "readyForSms": "Yes",
                "IsNRSecondary": "true",
                "dependendRatType": "02|01|06|10",
                "dynamicBenefitEnable": "true",
                "benefits": "polled_dynamic - pooled,Non_pooled_Dynamic_benefit_Reseller - non-pooled,Non_pooled_Dynamic_benefit_Reseller1 - non-pooled,Non_pooled_Dynamic_benefit_BICS - non-pooled,Non_pooled_Dynamic_benefit_BICS1 - non-pooled,pooled- pooled",
                "benefitIds": "9233,6359,1335,1343,1329,1330",
                "countryISO3": "BEL",
                "suspensionDate": "15/08/2024 08:22:57"
            },
            "benefitInfo": {
                "benefit": [
                    {
                        "id": "PostpaidMA",
                        "name": "Postpaid Main Account",
                        "startDate": "12/10/2021 04:12:33",
                        "expiryDate": "01/11/2021 00:00:00",
                        "balance": "UNLIMITED",
                        "unitType": "MONEY",
                        "type": "Main Account",
                        "actualBalance": "UNLIMITED"
                    },
                    {
                        "id": "34296",
                        "name": "pooled",
                        "startDate": "03/08/2022 12:20:18",
                        "expiryDate": "01/09/2022 00:00:00",
                        "balance": "6291456",
                        "unitType": "Mb",
                        "type": "ADDON-ACCOUNT (FREE)",
                        "actualBalance": "6291456",
                        "dynamicBenefitId": "9233"
                    }
                ],
                "dynamicBenefitsDetails": [
                    {
                        "name": "Non_pooled_Dynamic_benefit_Reseller",
                        "category": "2",
                        "simBenefitFee": "1",
                        "simActivationFee": "1",
                        "activatedBy": "0",
                        "factor": "1",
                        "validity": "2",
                        "dynamicBenefitsId": "1335",
                        "level": "1",
                        "autoRenewal": "true",
                        "priority": "1",
                        "benefitList": [
                            {
                                "benefitId": "1335",
                                "benefit": "1",
                                "ratezone": "10807",
                                "value": "1",
                                "overageTariff": "0",
                                "priority": "1"
                            }
                        ]
                    },
                    {
                        "name": "Non_pooled_Dynamic_benefit_Reseller1",
                        "category": "2",
                        "simBenefitFee": "2",
                        "simActivationFee": "2",
                        "activatedBy": "1",
                        "factor": "1",
                        "validity": "3",
                        "dynamicBenefitsId": "1343",
                        "level": "1",
                        "autoRenewal": "false",
                        "benefitList": [
                            {
                                "benefitId": "1343",
                                "benefit": "1",
                                "ratezone": "10807",
                                "value": "2",
                                "overageTariff": "2"
                            }
                        ]
                    },
                    {
                        "name": "Non_pooled_Dynamic_benefit_BICS",
                        "category": "2",
                        "simBenefitFee": "1",
                        "simActivationFee": "1",
                        "activatedBy": "0",
                        "factor": "1",
                        "validity": "2",
                        "dynamicBenefitsId": "1329",
                        "level": "2",
                        "autoRenewal": "true",
                        "benefitList": [
                            {
                                "benefitId": "1329",
                                "benefit": "1",
                                "ratezone": "10799",
                                "value": "1",
                                "overageTariff": "0"
                            }
                        ]
                    },
                    {
                        "name": "Non_pooled_Dynamic_benefit_BICS1",
                        "category": "2",
                        "simBenefitFee": "1.5",
                        "simActivationFee": "1.5",
                        "activatedBy": "1",
                        "factor": "2",
                        "validity": "3",
                        "dynamicBenefitsId": "1330",
                        "level": "2",
                        "autoRenewal": "false",
                        "priority": "1",
                        "benefitList": [
                            {
                                "benefitId": "1330",
                                "benefit": "1",
                                "ratezone": "10799",
                                "value": "1.5",
                                "overageTariff": "1.5",
                                "priority": "1"
                            }
                        ]
                    },
                    {
                        "name": "pooled",
                        "category": "1",
                        "simBenefitFee": "2",
                        "simActivationFee": "2",
                        "activatedBy": "0",
                        "factor": "1",
                        "validity": "2",
                        "dynamicBenefitsId": "9233",
                        "level": "1",
                        "autoRenewal": "true",
                        "benefitList": [
                            {
                                "benefitId": "9233",
                                "benefit": "1",
                                "ratezone": "14323",
                                "value": "6",
                                "overageTariff": "-",
                                "priority": "1"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Get Customer Profile - Success - {Deactivated Account}

JSON

{
    "Response": {
        "responseId": "18650023537421715",
        "responseTimestamp": "09/11/2021 11:41:39",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1059",
            "resultDescription": "Get customer profile success"
        },
        "info": {
            "basicInfo": {
                "maBalance": "0",
                "creationDate": "08/04/2020 08:09:56",
                "currentStatus": "D",
                "currentStatusName": "Deactivate",
                "ocExpiryDate": "31/12/2099 00:00:00",
                "planId": "560109",
                "planName": "PLAN_001",
                "subscriberType": "1",
                "subscriberTypeName": "Postpaid",
                "creditLimit": "10000.0000",
                "customerId": "41078566",
                "parentEntityId": "31077088",
                "nextBillingDate": "01/08/2021 00:00:00",
                "planEffectiveDate": "08/04/2020 08:09:56",
                "planExpiryDate": "31/12/2099 00:00:00",
                "currencyId": "44",
                "currencyType": "EUR",
                "tierId": "4",
                "customerType": "SFT",
                "destGroupId": "298",
                "apn": "NEW_apn",
                "customerExpiryDate": "26/09/2020 00:00:00",
                "onBoardType": "2",
                "timeZoneId": "260",
                "name": "Customer1",
                "enterpriseAccountStatus": "Enabled",
                "enterpriseDataService": "Active",
                "enterpriseNbiotService": "Disabled",
                "enterpriseSMSService": "Active",
                "readyForSms": "Yes",
                "dependendRatType": "02|01|06",
                "dynamicBenefitEnable": "false",
                "countryISO3": "SGP",
                "suspensionDate": "15/08/2024 08:22:57"
            },
            "benefitInfo": {
                "benefit": [
                    {
                        "id": "2",
                        "name": "DATA",
                        "startDate": "03/04/2021 17:00:12",
                        "expiryDate": "02/04/2022 17:00:00",
                        "balance": "52428800",
                        "unitType": "Mb",
                        "type": "Main Account",
                        "actualBalance": "52428800"
                    }
                ]
            }
        }
    }
}

Job Status

Path: Organisation / Job Status

Method: GET

URL: https://sft.bics.com/api/jobstatus?id=1340

Description

This API is used the fetch the status of the job which have performed.

Account Access

Account Type	Access	Comments
Reseller	yes	only on SIM transfer
Enterprise	Yes

Input

Query Parameters

Field	Optional/ Mandatory	Description
id	M	Job ID obtained during below operations <br>1. Bulk modification of Endpoints <br>2. A2P SMS

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	API result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
responseParam	M	Object of jobid details

Output responseParam Parameters for Bulk SIM Transfer Job

These are the output Response parameteres that you will receive when fetching the status of a Bulk SIM Transfer Job that you have executed.

Field	Optional/Mandatory	Description
rows	O	List of success and failure

Output rows Parameters

Field	Optional/Mandatory	Description
successList	O	List of resources for which bulk sim transfer request was successful. Resource appearing (ICCID/MSISDN/IMSI) will depend on initial Bulk request.
failureList	O	Failure data with the reason

Output FailureList Parameters

EndFragment

Field	Optional/Mandatory	Description
data	O	List of resources for which bulkSIm transfer request failed. Resource appearing (ICCID/MSISDN/IMSI) will depend on initial Bulk request
reason	O	Reason for the failure

Output responseParam Parameters for Bulk Endpoing Modify Job

These are the output Response parameteres that you will receive when fetching the status of a Bulk Enpoint Modify Job that you have executed.

Field	Optional/Mandatory	Description
rows	O	List of success and failure

Output rows Parameters

Field	Optional/Mandatory	Description
successList	O	List of resources for which bulk request was successful. Resource appearing (ICCID/MSISDN/IMSI/EndpointID) will depend on initial Bulk request.
failureList	O	Failure data with the reason

Output FailureList Parameters

Field	Optional/Mandatory	Description
data	O	List of resources for which bulk request failed. Resource appearing (ICCID/MSISDN/IMSI/EndpointID) will depend on initial Bulk request
reason	O	Reason for the failure

Output resultParam Parameters

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

Output responseParam Parameters for A2P SMS Job

These are the output Response parameteres that you will receive when fetching the status of an A2P SMS Job that you have executed.

Field	Optional/Mandatory	Description
resourceType	M	Resource Type can be msisdn/imsi/endPointId/iccid
value	M	Value of the field to be updated based on the resourceType used in request
sourceAddr	M	Address of Entity sending SMS. This value will be made available to the recipient of a message to see what the message’s originating address was
protocolId	O	This parameter specifies the protocol identifier as per TP‑Protocol‑Identifier in 3GPP Technical Specification 23.040 and encoded as decimal
dataCoding	O	This parameter defines the encoding scheme of the short message user data. It is defined as per 3GPP Technical Specification 23.038 and encoded as decimal
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

A2P SMS responseParam Result codes

Result Codes	Description
01	enroute - The message is in enroute state
02	delivered - Message is delivered to destination
04	expired - Message validity period has expired
05	deleted - Message has been deleted
06	undeliverable - Message is undeliverable
07	accepted - Message is in accepted state
08	rejected - Message is in a rejected state

Result Codes

Result Codes	Description	Next Steps
10071	Get job details success
10072	Get job details failure
10175	Request under processing

Headers

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

Query Parameters

Parameter	Value	Description
`id`	`1340`

Response Examples

Get Job Details - Failure

JSON

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

Get Bulk Job Details - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "2399350069387684",
        "responseTimestamp": "18/06/2020 05:59:47",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10071",
            "resultDescription": "Get job details success"
        },
        "responseParam": {
            "rows": [
                {
                    "successList": [
                        "4587767676767608429",
                        "4587767676767607699",
                        "4587767676767607709",
                        "4587767676767608605",
                        "4587767676767608717",
                        "4587767676767608385",
                        "4587767676767608541",
                        "4587767676767606444"
                    ],
                    "failureList": [
                        {
                            "data": "4587767676767609001",
                            "reason": "Endpoint Already Locked - iccid"
                        }
                    ]
                }
            ]
        }
    }
}

Get Bulk -SIM Transfer Job-Success — 200 — OK

JSON

{
	"Response": {
		"responseId": "454025929850424",
		"responseTimestamp": "20/06/2022 13:27:49",
		"resultCode": "0",
		"resultParam": {
			"resultCode": "10071",
			"resultDescription": "Get job details success"
		},
		"responseParam": {
			"rows": {
				"successList": ["206281000000050", "206281000000011"],
				"failureList": [{
					"data": "206281000000002",
					"reason": "SIM is already under the target account."
				}]
			}
		}
	}
}

Job Status - A2P SMS Job - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "3806140024834973",
        "responseTimestamp": "18/09/2020 05:55:23",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10071",
            "resultDescription": "Get job details success"
        },
        "responseParam": {
            "resourceType": "msisdn",
            "value": "327700040900018",
            "sourceAddress": "123456789",
            "protocolId": "00",
            "dataCoding": "11",
            "resultCode": "01",
            "resultDescription": "enroute- The message is in enroute state"
        }
    }
}

Job Status - Bulk Update Balance Job - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "10984245188593377",
        "responseTimestamp": "27/06/2023 14:13:56",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10071",
            "resultDescription": "Get job details success"
        },
        "responseParam": {
            "rows": {
                "successList": [
                    "51967406",
                    "51949959",
                    "51949958",
                    "51967404",
                    "51967405"
                ]
            }
        }
    }
}

Job Status - Success {Add addons for Endpoint in Active-Test/Active-Inventory states}

JSON

{
    "Response": {
        "responseId": "3015671418235521",
        "responseTimestamp": "30/12/2020 10:08:11",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10071",
            "resultDescription": "Get job details success"
        },
        "responseParam": {
            "rows": {
                "failureList": [
                    {
                        "data": "999980000010023",
                        "reason": "Subscriber not in active state"
                    }
                ]
            }
        }
    }
}

Job Status - Success for Attach Plans

JSON

{
    "Response": {
        "responseId": "3015671418235521",
        "responseTimestamp": "30/12/2020 10:08:11",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10071",
            "resultDescription": "Get job details success"
        },
        "responseParam": {
            "rows": {
                "successList": [
                    "4000153"
                ]
            }
        }
    }
}

Customer Balance Info

Path: Organisation / Customer Balance Info

Method: GET

URL: https://sft.bics.com/api/GetCustomerBalanceInfo?customerId=0123456789

Description

Get Customer Balance Info APi is used to fetch your direct customers balance which will contain the following information

Current status of the customer account
Available balance amount and current

The input parameters is the "Customer ID" (also mentioned as Account ID) that you can find from portal of from "GET AccountID" API

Account Access

Account Type	Access	Comments
Reseller	yes
Enterprise	No

Input

Query Parameters

Field	Optional/ Mandatory	Description
customerId	O	Unique Parameter which returns details related to single Customer

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 Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
responseParam	O	Object of Local Supplier 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
customerInfo	O	Object of the customer info

Output customerInfo Parameters

Field	Optional/Mandatory	Description
basicInfo	O	Object of the basic info

Output basicInfo Parameters

Field	Optional/Mandatory	Description
maBalance	O	Main Balance of the account
name	O	Name of the account
creationDate	O	Date of Creation
currentStatusName	O	Account current status <br>- Active <br>- Suspend <br>- PreActive <br>- Deactivate
subscriberTypeName	O	Account Type <br>- Prepaid <br>- Postpaid
customerType	O	Customer Type
customerId	O	Customer ID. Unique ID generated for each Customer
currencyType	O	Type of Currency
tier	O	Tier refers to customer hierarchy <br>4 - Enterprise 3 - Reseller
email	O	Account Email
timeZone	O	TimeZone of the Account
YCode	O	The customer Number. A unique identifier for the customer
onBoardType	O	Onboard Type of the Account <br>1 – Trial <br>2 – Commercial
countryISO3	O	ISO3 code of the country

Result Codes

Result Codes	Description
10224	No Data found
1000	Mandatory parameter missing –{Parameter Name}
10222	Get customer Balance Info success

Headers

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

Query Parameters

Parameter	Value	Description
`customerId`	`0123456789`

Response Examples

GET Customer Balance Info - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "732516065361757",
        "responseTimestamp": "25/09/2023 07:35:07",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10222",
            "resultDescription": "Get customer Balance Info success"
        },
        "responseParam": {
            "customerInfo": [
                {
                    "basicInfo": {
                        "maBalance": "UNLIMITED",
                        "creationDate": "2023-09-25 03:52:58",
                        "currentStatusName": "Active",
                        "subscriberTypeName": "Postpaid",
                        "customerId": "0123456789",
                        "currencyType": "EUR",
                        "customerType": "M2MIC",
                        "onBoardType": "2",
                        "name": "reseller_250",
                        "countryISO3": "BEL",
                        "email": "customer@mail.com",
                        "tier": "RESELLER",
                        "timeZone": "UTC +02:00 Europe/Brussels",
                        "yCode": "450"
                    }
                }
            ]
        }
    }
}

GET Customer Balance Info - Failure — 200 — OK

JSON

{
    "Response": {
        "responseId": "735921845764672",
        "responseTimestamp": "25/09/2023 08:31:53",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1000",
            "resultDescription": "No Data Found"
        }
    }
}

Account Users

Path: Organisation / Account Users

Method: GET

URL: https://sft.bics.com/api/getAccountUsers?accountId=100000

Description

Get Account users APi is used to fetch all the users under your accounts or under specific account in your hieararchy.

Account Access

Account Type	Access	Comments
Reseller	yes
Enterprise	Yes

Input

Query Parameters

Field	Optional/ Mandatory	Description
accountId	O	Unique Parameter which returns details related to single account

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 Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
responseParam	O	Object of Local Supplier 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
User info	M	Object of the User info
Customer info	M	Object of the customer info

Output customerInfo Parameters

Field	Optional/Mandatory	Description
CustomerInfo	M	Object of the customer info
User Info	M	Object of the User info

Output Customer info Parameters

Field	Optional/Mandatory	Description
loginUserId	M	login Id of the User
email	M	email configured for the specific user
name	M	Name of the user
Status	M	User current status <br>1 - block <br>0 - unblock
roleName	M	rolename of the user
roleId	M	Role Id of the user

Output Customer info Parameters

Field	Optional/Mandatory	Description
AccountId	M	Unique Id of the Account (Reseller/Enterprise)
accountName	M	Name of the Account (Reseller/Enterprise)
parentAccountId	M	Id of Parent account <br>of the specific account
currentStatus	M	Current status of the account A - Active <br>S - Suspend <br>D - Deactive <br>PA - Preactive
subscriberType	M	Connection Type <br>0 -Prepaid <br>1 - Postpaid
currentStatusName	M	Current status name of the account
subscriberTypeName	M	Connection Type name of the account
Tier Id	M	Tier or Hierarchy ID refers to the customer hierarchy <br>1 - BICS Account <br>3 - Reseller <br>4 - Enterprise
customerNumber <br>(YCode)	O	YCode
onBoardType	M	Onboard Type of the customer <br>1 – Trial <br>2 – Commmercial
rdbCode	O	RDB code (Available only if the account is directly under Admin)

Result Codes

Result Codes	Description
10224	No Data found
1000	Mandatory parameter missing –{Parameter Name}
11037	Get Account Users Success
11038	Get Account Users failure

Headers

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

Query Parameters

Parameter	Value	Description
`accountId`	`100000`

Response Examples

Account Users - sucess — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "11037",
            "resultDescription": "Get Account Users success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                {
                    "customerInfo": {
                        "userInfo": [
                            {
                                "loginUserId": "login_5251_ent9",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent9",
                                "status": "0",
                                "roleName": "hcbs_newadminhcbsent_admin",
                                "roleId": "5715"
                            },
                            {
                                "loginUserId": "login_5251_ent4",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent4",
                                "status": "0",
                                "roleName": "dkEnterprise_ReadOnly",
                                "roleId": "3813"
                            },
                            {
                                "loginUserId": "extra_login",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_extra",
                                "status": "0",
                                "roleName": "hcbs_newadminhcbsent_admin",
                                "roleId": "5715"
                            },
                            {
                                "loginUserId": "login_ent_1",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_ent_1",
                                "status": "0",
                                "roleName": "USAFLEETILLA_BICS_ADMINEnterprise Admin",
                                "roleId": "3713"
                            },
                            {
                                "loginUserId": "login_5251_ent7",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent7",
                                "status": "0",
                                "roleName": "ent_user_4RegRole",
                                "roleId": "6739"
                            },
                            {
                                "loginUserId": "login_5251_ent2",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent2",
                                "status": "0",
                                "roleName": "EP1_BICS_Support2Enterprise Admin to view SIM page",
                                "roleId": "4701"
                            },
                            {
                                "loginUserId": "login_5251_ent3",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent3",
                                "status": "0",
                                "roleName": "HKGHWDEV_PSD_ADMINEnterprise_Admin",
                                "roleId": "3763"
                            },
                            {
                                "loginUserId": "login_5251_ent8",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent8",
                                "status": "0",
                                "roleName": "EP1_BICS_Support2Enterprise Admin to view SIM page",
                                "roleId": "4701"
                            },
                            {
                                "loginUserId": "login_api_check_2",
                                "email": "niharika.manohar@gmail.com",
                                "name": "user_api_check_2",
                                "status": "0",
                                "roleName": "Enterprise1Account_1389",
                                "roleId": "9811"
                            },
                            {
                                "loginUserId": "login_5251_ent5",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent5",
                                "status": "0",
                                "roleName": "dkEnterprise_ReadOnly",
                                "roleId": "3813"
                            },
                            {
                                "loginUserId": "login_5251_ent6",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent6",
                                "status": "0",
                                "roleName": "hcbs_newadminhcbsent_admin",
                                "roleId": "5715"
                            },
                            {
                                "loginUserId": "login_5251_ent10",
                                "email": "niharika.manohar@6dtech.co.in",
                                "name": "user_5251_ent10",
                                "status": "0",
                                "roleName": "hcbs_newadminhcbsent_admin",
                                "roleId": "5715"
                            },
                            {
                                "loginUserId": "login_api_check",
                                "email": "niharika.manohar@gmail.com",
                                "name": "user_api_check",
                                "status": "0",
                                "roleName": "dkEnterprise_ReadOnly",
                                "roleId": "3813"
                            }
                        ],
                        "accountId": 42356972,
                        "accountName": "5251_ent_1",
                        "parentAccountId": "100000",
                        "currentStatus": "A",
                        "subscriberType": "1",
                        "currentStatusName": "Active",
                        "subscriberTypeName": "Postpaid",
                        "tierId": "4",
                        "onBoardType": "1"
                    }
                }
            ]
        },
        "responseId": "8394306689600918",
        "responseTimestamp": "11/11/2024 12:05:37"
    }
}

Account Users - Failure — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "11036",
            "resultDescription": "Incorrect value in AccountId"
        },
        "resultCode": "1",
        "responseId": "8393964251864249",
        "responseTimestamp": "11/11/2024 11:59:54"
    }
}