12. APN Group

This page contains all documentation under this Postman category.

APN Group - Create

Path: APN Group / APN Group - Create

Method: POST

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

Description

Create APN Group API is used to create APN Group with the combination of available APNs.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
apnGroupInfo	M	Object of apnGroupInfo

Input apnGroupInfo Parameters

Field	Optional/ Mandatory	Description
apnGroupName	M	APN Group name
defaultAPN	M	Default APN ID
apn	M	APN id list, You can fetch the list of possible apnId using "fetchAttachedAPN" API.

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
apnGroupId	O	APN Group id

Output ResultParam Parameters

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

Result Codes

Result Codes	Desrciption	Next Steps
10011	Create APN group success
10012	Create APN group failure

Headers

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

Request Body

JSON

{  
   "apnGroupInfo":{  
      "apnGroupName":"APNGroup",
      "defaultAPN":"98",
      "apn":"98|99"
   }
}

Response Examples

Create APN Group - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10012",
            "resultDescription": "Create APN group failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

Create APN Group - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10011",
            "resultDescription": "Create APN group success"
        },
        "resultCode": "0",
        "responseId": "1589376377514",
        "responseTimestamp": "13/05/2020 13:26:17",
        "apnGroupId": "PDP_2087"
    }
}

Create APN Group - Failure - {Wrong Input Parameter} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "1001",
            "resultDescription": "Wrong input parameter -defaultAPN"
        },
        "resultCode": "1",
        "responseId": "1588683948726",
        "responseTimestamp": "05/05/2020 13:05:48"
    }
}

APN Group

Path: APN Group / APN Group

Method: GET

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

Desciption

Get APN Group API is used to fetch APN Group information like default APN, default context value, list of attached APN(s) etc. APN Groups can then be attached to the endpoint to control which APNs that endpoint can use for data services, and the Quality of Service they can have for each of those APNs.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Query Parameters

Field	Optional/ Mandatory	Description
apnGroupId	O	APN Group 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
responseParam	O	Object of APN Group

Output ResultParam Parameters

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

Output ResponseParam Parameters

Field	Optional/Mandatory	Description
rows	O	List of the APN info

Output ApnGroup Parameters

Field	Optional/Mandatory	Description
apnGroupName	O	APN Group name
defaultAPN	O	Default APN
apnGroupId	O	ID of APN group
apn	O	List of APNs names with comma separated

Result Code

Result Codes	Description	Next Steps
10000	Get APN group success
10001	Get APN group failure

Headers

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

Response Examples

Get APN Group - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10000",
            "resultDescription": "Get APN group success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                {
                    "apn": "mvneapn",
                    "apnGroupName": "Default",
                    "defaultAPN": "mvneapn",
                    "apnGroupId": "PDP_1002"
                },
                {
                    "apn": "mvneapn",
                    "apnGroupName": "apn",
                    "defaultAPN": "mvneapn",
                    "apnGroupId": "PDP_1003"
                }
            ]
        },
        "responseId": "42600534393860054",
        "responseTimestamp": "27/04/2020 14:25:06"
    }
}

Get APN Group - Success - {Specific} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10000",
            "resultDescription": "Get APN group success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                {
                    "apn": "mvneapn",
                    "apnGroupName": "Default",
                    "defaultAPN": "mvneapn",
                    "apnGroupId": "PDP_1002"
                }
            ]
        },
        "responseId": "47361092196147997",
        "responseTimestamp": "21/06/2020 16:47:45"
    }
}

Get APN Group - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10001",
            "resultDescription": "Get APN group failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

APN Group - Modify

Path: APN Group / APN Group - Modify

Method: POST

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

Description

Modify APN Group API is used to modify APN Group with the combination of available APNs.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
apnGroupInfo	M	Object of apnGroupInfo

Input apnGroupInfo Parameters

Field	Optional/ Mandatory	Description
apnGroupId	M	APN Group Id
addAPN	CM	Add APN id list, You can fetch the list of possible apnId using "fetchAttachedAPN" API.
removeAPN	CM	Remove APN id list

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
10013	Modify APN group success
10014	Modify APN group failure
10123	Failure.!! Not possible to remove last APN

Headers

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

Request Body

JSON

{  
   "apnGroupInfo":{  
      "apnGroupId":"PDP_1237",
      "addAPN":"46",
      "removeAPN":"43"
   }
}

Response Examples

Modify APN Group - Success - {Remove APN} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10013",
            "resultDescription": "Modify APN group success"
        },
        "resultCode": "0",
        "responseId": "1588684482375",
        "responseTimestamp": "05/05/2020 13:14:42"
    }
}

Modify APN Group - Success - {Add APN} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10013",
            "resultDescription": "Modify APN group success"
        },
        "resultCode": "0",
        "responseId": "1588684531417",
        "responseTimestamp": "05/05/2020 13:15:31"
    }
}

Modify APN Group - Failure — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10014",
            "resultDescription": "Modify APN group failure"
        },
        "resultCode": "1",
        "responseId": "1588684664283",
        "responseTimestamp": "05/05/2020 13:17:44"
    }
}

Modify APN Group - Failure.!! Not possible to remove last APN — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10123",
            "resultDescription": "Failure.!! Not possible to remove last APN"
        },
        "resultCode": "1",
        "responseId": "6724636551046661",
        "responseTimestamp": "01/09/2022 06:56:36"
    }
}

APN Group - Delete

Path: APN Group / APN Group - Delete

Method: POST

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

Description

Delete APN Group API is used to remove an existing APN Group from an Enterprise. An APN Group cannot be deleted if it is assigned to any endpoint.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
apnGroupInfo	M	Object of apnGroupInfo

Input apnGroupInfo Parameters

Field	Optional/ Mandatory	Description
apnGroupId	M	APN Group Id

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

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

Output ResultParam Parameters

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

Result Codes

Result Codes	Description	Next Steps
10015	Delete APN group success
10016	Failure!! Deletion not possible, APN used in endpoint configuration.

Headers

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

Request Body

JSON

{  
   "apnGroupInfo":{  
      "apnGroupId":"PDP_867"
   }
}

Response Examples

Delete APN Group - Failure — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10016",
            "resultDescription": "Failure!! Deletion not possible, APN used in endpoint configuration."
        },
        "resultCode": "1",
        "responseId": "1588680930855",
        "responseTimestamp": "05/05/2020 12:15:31"
    }
}

Delete APN Group - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10015",
            "resultDescription": "Delete APN group success"
        },
        "resultCode": "0",
        "responseId": "1588680887533",
        "responseTimestamp": "05/05/2020 12:14:47"
    }
}