6 Payload References
This appendix describes Payload Reference details.
6.1 Payload Reference for PCF
This section provides payload details for the following PCF Operations.
6.1.1 PATCH-SessionManagementPolicyData
sm-patch
{
"umData": {
"mk1": {
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"limitId": "mk1",
"umLevel": "SERVICE_LEVEL",
"resetTime": "2018-01-02T08:17:14.090Z",
"allowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"uplinkVolume": 6666,
"downlinkVolume": 7777
}
}
},
"smPolicySnssaiData": {
"11-abc123": {
"snssai": {
"sd": "abc123",
"sst": 11
},
"smPolicyDnnData": {
"dnn1": {
"dnn": "dnn1",
"bdtRefIds": {
"abc": "bdtRefIds",
"xyz": "PCF"
}
}
}
}
}
}VSA patch
payload
{
"umData": {
"mk1": {
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"limitId": "mk1",
"name": "customQuota",
"umLevel": "SERVICE_LEVEL",
"resetTime": "2018-01-02T08:17:14.090Z",
"allowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"uplinkVolume": 6666,
"downlinkVolume": 7777
},
"customAllowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"downlinkVolume": 6666,
"uplinkVolume": 7777
},
"serviceSpecific": 7777,
"type": "",
"grantedUsage": {
"totalVolume": 8888,
"downlinkVolume": 6666,
"uplinkVolume": 7777,
"duration": 3000
},
"grantedServiceSpecific": "",
"quotaState": "",
"refInstanceId": ""
}
},
"smPolicySnssaiData": {
"21-abc123": {
"snssai": {
"sd": "abc123",
"sst": 11
},
"smPolicyDnnData": {
"dnn1": {
"dnn": "dnn1",
"bdtRefIds": {
"abc": "bdtRefIds",
"xyz": "PCF"
}
}
}
}
},
"VendorSpecific-000111": {
"subscriber": {
"IMSI": ["302370123456789"],
"ACCOUNTID": ["178322212122"],
"MSISDN": ["15145551234", "15141234567"],
"BillingDay": 6,
"Entitlement": ["DayPass", "DayPassPlus", "DayPassPro"]
},
"state": {
"property": [{
"name": "mcc",
"value": "123"
}, {
"name": "expire",
"value": "201402-09T11:20:32"
}],
"version": 1
}
}
}6.1.2 PUT-UEPolicySet
{
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": ["cat1", "cat2"],
"uePolicySections": {
"111": {
"upsi": "111",
"uePolicySectionInfo": "MQ=="
},
"33": {
"upsi": "33",
"uePolicySectionInfo": "Mg0K"
}
},
"upsis": ["111", "33"],
"allowedRouteSelDescs": {
"965-235": {
"servingPlmn": {
"mcc": "965",
"mnc": "235"
},
"snssaiRouteSelDescs": [{
"snssai": {
"sd": "abc123",
"sst": 11
},
"dnnRouteSelDescs": [{
"dnn": "dnn1",
"sscModes": ["SSC_MODE_1", "SSC_MODE_2"],
"pduSessTypes": ["IPV4"]
}]
}]
}
},
"andspInd": true,
"pei": "imei-355375345274757",
"osIds": ["bceafb30-31bd-4b8d-b3c2-ed79d029531a", "cc9d9f97-0127-497c-9bca-79e8e9080ea8"]
}6.1.3 PATCH-UEPolicySet
{
"praInfos":{
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": ["cat1", "cat2"],
"uePolicySections": {
"111": {
"upsi": "111",
"uePolicySectionInfo": "MQ=="
},
"33": {
"upsi": "33",
"uePolicySectionInfo": "Mg0K"
}
},
"upsis": ["111", "33"],
"allowedRouteSelDescs": {
"965-235": {
"servingPlmn": {
"mcc": "965",
"mnc": "235"
},
"snssaiRouteSelDescs": [{
"snssai": {
"sd": "abc123",
"sst": 11
}
}]
}
},
"andspInd": true,
"pei": "imei-355375345274757",
"osIds": ["bceafb30-31bd-4b8d-b3c2-ed79d029531a", "cc9d9f97-0127-497c-9bca-79e8e9080ea8"]
}6.1.4 PUT-UsageMonitoringInformation
{
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"limitId": "mk1",
"umLevel": "SERVICE_LEVEL",
"resetTime": "2018-01-02T08:17:14.090Z",
"allowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"uplinkVolume": 6666,
"downlinkVolume": 7777
}
}6.1.5 PUT-AM SM UEPolicyData
To add the AM, SM, UEPolicySet information.
{
"am-data": {
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": [
"cat1",
"cat2"
]
},
"sm-data": {
"umData": {
"mk1": {
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"limitId": "mk1",
"umLevel": "SERVICE_LEVEL",
"resetTime": "2018-01-02T08:17:14.090Z",
"allowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"uplinkVolume": 6666,
"downlinkVolume": 7777
}
}
},
"umDataLimits": {
"mk1": {
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"endDate": "2018-11-05T08:17:14.090Z",
"limitId": "mk1",
"umLevel": "SESSION_LEVEL",
"startDate": "2018-09-05T08:17:14.090Z",
"usageLimit": {
"duration": 6000,
"totalVolume": 9000,
"uplinkVolume": 5000,
"downlinkVolume": 4000
},
"resetPeriod": {
"period": "YEARLY"
}
}
},
"smPolicySnssaiData": {
"11-abc123": {
"snssai": {
"sd": "abc123",
"sst": 11
},
"smPolicyDnnData": {
"dnn1": {
"dnn": "dnn1",
"bdtRefIds": {
"xyz": "bdtRefIds",
"abc": "xyz"
},
"gbrDl": "7788 Kbps",
"gbrUl": "5566 Kbps",
"online": true,
"chfInfo": {
"primaryChfAddress": "1.1.1.1",
"secondaryChfAddress": "2.2.2.2"
},
"offline": true,
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"ipv4Index": 0,
"ipv6Index": 0,
"subscCats": [
"cat1",
"cat2"
],
"adcSupport": true,
"mpsPriority": true,
"allowedServices": [
"ser1",
"ser2"
],
"mpsPriorityLevel": 2,
"imsSignallingPrio": true,
"refUmDataLimitIds": {
"mk1": {
"monkey": [
"monkey1"
],
"limitId": "mk1"
}
},
"subscSpendingLimits": true
}
}
}
}
},
"ue-policy-set": {
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": [
"cat1",
"cat2"
],
"uePolicySections": {
"33": {
"upsi": "33",
"uePolicySectionInfo": "MQ=="
},
"111": {
"upsi": "111",
"uePolicySectionInfo": "Mg0K"
}
},
"upsis": [
"111",
"33"
],
"allowedRouteSelDescs": {
"965-235": {
"servingPlmn": {
"mcc": "965",
"mnc": "235"
},
"snssaiRouteSelDescs": [{
"snssai": {
"sd": "abc123",
"sst": 11
},
"dnnRouteSelDescs": [{
"dnn": "dnn1",
"sscModes": [
"SSC_MODE_1",
"SSC_MODE_2"
],
"pduSessTypes": [
"IPV4"
]
}]
}]
}
},
"andspInd": true,
"pei": "imei-355375345274757",
"osIds": [
"bceafb30-31bd-4b8d-b3c2-ed79d029531a",
"cc9d9f97-0127-497c-9bca-79e8e9080ea8"
]
}
}6.1.6 PUT-Policy Data with VSA Data
{
"am-data": {
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": [
"cat1",
"cat2"
]
},
"sm-data": {
"umData": {
"mk1": {
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"limitId": "mk1",
"name": "Weekend",
"umLevel": "SERVICE_LEVEL",
"resetTime": "2018-01-02T08:17:14.090Z",
"allowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"uplinkVolume": 6666,
"downlinkVolume": 7777
},
"customAllowedUsage": {
"duration": 9000,
"totalVolume": 8888,
"downlinkVolume": 6666,
"uplinkVolume": 7777
},
"serviceSpecific": 7777,
"type": "",
"grantedUsage": {
"totalVolume": 8888,
"downlinkVolume": 6666,
"uplinkVolume": 7777,
"duration": 3000
},
"grantedServiceSpecific": "",
"quotaState": "",
"refInstanceId": ""
}
},
"umDataLimits": {
"mk1": {
"scopes": {
"11-abc123": {
"dnn": [
"dnn1"
],
"snssai": {
"sd": "abc123",
"sst": 11
}
}
},
"endDate": "2018-11-05T08:17:14.090Z",
"limitId": "mk1",
"umLevel": "SESSION_LEVEL",
"startDate": "2018-09-05T08:17:14.090Z",
"usageLimit": {
"duration": 6000,
"totalVolume": 9000,
"uplinkVolume": 5000,
"downlinkVolume": 4000
},
"resetPeriod": {
"period": "YEARLY"
},
"Type": "",
"name": "DynamicAggregateLimit",
"priority": "",
"initialServiceSpecific": 4000,
"activationdatetime": "2021-09-05T08:17:14.090Z",
"validityDuration": 300,
"InterimReportingInterval": ""
}
},
"smPolicySnssaiData": {
"11-abc123": {
"snssai": {
"sd": "abc123",
"sst": 11
},
"smPolicyDnnData": {
"dnn1": {
"dnn": "dnn1",
"bdtRefIds": {
"xyz": "bdtRefIds",
"abc": "xyz"
},
"gbrDl": "7788 Kbps",
"gbrUl": "5566 Kbps",
"online": true,
"chfInfo": {
"primaryChfAddress": "1.1.1.1",
"secondaryChfAddress": "2.2.2.2"
},
"offline": true,
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"ipv4Index": 0,
"ipv6Index": 0,
"subscCats": [
"cat1",
"cat2"
],
"adcSupport": true,
"mpsPriority": true,
"allowedServices": [
"ser1",
"ser2"
],
"mpsPriorityLevel": 2,
"imsSignallingPrio": true,
"refUmDataLimitIds": {
"mk1": {
"monkey": [
"monkey1"
],
"limitId": "mk1"
}
},
"subscSpendingLimits": true
}
}
}
},
"VendorSpecific-000111": {
"subscriber": {
"IMSI": ["302370123456789"],
"ACCOUNTID": ["178322212122"],
"MSISDN": ["15145551234", "15141234567"],
"BillingDay": 6,
"Entitlement": ["DayPass", "DayPassPlus"],
"custom2": "abc",
"custom3": "abc123"
},
"state": {
"property": [{
"name": "mcc",
"value": "123"
}, {
"name": "expire",
"value": "201402-09T11:20:32"
}],
"version": 1
}
}
},
"ue-policy-set": {
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": [
"cat1",
"cat2"
],
"uePolicySections": {
"33": {
"upsi": "33",
"uePolicySectionInfo": "MQ=="
},
"111": {
"upsi": "111",
"uePolicySectionInfo": "Mg0K"
}
},
"upsis": [
"111",
"33"
],
"allowedRouteSelDescs": {
"965-235": {
"servingPlmn": {
"mcc": "965",
"mnc": "235"
},
"snssaiRouteSelDescs": [{
"snssai": {
"sd": "abc123",
"sst": 11
},
"dnnRouteSelDescs": [{
"dnn": "dnn1",
"sscModes": [
"SSC_MODE_1",
"SSC_MODE_2"
],
"pduSessTypes": [
"IPV4"
]
}]
}]
}
},
"andspInd": true,
"pei": "imei-355375345274757",
"osIds": [
"bceafb30-31bd-4b8d-b3c2-ed79d029531a",
"cc9d9f97-0127-497c-9bca-79e8e9080ea8"
]
}
}6.1.7 PUT - update am-data and delete sm-data
{
"am-data": {
"praInfos": {
"p1": {
"praId": "p1",
"trackingAreaList": [{
"plmnId": {
"mcc": "976",
"mnc": "31"
},
"tac": "5CB6"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"tac": "5CB7"
}
],
"ecgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"eutraCellId": "92FFdBE"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"eutraCellId": "8F868C4"
}
],
"ncgiList": [{
"plmnId": {
"mcc": "976",
"mnc": "32"
},
"nrCellId": "b2fB6fE9D"
},
{
"plmnId": {
"mcc": "977",
"mnc": "33"
},
"nrCellId": "5d1B4127b"
}
],
"globalRanNodeIdList": [{
"plmnId": {
"mcc": "965",
"mnc": "235"
},
"n3IwfId": "fFf0f2AFbFa16CEfE7"
},
{
"plmnId": {
"mcc": "967",
"mnc": "238"
},
"gNbId": {
"bitLength": 25,
"gNbValue": "1A8F1D"
}
}
]
}
},
"subscCats": [
"cat1",
"cat2"
]
},
"sm-data": null
}Delete all PCF data
{
"sm-data": null,
"am-data": null,
"ue-policy-set": null
}6.1.8 POST-Subscription Operations
"notificationUri":"http://mlu-pcf-api-gateway.mlu-pcf.svc/user-service/userservice/notification/msisdn-1871587819", "monitoredResourceUris":[ "https://localhost:9443/nudr-dr-prov/v1/policy-data/msisdn-1111111111/sm-data" ], "supportedFeatures":"f", "expires": "2022-04-23T18:25:43.511Z"
}6.1.9 PUT-Subscription Operations
{ "notificationUri":"http://mlu-pcf-api-gateway.mlu-pcf.svc/user-service/userservice/notification/msisdn-1871587819", "monitoredResourceUris":[ "https://localhost:9443/nudr-dr-prov/v1/policy-data/msisdn-1111111111/sm-data" ], "supportedFeatures":"f", "expires": "2022-04-23T18:25:43.511Z" }6.1.10 GET-Subscription Operations
{ "subscribedResources": [ "policy-data/msisdn-819191945001/am-data" ], "expires": "2022-04-23T18:25:43.511Z", "supportedFeatures": "f", "notificationUri": "http://http2-service.default.svc.cluster.local/policy-data/uri1/" }6.1.11 PUT or PATCH - Subscription Notification
[{'ue-id': 'msisdn-7777777779', 'smPolicyData': {'umData': {'mk1':
{'scopes': {'11-abc123': {'dnn': ['dnn1'], 'snssai': {'sd': 'abc123',
'sst': 11}}, '22-abc123': {'dnn': ['dnn2'], 'snssai': {'sd': 'abc123',
'sst': 22}}, '33-abc123': {'dnn': ['dnn1', 'dnn2'], 'snssai': {'sd':
'abc123', 'sst': 33}}}, 'limitId': 'mk1', 'umLevel': 'SERVICE_LEVEL',
'resetTime': {'period': 'YEARLY'}, 'allowedUsage': {'duration': 9000,
'totalVolume': 8888, 'uplinkVolume': 6666, 'downlinkVolume': 7777}}},
'umDataLimits': {'mk1': {'scopes': {'11-abc123': {'dnn': ['dnn1'],
'snssai': {'sd': 'abc123', 'sst': 11}}, '22-abc123': {'dnn': ['dnn2'],
'snssai': {'sd': 'abc123', 'sst': 22}}, '33-abc123': {'dnn': ['dnn1',
'dnn2'], 'snssai': {'sd': 'abc123', 'sst': 33}}}, 'endDate':
'2018-11-05T08:17:14.090Z', 'limitId': 'mk1', 'umLevel': 'SESSION_LEVEL',
'startDate': '2018-09-05T08:17:14.090Z', 'usageLimit': {'duration': 6000,
'totalVolume': 9000, 'uplinkVolume': 5000, 'downlinkVolume': 4000},
'resetPeriod': '2018-01-02T08:17:14.090Z'}}, 'smPolicySnssaiData':
{'11-abc123': {'snssai': {'sd': 'abc123', 'sst': 11}, 'smPolicyDnnData':
{'dnn1': {'dnn': 'dnn1', 'gbrDl': '7788 Kbps', 'gbrUl': '5566 Kbps',
'online': True, 'chfInfo': {'primaryChfAddress': '1.1.1.1',
'secondaryChfAddress': '2.2.2.2'}, 'offline': True, 'praInfos':
{'p1': {'praId': 'p1', 'ecgiList': [{'plmnId': {'mcc': '976', 'mnc': '32'},
'eutraCellId': '92FFdBE'}, {'plmnId': {'mcc': '977', 'mnc': '33'},
'eutraCellId': '8F868C4'}], 'ncgiList': [{'plmnId': {'mcc': '976', 'mnc':
'32'}, 'nrCellId': 'b2fB6fE9D'}, {'plmnId': {'mcc': '977', 'mnc': '33'},
'nrCellId': '5d1B4127b'}], 'trackingAreaList': [{'tac': '5CB6', 'plmnId':
{'mcc': '976', 'mnc': '32'}}, {'tac': '5CB7', 'plmnId': {'mcc': '977',
'mnc': '33'}}], 'globalRanNodeIdList': [{'plmnId': {'mcc': '965', 'mnc':
'235'}, 'n3IwfId': 'fFf0f2AFbFa16CEfE7'}, {'gNbId': {'gNBValue': '1A8F1D',
'bitLength': 25}, 'plmnId': {'mcc': '967', 'mnc': '238'}}]}}, 'bdtRefIds':
{'abc': 'xyz', 'xyz': 'bdtRefIds'}, 'ipv4Index': 0, 'ipv6Index': 0,
'subscCats': ['cat1', 'cat2'], 'adcSupport': True, 'mpsPriority': True,
'allowedServices': ['ser1', 'ser2'], 'mpsPriorityLevel': 2,
'imsSignallingPrio': True, 'refUmDataLimitIds': {'mk1': {'monkey':
['monkey1'], 'limitId': 'mk1'}}, 'subscSpendingLimits': True}}},
'22-abc123': {'snssai': {'sd': 'abc123', 'sst': 22}, 'smPolicyDnnData':
{'dnn2': {'dnn': 'dnn2', 'gbrDl': '7788 Kbps', 'gbrUl': '5566 Kbps',
'online': True, 'chfInfo': {'primaryChfAddress':
'1.1.1.1', 'secondaryChfAddress': '2.2.2.2'}, 'offline': True,
'praInfos': {'p1': {'praId': 'p1', 'ecgiList': [{'plmnId': {'mcc': '976',
'mnc': '32'}, 'eutraCellId': '92FFdBE'}, {'plmnId': {'mcc': '977', 'mnc'
: '33'}, 'eutraCellId': '8F868C4'}], 'ncgiList':
[{'plmnId': {'mcc': '976', 'mnc': '32'}, 'nrCellId': 'b2fB6fE9D'},
{'plmnId': {'mcc': '977', 'mnc': '33'}, 'nrCellId': '5d1B4127b'}],
'trackingAreaList': [{'tac': '5CB6', 'plmnId': {'mcc': '976', 'mnc': '32'}},
{'tac': '5CB7', 'plmnId': {'mcc': '977', 'mnc': '33'}}],
'globalRanNodeIdList': [{'plmnId': {'mcc': '965', 'mnc': '235'},
'n3IwfId': 'fFf0f2AFbFa16CEfE7'}, {'gNbId': {'gNBValue': '1A8F1D',
'bitLength': 25}, 'plmnId': {'mcc': '967', 'mnc': '238'}}]}},
'ipv4Index': 0, 'ipv6Index': 0, 'subscCats': ['cat1', 'cat2'],
'adcSupport': True, 'mpsPriority': True, 'allowedServices':
['ser1', 'ser2'], 'mpsPriorityLevel': 2, 'imsSignallingPrio': True,
'refUmDataLimitIds': {'mk1': {'monkey': ['monkey1'], 'limitId': 'mk1'}},
'subscSpendingLimits': True}}}, '33-abc123': {'snssai': {'sd': 'abc123',
'sst': 33}, 'smPolicyDnnData': {'dnn1': {'dnn': 'dnn1', 'gbrDl':
'7788 Kbps', 'gbrUl': '5566 Kbps', 'online': True, 'chfInfo':
{'primaryChfAddress': '1.1.1.1', 'secondaryChfAddress': '2.2.2.2'},
'offline': True, 'praInfos': {'p1': {'praId': 'p1', 'ecgiList':
[{'plmnId': {'mcc': '976', 'mnc': '32'}, 'eutraCellId': '92FFdBE'},
{'plmnId': {'mcc': '977', 'mnc': '33'}, 'eutraCellId': '8F868C4'}]
, 'ncgiList': [{'plmnId': {'mcc': '976', 'mnc': '32'}, 'nrCellId':
'b2fB6fE9D'}, {'plmnId': {'mcc': '977', 'mnc': '33'}, 'nrCellId':
'5d1B4127b'}], 'trackingAreaList': [{'tac': '5CB6', 'plmnId':
{'mcc': '976', 'mnc': '32'}}, {'tac': '5CB7', 'plmnId':
{'mcc': '977', 'mnc': '33'}}], 'globalRanNodeIdList': [{'plmnId':
{'mcc': '965', 'mnc': '235'}, 'n3IwfId': 'fFf0f2AFbFa16CEfE7'}, {'gNbId':
{'gNBValue': '1A8F1D', 'bitLength': 25}, 'plmnId': {'mcc': '967',
'mnc': '238'}}]}}, 'ipv4Index': 0, 'ipv6Index': 0, 'subscCats':
['cat1', 'cat2'], 'adcSupport': True, 'mpsPriority': True,
'allowedServices': ['ser1', 'ser2'], 'mpsPriorityLevel': 2,
'imsSignallingPrio': True, 'refUmDataLimitIds': {'mk1': {'monkey':
['monkey1'], 'limitId': 'mk1'}}, 'subscSpendingLimits': True}, 'dnn2':
{'dnn': 'dnn2', 'gbrDl': '7788 Kbps', 'gbrUl': '5566 Kbps', 'online':
True, 'chfInfo': {'primaryChfAddress': '1.1.1.1', 'secondaryChfAddress':
'2.2.2.2'}, 'offline': True, 'praInfos': {'p1': {'praId': 'p1',
'ecgiList': [{'plmnId': {'mcc': '976', 'mnc': '32'}, 'eutraCellId':
'92FFdBE'}, {'plmnId': {'mcc': '977', 'mnc': '33'}, 'eutraCellId':
'8F868C4'}], 'ncgiList': [{'plmnId': {'mcc': '976', 'mnc': '32'},
'nrCellId': 'b2fB6fE9D'}, {'plmnId': {'mcc': '977', 'mnc': '33'},
'nrCellId': '5d1B4127b'}], 'trackingAreaList': [{'tac': '5CB6',
'plmnId': {'mcc': '976', 'mnc': '32'}},
{'tac': '5CB7', 'plmnId': {'mcc': '977', 'mnc': '33'}}],
'globalRanNodeIdList': [{'plmnId': {'mcc': '965', 'mnc': '235'},
'n3IwfId': 'fFf0f2AFbFa16CEfE7'}, {'gNbId': {'gNBValue': '1A8F1D',
'bitLength': 25}, 'plmnId': {'mcc': '967', 'mnc': '238'}}]}},
'ipv4Index': 0, 'ipv6Index': 0, 'subscCats': ['cat1', 'cat2'],
'adcSupport': True, 'mpsPriority': True, 'allowedServices':
['ser1', 'ser2'], 'mpsPriorityLevel': 2, 'imsSignallingPrio': True,
'refUmDataLimitIds': {'mk1': {'monkey': ['monkey1'],
'limitId': 'mk1'}}, 'subscSpendingLimits':
True}}}}}}]6.2 Payload Reference for Provisioning System
This section provides payload details for the following Provisioning System Operations.
6.2.1 POST-ProfileData
{
"profile-data": {
"MSISDN": ["1111111112", "1111111113"],
"IMSI": ["2222222221", "2222222222", "2222222223"],
"NAI": ["3333333331", "3333333332", "3333333333"]
}
}6.2.2 Adding Custom Fields under Profile Data
To add custom fields under profile data during initial subscriber provisioning
(create
subscriber):
{
"profile-data": {
"MSISDN": [
"1111111112",
"1111111113"
],
"Imsi": [
"2222222221"
],
"profile-fields": {
"customFieldKey": "CustomValue"
}
}
}6.3 Payload Reference for UDM APIs
This section provides payload details for the following UDM APIs Operations.
6.3.1 PATCH-Amf3GppAccessRegistration
case 1: REPLACE
[{
"op" : "replace",
"path" : "/mnc-mcc-amfId/backupAmfInfo/0/guamiList/0/plmnId/mcc",
"value" : "998"
}]
case2: ADD
[{
"op" : "add",
"path" : "/mnc-mcc-amfId/backupAmfInfo/0/guamiList/1",
"value" : {
"amfId": "5678AA",
"plmnId": {
"mcc": "666",
"mnc": "456"
}
}
}]
case3: REMOVE
[{
"op" : "remove",
"path" : "/mnc-mcc-amfId/backupAmfInfo/0/guamiList/2"
}]6.3.2 PUT-Amf3GppAccessRegistration
{
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"supportedFeatures": "AF",
"purgeFlag": true,
"pei": "imei-1000000000000001",
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"amfServiceNameDereg": "nudm-sdm",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"amfServiceNamePcscfRest": "nausf-auth",
"initialRegistrationInd": true,
"guami": {
"plmnId": {
"mcc": "001",
"mnc": "123"
},
"amfId": "1234AA"
},
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"plmnId": {
"mcc": "002",
"mnc": "456"
},
"amfId": "5678AA"
},
{
"plmnId": {
"mcc": "003",
"mnc": "789"
},
"amfId": "9876AA"
}
]
}
],
"drFlag": true,
"ratType": "WLAN",
"urrpIndicator": true,
"amfEeSubscriptionId": "subscriptionId",
"epsInterworkingInfo": {
"dnn1": {
"pgwFqdn": "hijklm",
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9"
},
"dnn2": {
"pgwFqdn": "abcdefgh",
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b7"
}
}
}6.3.3 PUT-AmfNon3GppAccessRegistration
{
"amfInstanceId" : "abae35e5-cc45-4016-8dd4-89598e5311b9",
"supportedFeatures" : "AF",
"purgeFlag" : true,
"pei" : "imei-1000000000000001",
"imsVoPs" : "HOMOGENEOUS_SUPPORT",
"deregCallbackUri" : "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"amfServiceNameDereg" : "nudm-sdm",
"pcscfRestorationCallbackUri" : "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"amfServiceNamePcscfRest" : "nausf-auth",
"guami" : {
"plmnId" : {
"mcc" : "001",
"mnc" : "123"
},
"amfId" : "1234AA"
},
"backupAmfInfo" : [
{"backupAmf" : "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList" : [{"plmnId" : {"mcc" : "002","mnc" : "456"},"amfId" : "5678AA"},{"plmnId" : {"mcc" : "003","mnc" : "789"},"amfId" : "9876AA"}]}
],
"ratType" : "WLAN",
"amfEeSubscriptionId": "subscriptionId",
"urrpIndicator" : true
}6.3.4 PUT-SessionManagementSubscriptionData
{
"singleNssai": {
"sd": "ABC654",
"sst": 1
},
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"dnnConfigurations": {
"dnn1": {
"sscModes": {
"defaultSscMode": "SSC_MODE_1",
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
]
},
"iwkEpsInd": true,
"upSecurity": {
"upConfid": "REQUIRED",
"upIntegr": "REQUIRED"
},
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"preemptVuln": "PREEMPTABLE",
"priorityLevel": 1
},
"priorityLevel": 79
},
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
],
"3gppChargingCharacteristics": "123A"
}
},
"sharedDnnConfigurationsId": "85868-mZE$cy",
"odbPacketServices": "ALL_PACKET_SERVICES"
}6.3.5 POST-SDMSubscriptions
{
"nfInstanceId": "cb59c48c-a2fa-11e9-a2a3-2a2ae2dbcce4",
"expires": "2012-04-23T18:25:43.511Z",
"implicitUnsubscribe": true,
"dnn": "sasa",
"singleNssai": {
"sd": "651Bf9",
"sst": 23
},
"callbackReference": "udr",
"amfServiceName": "nnrf-nfm",
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"plmnId": {
"mnc": "124",
"mcc": "123"
},
"subscriptionId": "sa"
}6.3.6 Post-SubscriptionDataSubscriptions
{
"callbackReference": "http://10.75.212.167:8787",
"originalCallbackReference": "http://10.75.212.167:8787",
"ueId": "nai-990991@nai",
"subscriptionId": "7",
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"expiry": "2020-01-02T08:17:14.090Z",
"supportedFeatures": "f",
"sdmSubscription":{
"nfInstanceId": "cb59c48c-a2fa-11e9-a2a3-2a2ae2dbcce4",
"expires": "2012-04-23T18:25:43.511Z",
"implicitUnsubscribe": true,
"dnn": "sasb",
"singleNssai": {
"sd": "651Bf9",
"sst": 23
},
"callbackReference": "udr",
"amfServiceName": "nnrf-nfm",
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-919090909010@nai/context-data/amf-3gpp-access"
],
"plmnId": {
"mnc": "124",
"mcc": "123"
},
"subscriptionId": "sa"
}
}6.3.7 PUT - SDMSubscriptions
{
"nfInstanceId": "cb59c48c-a2fa-11e9-a2a3-2a2ae2dbcce4",
"expires": "2012-04-23T18:25:43.511Z",
"implicitUnsubscribe": true,
"dnn": "sasa",
"singleNssai": {
"sd": "651Bf9",
"sst": 23
},
"callbackReference": "udr",
"amfServiceName": "nnrf-nfm",
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"plmnId": {
"mnc": "124",
"mcc": "123"
},
"subscriptionId": "sb"
}6.4 Response Reference for UDM APIs
This section provides output details for the following UDM APIs.
6.4.1 GET-ContextData
Following is the Result Code when the Sample URL is: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data
{
"amfNon3Gpp": {
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"purgeFlag": true,
"supportedFeatures": "AF",
"ratType": "WLAN",
"urrpIndicator": true,
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"guami": {
"plmnId": {
"mnc": "123",
"mcc": "001"
},
"amfId": "1234AA"
},
"pei": "imei-1000000000000001",
"amfEeSubscriptionId": "subscriptionId",
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"plmnId": {
"mnc": "456",
"mcc": "002"
},
"amfId": "5678AA"
},
{
"plmnId": {
"mnc": "789",
"mcc": "003"
},
"amfId": "9876AA"
}
]
}
]
},
"smsf3GppAccess": {
"smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
"supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
"smsfMAPAddress": "977347916",
"plmnId": {
"mnc": "45",
"mcc": "452"
},
"smsfDiameterAddress": {
"name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
"realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
}
},
"amf3Gpp": {
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"purgeFlag": true,
"supportedFeatures": "AF",
"ratType": "WLAN",
"urrpIndicator": true,
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"guami": {
"plmnId": {
"mnc": "123",
"mcc": "001"
},
"amfId": "1234AA"
},
"pei": "imei-1000000000000001",
"amfEeSubscriptionId": "subscriptionId",
"drFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"plmnId": {
"mnc": "456",
"mcc": "002"
},
"amfId": "5678AA"
},
{
"plmnId": {
"mnc": "789",
"mcc": "003"
},
"amfId": "9876AA"
}
]
}
],
"epsInterworkingInfo": {
"dnn2": {
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b7",
"pgwFqdn": "abcdefgh"
},
"dnn1": {
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"pgwFqdn": "hijklm"
}
},
"initialRegistrationInd": true
},
"smsfNon3GppAccess": {
"smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
"supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
"smsfMAPAddress": "977347916",
"plmnId": {
"mnc": "45",
"mcc": "452"
},
"smsfDiameterAddress": {
"name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
"realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
}
}
}
6.4.2 GET - Context Data - SMSF
{
"smsf3GppAccess": {
"smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
"supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
"smsfMAPAddress": "977347916",
"plmnId": {
"mnc": "45",
"mcc": "452"
},
"smsfDiameterAddress": {
"name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
"realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
}
}
}6.4.3 GET-ProvisionedData
Below is the output when the Sample URL is:
http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data.
{
"amData": {
"upuInfo": {
"upuAckInd": true,
"upuRegInd": true,
"upuDataList": [
{
"secPacket": "aGVsbG8="
}
],
"provisioningTime": "2012-04-23T18:25:43.511Z",
"upuMacIausf": "E0b0cCF4EcCC5CA55DBfeA3B2Ad3aE80",
"counterUpu": "3Ab5"
},
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"mcsPriority": true,
"activeTime": 3,
"subscribedDnnList": [
"hello",
"ocudr"
],
"subscribedUeAmbr": {
"uplink": "123 Gbps",
"downlink": "12 Gbps"
},
"sharedAmDataIds": [
"62626-esp}W3A?hIgZ{47Qiuuj@GR:Ped>@k`Px,76390-Cd[s[TECI"
],
"coreNetworkTypeRestrictions": [
"5GC",
"EPC"
],
"nssai": {
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"defaultSingleNssais": [
{
"sd": "abc123",
"sst": 1
},
{
"sd": "abc124",
"sst": 2
}
],
"singleNssais": [
{
"sd": "abc789",
"sst": 3
},
{
"sd": "abc799",
"sst": 5
}
]
},
"dlPacketCount": -1,
"gpsis": [
"msisdn-1585632",
"msisdn-2969851"
],
"rfspIndex": 123,
"mpsPriority": true,
"forbiddenAreas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
],
"serviceAreaRestriction": {
"restrictionType": "ALLOWED_AREAS",
"maxNumOfTAs": 23,
"areas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
]
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"sorInfo": {
"sorMacIausf": "Bf85A791dCCDa7D6d9754264F02EDcBc",
"steeringContainer": [
{
"plmnId": {
"mnc": "456",
"mcc": "123"
},
"accessTechList": [
"NR"
]
}
],
"provisioningTime": "2012-04-23T18:25:43.511Z",
"countersor": "8ebc",
"ackInd": true
},
"ratRestrictions": [
"NR",
"WLAN",
"EUTRA",
"VIRTUAL"
],
"subsRegTimer": 2,
"ueUsageType": 9,
"internalGroupIds": [
"E1465DF5-483-159-Fc23DE491edb354dABAa",
"51e851ea-577-297-Ef4d7Cf28CaC0D"
],
"micoAllowed": true
},
"smfSelData": {
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"subscribedSnssaiInfos": {
"snsai1": {
"dnnInfos": [
{
"defaultDnnIndicator": true,
"iwkEpsInd": true,
"dnn": "Dnn1",
"lboRoamingAllowed": true
},
{
"defaultDnnIndicator": false,
"iwkEpsInd": true,
"dnn": "Dnn2",
"lboRoamingAllowed": true
}
]
}
},
"sharedSnssaiInfosId": "96367-9z}MD*"
},
"smData": {
"2": {
"dnnConfigurations": {
"dnn1": {
"iwkEpsInd": true,
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"priorityLevel": 79,
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"priorityLevel": 1,
"preemptVuln": "PREEMPTABLE"
}
},
"upSecurity": {
"upIntegr": "REQUIRED",
"upConfid": "REQUIRED"
},
"sscModes": {
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
],
"defaultSscMode": "SSC_MODE_1"
},
"3gppChargingCharacteristics": "123A",
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
]
}
},
"singleNssai": {
"sst": 2
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"sharedDnnConfigurationsId": "85868-mZE$cy"
},
"3": {
"dnnConfigurations": {
"dnn1": {
"iwkEpsInd": true,
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"priorityLevel": 79,
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"priorityLevel": 1,
"preemptVuln": "PREEMPTABLE"
}
},
"upSecurity": {
"upIntegr": "REQUIRED",
"upConfid": "REQUIRED"
},
"sscModes": {
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
],
"defaultSscMode": "SSC_MODE_1"
},
"3gppChargingCharacteristics": "123A",
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
]
}
},
"singleNssai": {
"sst": 3
},
"OdbPacketServices": "ALL_PACKET_SERVICES",
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"sharedDnnConfigurationsId": "85868-mZE$cy"
}
},
"traceData": {
"eventList": "855B5bf7beC3AFB8c",
"collectionEntityIpv6Addr": "2001:db8:85a3::8a2e:370:7334",
"collectionEntityIpv4Addr": "26.118.255.253",
"traceRef": "070207-baE6Dd",
"neTypeList": "0f4FBEfe95bF8",
"traceDepth": "MINIMUM"
},
"smsMngData": {
"moSmsBarringAll": true,
"supportedFeatures": "CAe8de215CFa721BB2AE7Ef9c5f71a2e",
"mtSmsBarringRoaming": false,
"mtSmsSubscribed": true,
"moSmsBarringRoaming": true,
"mtSmsBarringAll": true,
"moSmsSubscribed": false,
"sharedSmsMngDataIds": [
"16994-'JD",
"693599-9~~GX"
]
},
"smsSubsData": {
"sharedSmsSubsDataId": [
"372063-P",
"372063-O"
],
"smsSubscribed": true
}
}Below is the output when the Sample URL is
http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data?dataset-names=AM,SM
{
"amData": {
"upuInfo": {
"upuAckInd": true,
"upuRegInd": true,
"upuDataList": [
{
"secPacket": "aGVsbG8="
}
],
"provisioningTime": "2012-04-23T18:25:43.511Z",
"upuMacIausf": "E0b0cCF4EcCC5CA55DBfeA3B2Ad3aE80",
"counterUpu": "3Ab5"
},
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"mcsPriority": true,
"activeTime": 3,
"subscribedDnnList": [
"hello",
"ocudr"
],
"subscribedUeAmbr": {
"uplink": "123 Gbps",
"downlink": "12 Gbps"
},
"sharedAmDataIds": [
"62626-esp}W3A?hIgZ{47Qiuuj@GR:Ped>@k`Px,76390-Cd[s[TECI"
],
"coreNetworkTypeRestrictions": [
"5GC",
"EPC"
],
"nssai": {
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"defaultSingleNssais": [
{
"sd": "abc123",
"sst": 1
},
{
"sd": "abc124",
"sst": 2
}
],
"singleNssais": [
{
"sd": "abc789",
"sst": 3
},
{
"sd": "abc799",
"sst": 5
}
]
},
"dlPacketCount": -1,
"gpsis": [
"msisdn-1585632",
"msisdn-2969851"
],
"rfspIndex": 123,
"mpsPriority": true,
"forbiddenAreas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
],
"serviceAreaRestriction": {
"restrictionType": "ALLOWED_AREAS",
"maxNumOfTAs": 23,
"areas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
]
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"sorInfo": {
"sorMacIausf": "Bf85A791dCCDa7D6d9754264F02EDcBc",
"steeringContainer": [
{
"plmnId": {
"mnc": "456",
"mcc": "123"
},
"accessTechList": [
"NR"
]
}
],
"provisioningTime": "2012-04-23T18:25:43.511Z",
"countersor": "8ebc",
"ackInd": true
},
"ratRestrictions": [
"NR",
"WLAN",
"EUTRA",
"VIRTUAL"
],
"subsRegTimer": 2,
"ueUsageType": 9,
"internalGroupIds": [
"E1465DF5-483-159-Fc23DE491edb354dABAa",
"51e851ea-577-297-Ef4d7Cf28CaC0D"
],
"micoAllowed": true
},
"smData": {
"2": {
"dnnConfigurations": {
"dnn1": {
"iwkEpsInd": true,
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"priorityLevel": 79,
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"priorityLevel": 1,
"preemptVuln": "PREEMPTABLE"
}
},
"upSecurity": {
"upIntegr": "REQUIRED",
"upConfid": "REQUIRED"
},
"sscModes": {
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
],
"defaultSscMode": "SSC_MODE_1"
},
"3gppChargingCharacteristics": "123A",
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
]
}
},
"singleNssai": {
"sst": 2
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"sharedDnnConfigurationsId": "85868-mZE$cy"
},
"3": {
"dnnConfigurations": {
"dnn1": {
"iwkEpsInd": true,
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"priorityLevel": 79,
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"priorityLevel": 1,
"preemptVuln": "PREEMPTABLE"
}
},
"upSecurity": {
"upIntegr": "REQUIRED",
"upConfid": "REQUIRED"
},
"sscModes": {
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
],
"defaultSscMode": "SSC_MODE_1"
},
"3gppChargingCharacteristics": "123A",
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
]
}
},
"singleNssai": {
"sst": 3
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"sharedDnnConfigurationsId": "85868-mZE$cy"
}
}
}6.4.4 PUT-AccessAndMobilitySubscriptionData
{
"gpsis": [
"msisdn-1585632",
"msisdn-2969851"
],
"nssai": {
"singleNssais": [
{
"sd": "abc789",
"sst": 3
},
{
"sd": "abc799",
"sst": 5
}
],
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"defaultSingleNssais": [
{
"sd": "abc123",
"sst": 1
},
{
"sd": "abc124",
"sst": 2
}
]
},
"sorInfo": {
"ackInd": true,
"countersor": "8ebc",
"sorMacIausf": "Bf85A791dCCDa7D6d9754264F02EDcBc",
"provisioningTime": "2012-04-23T18:25:43.511Z",
"steeringContainer": [
{
"plmnId": {
"mcc": "123",
"mnc": "456"
},
"accessTechList": [
"NR"
]
}
]
},
"upuInfo": {
"upuAckInd": true,
"upuRegInd": true,
"counterUpu": "3Ab5",
"upuDataList": [
{
"secPacket": "aGVsbG8="
}
],
"upuMacIausf": "E0b0cCF4EcCC5CA55DBfeA3B2Ad3aE80",
"provisioningTime": "2012-04-23T18:25:43.511Z"
},
"rfspIndex": 123,
"activeTime": 3,
"mcsPriority": true,
"micoAllowed": true,
"mpsPriority": true,
"ueUsageType": 9,
"subsRegTimer": 2,
"dlPacketCount": -1,
"forbiddenAreas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
],
"ratRestrictions": [
"NR",
"WLAN",
"EUTRA",
"VIRTUAL"
],
"sharedAmDataIds": [
"62626-esp}W3A?hIgZ{47Qiuuj@GR:Ped>@k`Px,76390-Cd[s[TECI"
],
"internalGroupIds": [
"E1465DF5-483-159-Fc23DE491edb354dABAa",
"51e851ea-577-297-Ef4d7Cf28CaC0D"
],
"subscribedUeAmbr": {
"uplink": "123 Gbps",
"downlink": "12 Gbps"
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"subscribedDnnList": [
"hello",
"ocudr"
],
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"serviceAreaRestriction": {
"areas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
],
"maxNumOfTAs": 23,
"restrictionType": "ALLOWED_AREAS"
},
"coreNetworkTypeRestrictions": [
"5GC",
"EPC"
]
}6.4.5 GET-Amf3GppAccessRegistration
Below is the output when the sample URL is
http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/amf-3gpp-access.
{
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"purgeFlag": true,
"supportedFeatures": "AF",
"ratType": "WLAN",
"urrpIndicator": true,
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"guami": {
"plmnId": {
"mnc": "123",
"mcc": "001"
},
"amfId": "1234AA"
},
"pei": "imei-1000000000000001",
"amfEeSubscriptionId": "subscriptionId",
"drFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"plmnId": {
"mnc": "456",
"mcc": "002"
},
"amfId": "5678AA"
},
{
"plmnId": {
"mnc": "789",
"mcc": "003"
},
"amfId": "9876AA"
}
]
}
],
"epsInterworkingInfo": {
"dnn2": {
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b7",
"pgwFqdn": "abcdefgh"
},
"dnn1": {
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"pgwFqdn": "hijklm"
}
},
"initialRegistrationInd": true
}
Below is the output when the sample URL is http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/amf-3gpp-access?fields=pei,ratType,epsInterworkingInfo,backupAmfInfo,drFlag
{
"pei": "imei-1000000000000001",
"drFlag": true,
"ratType": "WLAN",
"backupAmfInfo": [
{
"AmfName": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"plmnId": {
"mnc": "456",
"mcc": "002"
},
"amfId": "5678AA"
},
{
"plmnId": {
"mnc": "789",
"mcc": "003"
},
"amfId": "9876AA"
}
]
}
],
"epsInterworkingInfo": {
"dnn2": {
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b7",
"pgwFqdn": "abcdefgh"
},
"dnn1": {
"smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"pgwFqdn": "hijklm"
}
}
}6.4.6 PATCH-Amf3GppAccessRegistration
case 1: REPLACE
[{
"op" : "replace",
"path" : "/mnc-mcc-amfId/backupAmfInfo/0/guamiList/0/plmnId/mcc",
"value" : "998"
}]
case2: ADD
[{
"op" : "add",
"path" : "/mnc-mcc-amfId/backupAmfInfo/0/guamiList/1",
"value" : {
"amfId": "5678AA",
"plmnId": {
"mcc": "666",
"mnc": "456"
}
}
}]
case3: REMOVE
[{
"op" : "remove",
"path" : "/mnc-mcc-amfId/backupAmfInfo/0/guamiList/2"
}]6.4.7 PUT-AmfNon3GppAccessRegistration
{
"amfInstanceId" : "abae35e5-cc45-4016-8dd4-89598e5311b9",
"supportedFeatures" : "AF",
"purgeFlag" : true,
"pei" : "imei-1000000000000001",
"imsVoPs" : "HOMOGENEOUS_SUPPORT",
"deregCallbackUri" : "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"amfServiceNameDereg" : "nudm-sdm",
"pcscfRestorationCallbackUri" : "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"amfServiceNamePcscfRest" : "nausf-auth",
"guami" : {
"plmnId" : {
"mcc" : "001",
"mnc" : "123"
},
"amfId" : "1234AA"
},
"backupAmfInfo" : [
{"backupAmf" : "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList" : [{"plmnId" : {"mcc" : "002","mnc" : "456"},"amfId" : "5678AA"},{"plmnId" : {"mcc" : "003","mnc" : "789"},"amfId" : "9876AA"}]}
],
"ratType" : "WLAN",
"amfEeSubscriptionId": "subscriptionId",
"urrpIndicator" : true
}6.4.8 GET-AmfNon3GppAccessRegistration
The output of Sample URI:
http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access
is:
{
"pei": "imei-1000000000000001",
"guami": {
"amfId": "1234AA",
"plmnId": {
"mcc": "001",
"mnc": "123"
}
},
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"ratType": "WLAN",
"purgeFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"amfId": "5678AA",
"plmnId": {
"mcc": "002",
"mnc": "456"
}
},
{
"amfId": "9876AA",
"plmnId": {
"mcc": "003",
"mnc": "789"
}
}
]
}
],
"urrpIndicator": true,
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"supportedFeatures": "AF",
"amfEeSubscriptionId": "subscriptionId",
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances"
}The output of Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000025/context-data/amf-non-3gpp-access/all is:
{
"active": {
"guami": "223-004-1234AA",
"timeStamp": "2020-04-23 09:36:24.621"
},
"previousActive": {
"guami": "123-004-1234AA",
"timeStamp": "2020-04-23 09:36:17.919"
},
"2020-04-23 09:36:02.444": {
"123-001-1234AA": {
"pei": "imei-1000000000000001",
"guami": {
"amfId": "1234AA",
"plmnId": {
"mcc": "001",
"mnc": "123"
}
},
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"ratType": "WLAN",
"purgeFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"amfId": "5678AA",
"plmnId": {
"mcc": "002",
"mnc": "456"
}
},
{
"amfId": "9876AA",
"plmnId": {
"mcc": "003",
"mnc": "789"
}
}
]
}
],
"urrpIndicator": true,
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"supportedFeatures": "AF",
"amfEeSubscriptionId": "subscriptionId",
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances"
}
},
"2020-04-23 09:36:10.504": {
"123-002-1234AA": {
"pei": "imei-1000000000000001",
"guami": {
"amfId": "1234AA",
"plmnId": {
"mcc": "002",
"mnc": "123"
}
},
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"ratType": "WLAN",
"purgeFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"amfId": "5678AA",
"plmnId": {
"mcc": "002",
"mnc": "456"
}
},
{
"amfId": "9876AA",
"plmnId": {
"mcc": "003",
"mnc": "789"
}
}
]
}
],
"urrpIndicator": true,
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"supportedFeatures": "AF",
"amfEeSubscriptionId": "subscriptionId",
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances"
}
},
"2020-04-23 09:36:17.919": {
"123-004-1234AA": {
"pei": "imei-1000000000000001",
"guami": {
"amfId": "1234AA",
"plmnId": {
"mcc": "004",
"mnc": "123"
}
},
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"ratType": "WLAN",
"purgeFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"amfId": "5678AA",
"plmnId": {
"mcc": "002",
"mnc": "456"
}
},
{
"amfId": "9876AA",
"plmnId": {
"mcc": "003",
"mnc": "789"
}
}
]
}
],
"urrpIndicator": true,
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"supportedFeatures": "AF",
"amfEeSubscriptionId": "subscriptionId",
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances"
}
},
"2020-04-23 09:36:24.621": {
"223-004-1234AA": {
"pei": "imei-1000000000000001",
"guami": {
"amfId": "1234AA",
"plmnId": {
"mcc": "004",
"mnc": "223"
}
},
"imsVoPs": "HOMOGENEOUS_SUPPORT",
"ratType": "WLAN",
"purgeFlag": true,
"amfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
"backupAmfInfo": [
{
"backupAmf": "amf1.cluster1.net2.amf.5gc.mnc012.mcc345.3gppnetwork.org",
"guamiList": [
{
"amfId": "5678AA",
"plmnId": {
"mcc": "002",
"mnc": "456"
}
},
{
"amfId": "9876AA",
"plmnId": {
"mcc": "003",
"mnc": "789"
}
}
]
}
],
"urrpIndicator": true,
"deregCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
"supportedFeatures": "AF",
"amfEeSubscriptionId": "subscriptionId",
"amfServiceNameDereg": "nudm-sdm",
"amfServiceNamePcscfRest": "nausf-auth",
"pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances"
}
}
}6.4.9 GET-SessionManagementSubscriptionData
[
{
"dnnConfigurations": {
"dnn1": {
"iwkEpsInd": true,
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"priorityLevel": 79,
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"priorityLevel": 1,
"preemptVuln": "PREEMPTABLE"
}
},
"upSecurity": {
"upIntegr": "REQUIRED",
"upConfid": "REQUIRED"
},
"sscModes": {
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
],
"defaultSscMode": "SSC_MODE_1"
},
"3gppChargingCharacteristics": "123A",
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
]
}
},
"singleNssai": {
"sd": "ABC654",
"sst": 1
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"sharedDnnConfigurationsId": "85868-mZE$cy"
}
]6.4.10 GET-SessionManagementSubscriptionData- Provisioning
[
{
"dnnConfigurations": {
"dnn1": {
"iwkEpsInd": true,
"sessionAmbr": {
"uplink": "125 Mbps",
"downlink": "25 Mbps"
},
"5gQosProfile": {
"priorityLevel": 79,
"5qi": 123,
"arp": {
"preemptCap": "MAY_PREEMPT",
"priorityLevel": 1,
"preemptVuln": "PREEMPTABLE"
}
},
"upSecurity": {
"upIntegr": "REQUIRED",
"upConfid": "REQUIRED"
},
"sscModes": {
"allowedSscModes": [
"SSC_MODE_2",
"SSC_MODE_3"
],
"defaultSscMode": "SSC_MODE_1"
},
"3gppChargingCharacteristics": "123A",
"pduSessionTypes": {
"defaultSessionType": "IPV4",
"allowedSessionTypes": [
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
},
"staticIpAddress": [
{
"ipv4Addr": "11.11.11.1"
},
{
"ipv4Addr": "11.11.11.2"
}
]
}
},
"singleNssai": {
"sd": "ABC654",
"sst": 1
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"internalGroupIds": [
"9ABAB803-203-299-95A9",
"9ABAB803-203-299-95A2",
"79e0c480-719-085-f2A55e6DDc91Df802438"
],
"sharedDnnConfigurationsId": "85868-mZE$cy"
}
]6.4.11 GET-SDMSubscriptions
Following is the Result Code:
[
{
"nfInstanceId": "cb59c48c-a2fa-11e9-a2a3-2a2ae2dbcce5",
"expires": "2012-04-23T18:25:43.511Z",
"implicitUnsubscribe": false,
"dnn": "sasa",
"singleNssai": {
"sd": "651Bf9",
"sst": 23
},
"callbackReference": "udr",
"amfServiceName": "nnrf-nfm",
"monitoredResourceUris": [
"http://localhost:8080/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"plmnId": {
"mnc": "124",
"mcc": "123"
},
"subscriptionId": "sa"
},
{
"nfInstanceId": "cb59c48c-a2fa-11e9-a2a3-2a2ae2dbcce5",
"expires": "2012-04-23T18:25:43.511Z",
"implicitUnsubscribe": true,
"dnn": "sasa",
"singleNssai": {
"sd": "651Bf9",
"sst": 23
},
"callbackReference": "https://https://www.google.com",
"amfServiceName": "nnrf-nfm",
"monitoredResourceUris": [
"http://localhost:8080/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"plmnId": {
"mnc": "124",
"mcc": "123"
},
"subscriptionId": "sa"
}
]6.4.12 Post-Output-SubscriptionDataSubscriptions
Following is the Result Code:
{
"supportedFeatures": "f",
"callbackReference": "http://10.75.212.167:8787",
"sdmSubscription": {
"nfInstanceId": "cb59c48c-a2fa-11e9-a2a3-2a2ae2dbcce4",
"expires": "2012-04-23T18:25:43.511Z",
"implicitUnsubscribe": true,
"dnn": "sasb",
"singleNssai": {
"sd": "651Bf9",
"sst": 23
},
"callbackReference": "udr",
"amfServiceName": "nnrf-nfm",
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-919090909010@nai/context-data/amf-3gpp-access"
],
"plmnId": {
"mnc": "124",
"mcc": "123"
},
"subscriptionId": "sa"
},
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"originalCallbackReference": "http://10.75.212.167:8787",
"expiry": "2020-01-02T08:17:14.090Z",
"subscriptionId": "7",
"ueId": "nai-990991@nai"
}6.4.13 Get-Output-SubscriptionDataSubscriptions
Following is the Result Code:
[
{
"supportedFeatures": "f",
"callbackReference": "http://mlu-pcf-api-gateway.mlu-pcf.svc/user-service/userservice/notification/imsi-1111111111",
"monitoredResourceUris": [
"http://localhost:8080/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"originalCallbackReference": "http://mlu-pcf-api-gateway.mlu-pcf.svc/user-service/userservice/notification/imsi-1111111111",
"expiry": "2020-01-02T08:17:14.090Z",
"subscriptionId": "2",
"ueId": "nai-990991@nai"
},
{
"supportedFeatures": "f",
"callbackReference": "http://10.75.212.167:8787",
"sdmSubscription": {
"supportedFeatures": "f",
"callbackReference": "http://10.75.212.167:8787",
"sdmSubscription": true,
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"originalCallbackReference": "http://10.75.212.167:8787",
"expiry": "2020-01-02T08:17:14.090Z",
"subscriptionId": "7",
"ueId": "nai-990991@nai"
},
"monitoredResourceUris": [
"http://sims-udr-2-udr-simulator.sims-udr-2:5807/nudr-dr/v2/subscription-data/nai-990991@nai/context-data/amf-3gpp-access"
],
"originalCallbackReference": "http://10.75.212.167:8787",
"expiry": "2020-01-02T08:17:14.090Z",
"subscriptionId": "7",
"ueId": "nai-990991@nai"
}
]6.4.14 GET - AccessAndMobilitySubscriptionData
{
"gpsis": [
"msisdn-1585632",
"msisdn-2969851"
],
"nssai": {
"singleNssais": [
{
"sd": "abc789",
"sst": 3
},
{
"sd": "abc799",
"sst": 5
}
],
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"defaultSingleNssais": [
{
"sd": "abc123",
"sst": 1
},
{
"sd": "abc124",
"sst": 2
}
]
},
"sorInfo": {
"ackInd": true,
"countersor": "8ebc",
"sorMacIausf": "Bf85A791dCCDa7D6d9754264F02EDcBc",
"provisioningTime": "2012-04-23T18:25:43.511Z",
"steeringContainer": [
{
"plmnId": {
"mcc": "123",
"mnc": "456"
},
"accessTechList": [
"NR"
]
}
]
},
"upuInfo": {
"upuAckInd": true,
"upuRegInd": true,
"counterUpu": "3Ab5",
"upuDataList": [
{
"secPacket": "aGVsbG8="
}
],
"upuMacIausf": "E0b0cCF4EcCC5CA55DBfeA3B2Ad3aE80",
"provisioningTime": "2012-04-23T18:25:43.511Z"
},
"rfspIndex": 123,
"activeTime": 3,
"mcsPriority": true,
"micoAllowed": true,
"mpsPriority": true,
"ueUsageType": 9,
"subsRegTimer": 2,
"dlPacketCount": -1,
"forbiddenAreas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
],
"ratRestrictions": [
"NR",
"WLAN",
"EUTRA",
"VIRTUAL"
],
"sharedAmDataIds": [
"62626-esp}W3A?hIgZ{47Qiuuj@GR:Ped>@k`Px,76390-Cd[s[TECI"
],
"internalGroupIds": [
"E1465DF5-483-159-Fc23DE491edb354dABAa",
"51e851ea-577-297-Ef4d7Cf28CaC0D"
],
"subscribedUeAmbr": {
"uplink": "123 Gbps",
"downlink": "12 Gbps"
},
"odbPacketServices": "ALL_PACKET_SERVICES",
"subscribedDnnList": [
"hello",
"ocudr"
],
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"serviceAreaRestriction": {
"areas": [
{
"tacs": [
"d11fdA",
"EcccaD"
]
}
],
"maxNumOfTAs": 23,
"restrictionType": "ALLOWED_AREAS"
},
"coreNetworkTypeRestrictions": [
"5GC",
"EPC"
]
}The output of Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data/am-data?fields=gpsis,nssai,sorInfo is:
{
"nssai": {
"supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
"defaultSingleNssais": [
{
"sd": "abc123",
"sst": 1
},
{
"sd": "abc124",
"sst": 2
}
],
"singleNssais": [
{
"sd": "abc789",
"sst": 3
},
{
"sd": "abc799",
"sst": 5
}
]
},
"gpsis": [
"msisdn-1585632",
"msisdn-2969851"
],
"sorInfo": {
"sorMacIausf": "Bf85A791dCCDa7D6d9754264F02EDcBc",
"steeringContainer": [
{
"plmnId": {
"mnc": "456",
"mcc": "123"
},
"accessTechList": [
"NR"
]
}
],
"provisioningTime": "2012-04-23T18:25:43.511Z",
"countersor": "8ebc",
"ackInd": true
}
}6.4.15 GET-AuthenticationSubscriptionData
{
"encOpcKey": "ABED",
"encTopcKey": "ACED",
"algorithmId": "algoID",
"sequenceNumber": {
"sqn": "123456789ABE",
"difSign": "NEGATIVE",
"indLength": 5,
"sqnScheme": "GENERAL",
"lastIndexes": {
"ausf": 5
}
},
"encPermanentKey": "ABBA",
"authenticationMethod": "5G_AKA",
"protectionParameterId": "ProtecID",
"authenticationManagementField": "ABBE"
}6.4.16 PATCH-AuthenticationSubscriptionData
case1: REPLACE
[{
"op" : "replace",
"path" : "/sequenceNumber/sqn",
"value" : "123456789ABC"
}]
case2: ADD
case3: REMOVE
6.5 Payload Reference for Overload Control
This section provides payload details for the following Overload Control operations.
6.5.1 PUT - OC Discard Policy
Sample OC Discard Policy Payload on Ingress Gateway:
[
{
"name": "OCDP1",
"scheme": "PercentageBased",
"policies": [
{
"level": "L1",
"value": 0,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error429"
},
{
"level": "L2",
"value": 5,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error429"
},
{
"level": "L3",
"value": 15,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error429"
},
{
"level": "L4",
"value": 25,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error503"
}
]
},
{
"name": "OCDP2",
"scheme": "PriorityBased",
"policies": [
{
"level": "L1",
"value": 30,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error429"
},
{
"level": "L2",
"value": 24,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error429"
},
{
"level": "L3",
"value": 15,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error429"
},
{
"level": "L4",
"value": 10,
"action": "RejectWithErrorCode",
"errorCodeProfile": "error503"
}
]
}
]6.5.2 PUT - Routes Configuration
Sample PUT - Routes Configuration Payload:
[
{
"id": "traffic_mapping_http",
"rateLimiting": {
"methods": [
{
"name": "PATCH",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "GET",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "PUT",
"rate": 300,
"rateLimitPolicy": "R1"
},
{
"name": "DELETE",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "POST",
"rate": 200,
"rateLimitPolicy": "R1"
}]
},
"failureReqCountErrorCodeSeriesId": "P1"
},
{
"id": "traffic_mapping_http_prov",
"rateLimiting": {
"methods": [
{
"name": "PATCH",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "GET",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "PUT",
"rate": 300,
"rateLimitPolicy": "R1"
},
{
"name": "DELETE",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "POST",
"rate": 200,
"rateLimitPolicy": "R1"
}]
},
"failureReqCountErrorCodeSeriesId": "P1"
},
{
"id": "traffic_mapping_http_group",
"rateLimiting": {
"methods": [
{
"name": "GET",
"rate": 1500,
"rateLimitPolicy": "R1"
}]
},
"failureReqCountErrorCodeSeriesId": "P1"
},
{
"id": "traffic_mapping_http_group_prov",
"rateLimiting": {
"methods": [
{
"name": "GET",
"rate": 800,
"rateLimitPolicy": "R1"
},
{
"name": "PUT",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "DELETE",
"rate": 200,
"rateLimitPolicy": "R1"
}]
},
"failureReqCountErrorCodeSeriesId": "P1"
},
{
"id": "traffic_mapping_http_slf_group_prov",
"rateLimiting": {
"methods": [
{
"name": "GET",
"rate": 800,
"rateLimitPolicy": "R1"
},
{
"name": "PUT",
"rate": 200,
"rateLimitPolicy": "R1"
},
{
"name": "DELETE",
"rate": 200,
"rateLimitPolicy": "R1"
}]
},
"failureReqCountErrorCodeSeriesId": "P1"
}
]6.5.3 PUT - Overload Threshold Configuration
Sample: PUT - Overload Threshold Configuration Payload
[
{
"svcName": "ocudr-nudr-drservice",
"metricsThresholdList": [
{
"metricsName": "svc_failure_count",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 13000,
"abatementValue": 12500
},
{
"level": "L2",
"onsetValue": 14000,
"abatementValue": 13500
},
{
"level": "L3",
"onsetValue": 15000,
"abatementValue": 14500
},
{
"level": "L4",
"onsetValue": 16000,
"abatementValue": 15500
}
]
},
{
"metricsName": "memory",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 50,
"abatementValue": 45
},
{
"level": "L2",
"onsetValue": 70,
"abatementValue": 65
},
{
"level": "L3",
"onsetValue": 85,
"abatementValue": 82
},
{
"level": "L4",
"onsetValue": 90,
"abatementValue": 88
}
]
},
{
"metricsName": "cpu",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 65,
"abatementValue": 60
},
{
"level": "L2",
"onsetValue": 75,
"abatementValue": 70
},
{
"level": "L3",
"onsetValue": 80,
"abatementValue": 75
},
{
"level": "L4",
"onsetValue": 90,
"abatementValue": 85
}
]
},
{
"metricsName": "svc_pending_count",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 13000,
"abatementValue": 12500
},
{
"level": "L2",
"onsetValue": 14000,
"abatementValue": 13500
},
{
"level": "L3",
"onsetValue": 15000,
"abatementValue": 14500
},
{
"level": "L4",
"onsetValue": 16000,
"abatementValue": 15500
}
]
}
]
},
{
"svcName": "ocudr-nudr-dr-provservice",
"metricsThresholdList": [
{
"metricsName": "svc_failure_count",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 13000,
"abatementValue": 12500
},
{
"level": "L2",
"onsetValue": 14000,
"abatementValue": 13500
},
{
"level": "L3",
"onsetValue": 15000,
"abatementValue": 14500
},
{
"level": "L4",
"onsetValue": 16000,
"abatementValue": 15500
}
]
},
{
"metricsName": "memory",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 50,
"abatementValue": 45
},
{
"level": "L2",
"onsetValue": 70,
"abatementValue": 65
},
{
"level": "L3",
"onsetValue": 85,
"abatementValue": 82
},
{
"level": "L4",
"onsetValue": 90,
"abatementValue": 88
}
]
},
{
"metricsName": "cpu",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 65,
"abatementValue": 60
},
{
"level": "L2",
"onsetValue": 75,
"abatementValue": 70
},
{
"level": "L3",
"onsetValue": 80,
"abatementValue": 75
},
{
"level": "L4",
"onsetValue": 90,
"abatementValue": 85
}
]
},
{
"metricsName": "svc_pending_count",
"levelThresholdList": [
{
"level": "L1",
"onsetValue": 13000,
"abatementValue": 12500
},
{
"level": "L2",
"onsetValue": 14000,
"abatementValue": 13500
},
{
"level": "L3",
"onsetValue": 15000,
"abatementValue": 14500
},
{
"level": "L4",
"onsetValue": 16000,
"abatementValue": 15500
}
]
}
]
} ]6.5.4 PUT - Error Code Profiles
Sample - PUT Error Code Profiles Payload:
[
{
"name": "error429",
"errorCode": 429,
"errorCause": "Too many reequests",
"errorTitle": "Too many reequests",
"redirectURL": "",
"retry-after": "",
"errorDescription": "Too many reequests"
},
{
"name": "error503",
"errorCode": 503,
"errorCause": "Backend not able to handle traffic",
"errorTitle": "Backend not able to handle traffic",
"redirectURL": "",
"retry-after": "",
"errorDescription": "Backend not able to handle traffic"
}
]6.6 Payload Reference for PCF Schema Management
The PCF Schema Management APIs includes:
6.6.1 PCF Schema Management - PUT
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"type": "object",
"properties": {
"subscCats": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"custom": {
"type": "string"
},
"praInfos": {
"patternProperties": {
"^(.*)$": {
"additionalProperties": false,
"type": "object",
"properties": {
"ecgiList": {
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"plmnId",
"eutraCellId"
],
"properties": {
"eutraCellId": {
"pattern": "^[A-Fa-f0-9]{7}$",
"type": "string"
},
"plmnId": {
"additionalProperties": false,
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
}
}
}
},
"globalRanNodeIdList": {
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"plmnId"
],
"properties": {
"gNbId": {
"additionalProperties": false,
"type": "object",
"required": [
"bitLength",
"gNbValue"
],
"properties": {
"bitLength": {
"type": "integer"
},
"gNbValue": {
"pattern": "^[A-Fa-f0-9]{6,8}$",
"type": "string"
}
}
},
"plmnId": {
"additionalProperties": false,
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
},
"n3IwfId": {
"pattern": "^[A-Fa-f0-9]+$",
"type": "string"
},
"ngeNbId": {
"pattern": "^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$",
"type": "string"
}
}
}
},
"praId": {
"type": "string"
},
"ncgiList": {
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"plmnId",
"nrCellId"
],
"properties": {
"plmnId": {
"additionalProperties": false,
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
},
"nrCellId": {
"pattern": "^[A-Fa-f0-9]{9}$",
"type": "string"
}
}
}
},
"trackingAreaList": {
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"plmnId",
"tac"
],
"properties": {
"tac": {
"default": "",
"pattern": "(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)",
"type": "string"
},
"plmnId": {
"additionalProperties": false,
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
}
}
}
}
}
}
},
"additionalProperties": false
}
}
}6.6.2 PCF Schema Management - PUT (VSA)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"subscriber": {
"patternProperties": {
"^(?i)accountid$": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"pattern": "^[a-zA-Z0-9]{1,36}$",
"type": "string"
}
},
"^(?i)imsi$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)msisdn$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)nai$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^.+$",
"type": "string"
}
},
"^(?i)extid$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "[^@]+@[^@]+$",
"type": "string"
}
}
},
"type": "object",
"properties": {
"Tier": {
"type": "string"
},
"BillingDay": {
"maximum": 31,
"type": "integer",
"minimum": 1
},
"Entitlement": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"usage": {
"additionalProperties": false,
"type": "object",
"properties": {
"quota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"totalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"nextResetTime": {
"type": "string"
},
"time": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"outputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"inputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"serviceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"cid": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"definition": {
"additionalProperties": false,
"type": "object",
"properties": {
"DynamicQuota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"InstanceId": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Priority": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialInputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Duration": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InterimReportingInterval": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialOutputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Type": {
"type": "string"
},
"activationdatetime": {
"type": "string"
},
"expirationdatetime": {
"type": "string"
},
"InitialTotalVolume": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
},
"name": {
"type": "string"
},
"InitialServiceSpecific": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
},
"InitialTime": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "string"
},
"version": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"property": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"additionalProperties": false,
"version": {
"type": "integer"
}
}
}
}
}6.6.3 PCF Schema Management - GET (VSA)
VSA_GET_CURRENT_SCHEMA
{
"type": "object",
"properties": {
"subscriber": {
"patternProperties": {
"^(?i)accountid$": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"pattern": "^[a-zA-Z0-9]{1,36}$",
"type": "string"
}
},
"^(?i)imsi$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)msisdn$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)nai$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^.+$",
"type": "string"
}
},
"^(?i)extid$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "[^@]+@[^@]+$",
"type": "string"
}
}
},
"type": "object",
"properties": {
"Tier": {
"type": "string"
},
"BillingDay": {
"maximum": 31,
"type": "integer",
"minimum": 1
},
"Entitlement": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"usage": {
"additionalProperties": false,
"type": "object",
"properties": {
"quota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"totalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"nextResetTime": {
"type": "string"
},
"time": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"outputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"inputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"serviceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"cid": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"definition": {
"additionalProperties": false,
"type": "object",
"properties": {
"DynamicQuota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"InstanceId": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Priority": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialInputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Duration": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InterimReportingInterval": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialOutputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Type": {
"type": "string"
},
"activationdatetime": {
"type": "string"
},
"expirationdatetime": {
"type": "string"
},
"InitialTotalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"InitialServiceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialTime": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"property": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"additionalProperties": false,
"version": {
"type": "integer"
}
}
}
}
}6.6.4 PCF Schema Management - VSA GET ALL SCHEMA
VSA_GET_ALL_SCHEMA
{
"current": "v1",
"v0": {
"type": "object",
"properties": {
"subscriber": {
"patternProperties": {
"^(?i)accountid$": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"pattern": "^[a-zA-Z0-9]{1,36}$",
"type": "string"
}
},
"^(?i)imsi$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)msisdn$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)nai$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^.+$",
"type": "string"
}
},
"^(?i)extid$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "[^@]+@[^@]+$",
"type": "string"
}
}
},
"type": "object",
"properties": {
"Tier": {
"type": "string"
},
"BillingDay": {
"maximum": 31,
"type": "integer",
"minimum": 1
},
"Entitlement": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"usage": {
"additionalProperties": false,
"type": "object",
"properties": {
"quota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"totalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"nextResetTime": {
"type": "string"
},
"time": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"outputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"inputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"serviceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"cid": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"definition": {
"additionalProperties": false,
"type": "object",
"properties": {
"DynamicQuota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"InstanceId": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Priority": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialInputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Duration": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InterimReportingInterval": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialOutputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Type": {
"type": "string"
},
"activationdatetime": {
"type": "string"
},
"expirationdatetime": {
"type": "string"
},
"InitialTotalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"InitialServiceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialTime": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"property": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"additionalProperties": false,
"version": {
"type": "integer"
}
}
}
}
},
"v1": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"subscriber": {
"patternProperties": {
"^(?i)accountid$": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"pattern": "^[a-zA-Z0-9]{1,36}$",
"type": "string"
}
},
"^(?i)imsi$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)msisdn$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)nai$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^.+$",
"type": "string"
}
},
"^(?i)extid$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "[^@]+@[^@]+$",
"type": "string"
}
}
},
"type": "object",
"properties": {
"Tier": {
"type": "string"
},
"BillingDay": {
"maximum": 31,
"type": "integer",
"minimum": 1
},
"Entitlement": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"usage": {
"additionalProperties": false,
"type": "object",
"properties": {
"quota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"totalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"nextResetTime": {
"type": "string"
},
"time": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"outputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"inputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"serviceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"cid": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"definition": {
"additionalProperties": false,
"type": "object",
"properties": {
"DynamicQuota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"InstanceId": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Priority": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialInputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Duration": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InterimReportingInterval": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialOutputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Type": {
"type": "string"
},
"activationdatetime": {
"type": "string"
},
"expirationdatetime": {
"type": "string"
},
"InitialTotalVolume": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
},
"name": {
"type": "string"
},
"InitialServiceSpecific": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
},
"InitialTime": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "string"
},
"version": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"property": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"additionalProperties": false,
"version": {
"type": "integer"
}
}
}
}
}
}6.6.5 PCF Schema Management - VSA GET V1
VSA_GET_V1
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"subscriber": {
"patternProperties": {
"^(?i)accountid$": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"pattern": "^[a-zA-Z0-9]{1,36}$",
"type": "string"
}
},
"^(?i)imsi$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)msisdn$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^[0-9]{5,15}$",
"type": "string"
}
},
"^(?i)nai$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "^.+$",
"type": "string"
}
},
"^(?i)extid$": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"pattern": "[^@]+@[^@]+$",
"type": "string"
}
}
},
"type": "object",
"properties": {
"Tier": {
"type": "string"
},
"BillingDay": {
"maximum": 31,
"type": "integer",
"minimum": 1
},
"Entitlement": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"usage": {
"additionalProperties": false,
"type": "object",
"properties": {
"quota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"totalVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"name": {
"type": "string"
},
"nextResetTime": {
"type": "string"
},
"time": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"outputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"inputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"serviceSpecific": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"cid": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
},
"definition": {
"additionalProperties": false,
"type": "object",
"properties": {
"DynamicQuota": {
"type": "array",
"items": {
"type": "object",
"properties": {
"InstanceId": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Priority": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialInputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Duration": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InterimReportingInterval": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"InitialOutputVolume": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"Type": {
"type": "string"
},
"activationdatetime": {
"type": "string"
},
"expirationdatetime": {
"type": "string"
},
"InitialTotalVolume": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
},
"name": {
"type": "string"
},
"InitialServiceSpecific": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
},
"InitialTime": {
"pattern": "^[x20-x7e]{0,25}$",
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "string"
},
"version": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"property": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"pattern": "^[x20-x7e]{0,255}$",
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"SequenceNumber": {
"type": "integer"
},
"additionalProperties": false,
"version": {
"type": "integer"
}
}
}
}
}6.6.6 PUT Profile Data
To add a new field "customFieldKey" for
profile-data.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"profile-fields": {
"type": "object",
"properties": {
"customFieldKey": {
"type": "string"
}
}
}
},
"patternProperties": {
"^(?i)nai$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^.+$"
},
"maxItems": 5,
"minItems": 1
},
"^(?i)imsi$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9]{5,15}$"
},
"maxItems": 5,
"minItems": 1
},
"^(?i)extid$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$"
},
"maxItems": 5,
"minItems": 1
},
"^(?i)msisdn$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9]{5,15}$"
},
"maxItems": 5,
"minItems": 1
},
"^(?i)imei$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9]{14,15}$"
},
"maxItems": 1,
"minItems": 1
},
"^(?i)imeisv$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9]{16}$"
},
"maxItems": 1,
"minItems": 1
},
"^(?i)accountid$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,36}$"
},
"maxItems": 1,
"minItems": 1
},
"^(?i)pei$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(imei-[0-9]{14,15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8}))$"
},
"maxItems": 1,
"minItems": 1
},
"^(?i)supi$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+)$"
},
"maxItems": 1,
"minItems": 1
},
"^(?i)gpsi$": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+)$"
},
"maxItems": 1,
"minItems": 1
}
},
"additionalProperties": false
}6.6.7 PUT - sm-data schema
To remove mandatory parameter for
sm-data:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["smPolicySnssaiData"],
"properties": {
"umData": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": ["limitId"],
"properties": {
"allowedUsage": {
"usageLimit": null,
"type": "object",
"properties": {
"duration": {
"type": "integer",
"minimum": 0
},
"totalVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"downlinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"uplinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
}
}
},
"customAllowedUsage": {
"usageLimit": null,
"type": "object",
"properties": {
"duration": {
"type": "integer",
"minimum": 0
},
"totalVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"downlinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"uplinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
}
}
},
"grantedUsage": {
"usageLimit": null,
"type": "object",
"properties": {
"duration": {
"type": "integer",
"minimum": 0
},
"totalVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"downlinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"uplinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
}
}
},
"limitId": {
"type": "string",
"pattern": "[^(?!\\\\s*$).+]{1,}"
},
"scopes": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": ["snssai"],
"properties": {
"snssai": {
"type": "object",
"required": ["sst"],
"properties": {
"sd": {
"pattern": "^[A-Fa-f0-9]{6}$",
"type": "string"
},
"sst": {
"maximum": 255,
"type": "integer",
"minimum": 0
}
}
},
"dnn": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"type": "object"
},
"umLevel": {
"enum": ["SESSION_LEVEL", "SERVICE_LEVEL"]
},
"resetTime": {
"anyOf": [{
"type": "string",
"format": "date-time"
}, {
"pattern": "^\\\\d{4}\\\\-\\\\d{2}\\\\-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}([Z]|((\\\\+|\\\\-)\\\\d{2}:\\\\d{2}))?$",
"type": "string"
}]
}
}
}
},
"type": "object",
"minProperties": 1
},
"umDataLimits": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": ["limitId"],
"properties": {
"resetPeriod": {
"type": "object",
"required": ["period"],
"properties": {
"period": {
"enum": ["YEARLY", "MONTHLY", "WEEKLY", "DAILY", "HOURLY"]
},
"maxNumPeriod": {
"type": "integer",
"minimum": 0
}
}
},
"endDate": {
"anyOf": [{
"type": "string",
"format": "date-time"
}, {
"pattern": "^\\\\d{4}\\\\-\\\\d{2}\\\\-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}([Z]|((\\\\+|\\\\-)\\\\d{2}:\\\\d{2}))?$",
"type": "string"
}]
},
"usageLimit": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"minimum": 0
},
"totalVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"downlinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"uplinkVolume": {
"format": "int64",
"type": "integer",
"minimum": 0
}
}
},
"limitId": {
"type": "string",
"pattern": "[^(?!\\\\s*$).+]{1,}"
},
"Type": {
"type": "string"
},
"name": {
"type": "string"
},
"priority": {
"type": "string"
},
"initialServiceSpecific": {
"format": "int64",
"type": "integer",
"minimum": 0
},
"scopes": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": ["snssai"],
"properties": {
"snssai": {
"type": "object",
"required": ["sst"],
"properties": {
"sd": {
"pattern": "^[A-Fa-f0-9]{6}$",
"type": "string"
},
"sst": {
"maximum": 255,
"type": "integer",
"minimum": 0
}
}
},
"dnn": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"type": "object"
},
"umLevel": {
"enum": ["SESSION_LEVEL", "SERVICE_LEVEL"]
},
"startDate": {
"anyOf": [{
"type": "string",
"format": "date-time"
}, {
"pattern": "^\\\\d{4}\\\\-\\\\d{2}\\\\-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}([Z]|((\\\\+|\\\\-)\\\\d{2}:\\\\d{2}))?$",
"type": "string"
}]
},
"activationdatetime": {
"anyOf": [{
"type": "string",
"format": "date-time"
}, {
"pattern": "^\\\\d{4}\\\\-\\\\d{2}\\\\-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}([Z]|((\\\\+|\\\\-)\\\\d{2}:\\\\d{2}))?$",
"type": "string"
}]
},
"validityDuration": {
"type": "integer",
"minimum": 0
},
"InterimReportingInterval": {
"type": "string"
}
}
}
},
"type": "object"
},
"suppFeat": {
"pattern": "^[A-Fa-f0-9]*$",
"type": "string"
},
"smPolicySnssaiData": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": ["snssai"],
"properties": {
"smPolicyDnnData": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": ["dnn"],
"properties": {
"adcSupport": {
"type": "boolean"
},
"dnn": {
"type": "string"
},
"ipv4Index": {
"type": "integer"
},
"gbrDl": {
"pattern": "^\\\\d+(\\\\.\\\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$",
"type": "string"
},
"mcsPriority": {
"type": "boolean"
},
"subscSpendingLimits": {
"type": "boolean"
},
"mcsPriorityLevel": {
"type": "integer"
},
"chfInfo": {
"type": "object",
"required": ["primaryChfAddress", "secondaryChfAddress"],
"properties": {
"secondaryChfAddress": {
"type": "string"
},
"primaryChfAddress": {
"type": "string"
}
}
},
"praInfos": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"properties": {
"ecgiList": {
"minItems": 1,
"type": "array",
"items": {
"nullable": true,
"type": "object",
"required": ["plmnId", "eutraCellId"],
"properties": {
"eutraCellId": {
"pattern": "^[A-Fa-f0-9]{7}$",
"type": "string"
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": ["mcc", "mnc"],
"properties": {
"mnc": {
"pattern": "^\\\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\\\d{3}$",
"type": "string"
}
}
}
}
}
},
"globalRanNodeIdList": {
"minItems": 1,
"type": "array",
"items": {
"oneOf": [{
"required": ["n3IwfId"]
}, {
"required": ["gNbId"]
}, {
"required": ["ngeNbId"]
}, {
"required": ["eNbId"]
}],
"type": "object",
"required": ["plmnId"],
"properties": {
"eNbId": {
"pattern": "^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$",
"type": "string"
},
"gNbId": {
"type": "object",
"required": ["bitLength", "gNbValue"],
"properties": {
"bitLength": {
"maximum": 32,
"type": "integer",
"minimum": 22
},
"gNbValue": {
"pattern": "^[A-Fa-f0-9]{6,8}$",
"type": "string"
}
}
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": ["mcc", "mnc"],
"properties": {
"mnc": {
"pattern": "^\\\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\\\d{3}$",
"type": "string"
}
}
},
"n3IwfId": {
"pattern": "^[A-Fa-f0-9]+$",
"type": "string"
},
"ngeNbId": {
"pattern": "^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$",
"type": "string"
}
}
}
},
"presenceState": {
"enum": ["IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE"]
},
"praId": {
"type": "string"
},
"ncgiList": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"required": ["plmnId", "nrCellId"],
"properties": {
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": ["mcc", "mnc"],
"properties": {
"mnc": {
"pattern": "^\\\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\\\d{3}$",
"type": "string"
}
}
},
"nrCellId": {
"pattern": "^[A-Fa-f0-9]{9}$",
"type": "string"
}
}
}
},
"trackingAreaList": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"required": ["plmnId", "tac"],
"properties": {
"tac": {
"pattern": "(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)",
"type": "string"
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": ["mcc", "mnc"],
"properties": {
"mnc": {
"pattern": "^\\\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\\\d{3}$",
"type": "string"
}
}
}
}
}
},
"globaleNbIdList": {
"minItems": 1,
"type": "array",
"items": {
"oneOf": [{
"required": ["n3IwfId"]
}, {
"required": ["gNbId"]
}, {
"required": ["ngeNbId"]
}, {
"required": ["eNbId"]
}],
"type": "object",
"required": ["plmnId"],
"properties": {
"eNbId": {
"pattern": "^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$",
"type": "string"
},
"gNbId": {
"type": "object",
"required": ["bitLength", "gNbValue"],
"properties": {
"bitLength": {
"maximum": 32,
"type": "integer",
"minimum": 22
},
"gNbValue": {
"pattern": "^[A-Fa-f0-9]{6,8}$",
"type": "string"
}
}
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": ["mcc", "mnc"],
"properties": {
"mnc": {
"pattern": "^\\\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\\\d{3}$",
"type": "string"
}
}
},
"n3IwfId": {
"pattern": "^[A-Fa-f0-9]+$",
"type": "string"
},
"ngeNbId": {
"pattern": "^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$",
"type": "string"
}
}
}
}
}
}
},
"minProperties": 1
},
"refUmDataLimitIds": {
"patternProperties": {
"^(.*)$": {
"nullable": true,
"type": "object",
"required": ["limitId"],
"properties": {
"monkey": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"limitId": {
"type": "string",
"pattern": "[^(?!\\\\s*$).+]{1,}"
}
}
}
},
"type": "object",
"minProperties": 1
},
"bdtRefIds": {
"patternProperties": {
"^(.*)$": {
"nullable": true,
"type": "string"
}
},
"nullable": true,
"type": "object",
"minProperties": 1
},
"offline": {
"type": "boolean"
},
"allowedServices": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"mpsPriority": {
"type": "boolean"
},
"imsSignallingPrio": {
"type": "boolean"
},
"gbrUl": {
"pattern": "^\\\\d+(\\\\.\\\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$",
"type": "string"
},
"subscCats": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"online": {
"type": "boolean"
},
"ipv6Index": {
"type": "integer"
},
"mpsPriorityLevel": {
"type": "integer"
}
}
}
},
"type": "object"
},
"snssai": {
"type": "object",
"required": ["sst"],
"properties": {
"sd": {
"pattern": "^[A-Fa-f0-9]{6}$",
"type": "string"
},
"sst": {
"maximum": 255,
"type": "integer",
"minimum": 0
}
}
}
}
}
},
"type": "object",
"minProperties": 1
}
}
}6.6.8 PUT-ue-policy-set schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"uePolicySections": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": [
"uePolicySectionInfo",
"upsi"
],
"properties": {
"uePolicySectionInfo": {
"format": "byte",
"type": "string"
},
"upsi": {
"type": "string"
}
}
}
},
"type": "object",
"minProperties": 1
},
"pei": {
"pattern": "^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})|.+)$",
"type": "string"
},
"osIds": {
"minItems": 1,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"upsis": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"andspInd": {
"type": "boolean"
},
"subscCats": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"allowedRouteSelDescs": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": [
"servingPlmn"
],
"properties": {
"servingPlmn": {
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
},
"snssaiRouteSelDescs": {
"type": "array",
"items": {
"type": "object",
"required": [
"snssai"
],
"properties": {
"snssai": {
"type": "object",
"required": [
"sst"
],
"properties": {
"sd": {
"pattern": "^[A-Fa-f0-9]{6}$",
"type": "string"
},
"sst": {
"maximum": 255,
"type": "integer",
"minimum": 0
}
}
},
"dnnRouteSelDescs": {
"type": "array",
"items": {
"type": "object",
"required": [
"dnn"
],
"properties": {
"pduSessTypes": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"IPV4",
"IPV6",
"IPV4V6",
"UNSTRUCTURED",
"ETHERNET"
]
}
},
"dnn": {
"type": "string"
},
"sscModes": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"SSC_MODE_1",
"SSC_MODE_2",
"SSC_MODE_3"
]
}
}
}
}
}
}
}
}
}
}
},
"type": "object",
"minProperties": 1
},
"praInfos": {
"patternProperties": {
"^(.*)$": {
"type": "object",
"properties": {
"ecgiList": {
"minItems": 1,
"type": "array",
"items": {
"nullable": true,
"type": "object",
"required": [
"plmnId",
"eutraCellId"
],
"properties": {
"eutraCellId": {
"pattern": "^[A-Fa-f0-9]{7}$",
"type": "string"
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
}
}
}
},
"globalRanNodeIdList": {
"minItems": 1,
"type": "array",
"items": {
"oneOf": [
{
"required": [
"n3IwfId"
]
},
{
"required": [
"gNbId"
]
},
{
"required": [
"ngeNbId"
]
},
{
"required": [
"eNbId"
]
}
],
"type": "object",
"required": [
"plmnId"
],
"properties": {
"eNbId": {
"pattern": "^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$",
"type": "string"
},
"gNbId": {
"type": "object",
"required": [
"bitLength",
"gNbValue"
],
"properties": {
"bitLength": {
"maximum": 32,
"type": "integer",
"minimum": 22
},
"gNbValue": {
"pattern": "^[A-Fa-f0-9]{6,8}$",
"type": "string"
}
}
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
},
"n3IwfId": {
"pattern": "^[A-Fa-f0-9]+$",
"type": "string"
},
"ngeNbId": {
"pattern": "^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$",
"type": "string"
}
}
}
},
"presenceState": {
"enum": [
"IN_AREA",
"OUT_OF_AREA",
"UNKNOWN",
"INACTIVE"
]
},
"praId": {
"type": "string"
},
"ncgiList": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"required": [
"plmnId",
"nrCellId"
],
"properties": {
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
},
"nrCellId": {
"pattern": "^[A-Fa-f0-9]{9}$",
"type": "string"
}
}
}
},
"trackingAreaList": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"required": [
"plmnId",
"tac"
],
"properties": {
"tac": {
"pattern": "(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)",
"type": "string"
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
}
}
}
},
"globaleNbIdList": {
"minItems": 1,
"type": "array",
"items": {
"oneOf": [
{
"required": [
"n3IwfId"
]
},
{
"required": [
"gNbId"
]
},
{
"required": [
"ngeNbId"
]
},
{
"required": [
"eNbId"
]
}
],
"type": "object",
"required": [
"plmnId"
],
"properties": {
"eNbId": {
"pattern": "^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$",
"type": "string"
},
"gNbId": {
"type": "object",
"required": [
"bitLength",
"gNbValue"
],
"properties": {
"bitLength": {
"maximum": 32,
"type": "integer",
"minimum": 22
},
"gNbValue": {
"pattern": "^[A-Fa-f0-9]{6,8}$",
"type": "string"
}
}
},
"nid": {
"pattern": "^[A-Fa-f0-9]{13}$",
"type": "string"
},
"plmnId": {
"type": "object",
"required": [
"mcc",
"mnc"
],
"properties": {
"mnc": {
"pattern": "^\\d{2,3}$",
"type": "string"
},
"mcc": {
"pattern": "^\\d{3}$",
"type": "string"
}
}
},
"n3IwfId": {
"pattern": "^[A-Fa-f0-9]+$",
"type": "string"
},
"ngeNbId": {
"pattern": "^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$",
"type": "string"
}
}
}
}
}
}
},
"type": "object",
"minProperties": 1
}
}
}6.7 SLF Schema Management - PUT (SLF)
SLF_GROUP_PROV_SCHEMA
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"nfGroupIDs",
"slfGroupName",
"slfGroupType"
],
"properties": {
"nfGroupIDs": {
"type": "object",
"propertyNames": {
"enum": [
"NRF",
"UDM",
"AMF",
"SMF",
"AUSF",
"NEF",
"PCF",
"SMSF",
"NSSF",
"UDR",
"LMF",
"GMLC",
"5G_EIR",
"SEPP",
"UPF",
"N3IWF",
"AF",
"UDSF",
"BSF",
"CHF",
"NWDAF",
"PCSCF",
"CBCF",
"HSS",
"UCMF"
],
"type": "string"
},
"patternProperties": {
"": {
"type": "string",
"minLength": 1
}
},
"minProperties": 1
},
"slfGroupName": {
"type": "string",
"minLength": 1
},
"slfGroupType": {
"enum": [
"ImsHss",
"LteHss",
"Pcrf",
"Ocs",
"Ofcs",
"Aaa",
"UserDef1",
"UserDef2"
],
"type": "string"
},
"expiry": {
"format": "date-time",
"type": "string"
}
},
"additionalProperties": false
}6.8 Payload Reference for UDM Schema Management
The UDM Schema Management includes:
- UDM Schema Management - PUT (provisioned-data/am-data)
- UDM Schema Management - PUT(provisioned/sm-data)
- UDM Schema Management - PUT (provisioned/smf-selection-subscription-data)
- UDM Schema Management - PUT(provisioned/sms-mng-data)
- UDM Schema Management - PUT(provisioned/trace-data)
- UDM Schema Management - PUT(provisioned/sms-data)
6.8.1 UDM Schema Management - PUT (provisioned-data/am-data)
Schema for
provisioned/am-data
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"custom": {
"type": "string"
},
"gpsis": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$"
}
},
"nssai": {
"type": "object",
"nullable": true,
"required": ["defaultSingleNssais"],
"properties": {
"singleNssais": {
"type": "array",
"items": {
"type": "object",
"required": ["sst"],
"properties": {
"sd": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{6}$"
},
"sst": {
"type": "integer",
"maximum": 255,
"minimum": 0
}
},
"additionalProperties": false
},
"minItems": 1
},
"supportedFeatures": {
"type": "string",
"pattern": "^[A-Fa-f0-9]*$"
},
"defaultSingleNssais": {
"type": "array",
"items": {
"type": "object",
"required": ["sst"],
"properties": {
"sd": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{6}$"
},
"sst": {
"type": "integer",
"maximum": 255,
"minimum": 0
}
},
"additionalProperties": false
},
"minItems": 1
}
},
"additionalProperties": false
},
"sorInfo": {
"type": "object",
"required": ["ackInd", "provisioningTime"],
"properties": {
"ackInd": {
"type": "boolean"
},
"countersor": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{4}$"
},
"sorMacIausf": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{32}$"
},
"provisioningTime": {
"type": "string",
"format": "date-time"
},
"steeringContainer": {
"oneOf": [{
"type": "array",
"items": {
"type": "object",
"required": ["plmnId"],
"properties": {
"plmnId": {
"type": "object",
"required": ["mcc", "mnc"],
"properties": {
"mcc": {
"type": "string",
"pattern": "^[0-9]{3}$"
},
"mnc": {
"type": "string",
"pattern": "^([0-9]{2,3})$"
}
},
"additionalProperties": false
},
"accessTechList": {
"type": "array",
"items": {
"enum": ["NR", "EUTRAN_IN_WBS1_MODE_AND_NBS1_MODE", "EUTRAN_IN_NBS1_MODE_ONLY", "EUTRAN_IN_WBS1_MODE_ONLY", "UTRAN", "GSM_AND_ECGSM_IoT", "GSM_WITHOUT_ECGSM_IoT", "ECGSM_IoT_ONLY", "CDMA_1xRTT", "CDMA_HRPD", "GSM_COMPACT"],
"type": "string"
},
"minItems": 1
}
}
},
"minItems": 1
}, {
"type": "string",
"pattern": "^(.*)$"
}]
}
},
"additionalProperties": false
},
"upuInfo": {
"type": "object",
"required": ["upuDataList", "upuAckInd", "upuRegInd", "provisioningTime"],
"properties": {
"upuAckInd": {
"type": "boolean"
},
"upuRegInd": {
"type": "boolean"
},
"counterUpu": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{4}$"
},
"upuDataList": {
"type": "array",
"items": {
"type": "object",
"oneOf": [{
"required": ["secPacket"]
}, {
"required": ["defaultConfNssai"]
}],
"properties": {
"secPacket": {
"type": "string",
"format": "base64"
}
},
"defaultConfNssai": {
"type": "array",
"items": {
"type": "object",
"required": ["sst"],
"properties": {
"sd": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{6}$"
},
"sst": {
"type": "integer",
"maximum": 255,
"minimum": 0
}
},
"additionalProperties": false
},
"minItems": 1
}
},
"minItems": 1
},
"upuMacIausf": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{32}$"
},
"provisioningTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"rfspIndex": {
"type": "integer",
"maximum": 256,
"minimum": 1,
"nullable": true
},
"activeTime": {
"type": "integer",
"nullable": true
},
"mcsPriority": {
"type": "boolean"
},
"micoAllowed": {
"type": "boolean"
},
"mpsPriority": {
"type": "boolean"
},
"ueUsageType": {
"type": "integer"
},
"subsRegTimer": {
"type": "integer",
"nullable": true
},
"dlPacketCount": {
"type": "integer",
"minimum": -1
},
"forbiddenAreas": {
"type": "array",
"items": {
"type": "object",
"oneOf": [{
"required": ["tacs"]
}, {
"required": ["areaCode"]
}],
"properties": {
"tacs": {
"type": "array",
"items": {
"type": "string",
"pattern": "(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)"
},
"minItems": 1
},
"areaCode": {
"type": "string"
}
},
"additionalProperties": false
}
},
"ratRestrictions": {
"type": "array",
"items": {
"anyOf": [{
"enum": ["NR", "EUTRA", "WLAN", "VIRTUAL"],
"type": "string"
}, {
"type": "string"
}]
}
},
"sharedAmDataIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9]{5,6}-.+$"
},
"minItems": 1
},
"internalGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$"
},
"minItems": 1
},
"subscribedUeAmbr": {
"type": "object",
"properties": {
"uplink": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$"
},
"downlink": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$"
}
},
"additionalProperties": false
},
"odbPacketServices": {
"anyOf": [{
"enum": ["ALL_PACKET_SERVICES", "ROAMER_ACCESS_HPLMN_AP", "ROAMER_ACCESS_VPLMN_AP"],
"type": "string"
}, {
"type": "string",
"nullable": true
}]
},
"subscribedDnnList": {
"type": "array",
"items": {
"type": "string"
}
},
"supportedFeatures": {
"type": "string",
"pattern": "^[A-Fa-f0-9]*$"
},
"serviceAreaRestriction": {
"type": "object",
"allOf": [{
"oneOf": [{
"not": {
"required": ["restrictionType"]
}
}, {
"required": ["areas"]
}]
}, {
"anyOf": [{
"not": {
"required": ["restrictionType"],
"properties": {
"restrictionType": {
"enum": ["NOT_ALLOWED_AREAS"],
"type": "string"
}
}
}
}, {
"not": {
"required": ["maxNumOfTAs"]
}
}]
}, {
"anyOf": [{
"not": {
"required": ["restrictionType"],
"properties": {
"restrictionType": {
"enum": ["ALLOWED_AREAS"],
"type": "string"
}
}
}
}, {
"not": {
"required": ["maxNumOfTAsForNotAllowedAreas"]
}
}]
}],
"properties": {
"areas": {
"type": "array",
"items": {
"type": "object",
"oneOf": [{
"required": ["tacs"]
}, {
"required": ["areaCode"]
}],
"properties": {
"tacs": {
"type": "array",
"items": {
"type": "string",
"pattern": "(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)"
},
"minItems": 1
},
"areaCode": {
"type": "string"
}
},
"additionalProperties": false
}
},
"maxNumOfTAs": {
"type": "integer",
"minimum": 0
},
"restrictionType": {
"anyOf": [{
"enum": ["ALLOWED_AREAS", "NOT_ALLOWED_AREAS"],
"type": "string"
}, {
"type": "string"
}]
},
"maxNumOfTAsForNotAllowedAreas": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"coreNetworkTypeRestrictions": {
"type": "array",
"items": {
"enum": ["5GC", "EPC"],
"type": "string"
}
}
},
"additionalProperties": false
}6.8.2 UDM Schema Management - PUT(provisioned/sm-data)
Schema for provisioned/sm-data
{
"type": "object",
"additionalProperties": false,
"required": [
"singleNssai"
],
"properties": {
"custom": {
"type": "string"
},
"dnnConfigurations": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^(.*)$": {
"type": "object",
"additionalProperties": false,
"required": [
"pduSessionTypes",
"sscModes"
],
"properties": {
"iwkEpsInd": {
"type": "boolean"
},
"sessionAmbr": {
"type": "object",
"additionalProperties": false,
"required": [
"uplink",
"downlink"
],
"properties": {
"uplink": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$"
},
"downlink": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$"
}
}
},
"5gQosProfile": {
"type": "object",
"additionalProperties": false,
"required": [
"5qi",
"arp"
],
"properties": {
"priorityLevel": {
"type": "integer",
"minimum": 1,
"maximum": 127
},
"5qi": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"arp": {
"type": "object",
"additionalProperties": false,
"required": [
"priorityLevel",
"preemptCap",
"preemptVuln"
],
"properties": {
"preemptCap": {
"nullable": true,
"anyOf": [
{
"enum": [
"MAY_PREEMPT",
"NOT_PREEMPT"
],
"type": "string"
},
{
"type": "string"
}
]
},
"priorityLevel": {
"type": "integer",
"minimum": 1,
"maximum": 15,
"description": "nullable true shall not be used for this attribute",
"nullable": true
},
"preemptVuln": {
"nullable": true,
"anyOf": [
{
"type": "string",
"enum": [
"MAY_PREEMPT",
"NOT_PREEMPT"
]
},
{
"type": "string"
}
]
}
}
}
}
},
"upSecurity": {
"type": "object",
"additionalProperties": false,
"required": [
"upIntegr",
"upConfid"
],
"properties": {
"upIntegr": {
"anyOf": [
{
"type": "string",
"enum": [
"PREFERRED",
"REQUIRED",
"NOT_NEEDED"
]
},
{
"type": "string"
}
]
},
"upConfid": {
"anyOf": [
{
"enum": [
"PREFERRED",
"REQUIRED",
"NOT_NEEDED"
],
"type": "string"
},
{
"type": "string"
}
]
}
}
},
"sscModes": {
"type": "object",
"additionalProperties": false,
"required": [
"defaultSscMode"
],
"properties": {
"allowedSscModes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"SSC_MODE_1",
"SSC_MODE_2",
"SSC_MODE_3"
]
},
{
"type": "string"
}
]
}
},
"defaultSscMode": {
"anyOf": [
{
"enum": [
"SSC_MODE_1",
"SSC_MODE_2",
"SSC_MODE_3"
],
"type": "string"
},
{
"type": "string"
}
]
}
}
},
"3gppChargingCharacteristics": {
"type": "string"
},
"pduSessionTypes": {
"type": "object",
"additionalProperties": false,
"required": [
"defaultSessionType"
],
"properties": {
"defaultSessionType": {
"anyOf": [
{
"type": "string",
"enum": [
"IPV4V6",
"IPV6",
"UNSTRUCTURED",
"IPV4",
"ETHERNET"
]
},
{
"type": "string"
}
]
},
"allowedSessionTypes": {
"type": "array",
"items": {
"anyOf": [
{
"enum": [
"IPV4V6",
"IPV6",
"UNSTRUCTURED",
"IPV4",
"ETHERNET"
],
"type": "string"
},
{
"type": "string"
}
]
}
}
}
},
"staticIpAddress": {
"type": "array",
"minItems": 1,
"maxItems": 2,
"items": {
"IpAddress": {
"oneOf": [
{
"required": [
"ipv4Addr"
]
},
{
"required": [
"ipv6Addr"
]
},
{
"required": [
"ipv6Prefix"
]
}
],
"additionalProperties": false,
"type": "object",
"properties": {
"ipv6Addr": {
"type": "string",
"allOf": [
{
"pattern": "^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$"
},
{
"pattern": "^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$"
}
],
"example": "2001:db8:85a3::8a2e:370:7334"
},
"ipv6Prefix": {
"type": "string",
"allOf": [
{
"pattern": "^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$"
},
{
"pattern": "^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\\/.+)$"
}
],
"example": "2001:db8:abcd:12::0/64"
},
"ipv4Addr": {
"pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$",
"type": "string",
"example": "198.51.100.1"
}
}
}
}
}
}
}
}
},
"singleNssai": {
"type": "object",
"additionalProperties": false,
"required": [
"sst"
],
"properties": {
"sd": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{6}$"
},
"sst": {
"type": "integer",
"minimum": 0,
"maximum": 255
}
}
},
"odbPacketServices": {
"nullable": true,
"anyOf": [
{
"enum": [
"ALL_PACKET_SERVICES",
"ROAMER_ACCESS_VPLMN_AP",
"ROAMER_ACCESS_HPLMN_AP"
],
"type": "string"
},
{
"type": "string"
}
]
},
"internalGroupIds": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$"
}
},
"sharedDnnConfigurationsId": {
"type": "string",
"pattern": "^[0-9]{5,6}-.+$"
}
}
}6.8.3 UDM Schema Management - PUT (provisioned/smf-selection-subscription-data)
provisioned/smf-selection-subscription-data
{
"type": "object",
"properties": {
"custom": {
"type": "string"
},
"supportedFeatures": {
"type": "string",
"pattern": "^[A-Fa-f0-9]*$"
},
"sharedSnssaiInfosId": {
"type": "string"
},
"subscribedSnssaiInfos": {
"type": "object",
"patternProperties": {
"^(.*)$": {
"type": "object",
"required": [
"dnnInfos"
],
"properties": {
"dnnInfos": {
"type": "array",
"items": {
"type": "object",
"required": [
"dnn"
],
"properties": {
"dnn": {
"type": "string"
},
"iwkEpsInd": {
"type": "boolean"
},
"lboRoamingAllowed": {
"type": "boolean"
},
"defaultDnnIndicator": {
"type": "boolean"
}
},
"additionalProperties": false
},
"minItems": 1
}
},
"additionalProperties": false
}
}
}
},
"additionalProperties": false
}6.8.4 UDM Schema Management - PUT(provisioned/sms-mng-data)
provisioned/sms-mng-data
{
"type": "object",
"properties": {
"custom": {
"type": "string"
},
"moSmsBarringAll": {
"type": "boolean"
},
"moSmsSubscribed": {
"type": "boolean"
},
"mtSmsBarringAll": {
"type": "boolean"
},
"mtSmsSubscribed": {
"type": "boolean"
},
"supportedFeatures": {
"type": "string",
"pattern": "^[A-Fa-f0-9]*$"
},
"moSmsBarringRoaming": {
"type": "boolean"
},
"mtSmsBarringRoaming": {
"type": "boolean"
},
"sharedSmsMngDataIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9]{5,6}-.+$"
},
"minItems": 1
}
},
"additionalProperties": false
}6.8.5 UDM Schema Management - PUT(provisioned/trace-data)
provisioned/trace-data
{
"type": "object",
"nullable": true,
"required": [
"traceRef",
"traceDepth",
"neTypeList",
"eventList"
],
"properties": {
"custom": {
"type": "string"
},
"traceRef": {
"type": "string",
"pattern": "^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$"
},
"eventList": {
"type": "string",
"pattern": "^[A-Fa-f0-9]+$"
},
"neTypeList": {
"type": "string",
"pattern": "^[A-Fa-f0-9]+$"
},
"traceDepth": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"MINIMUM",
"MEDIUM",
"MAXIMUM",
"MINIMUM_WO_VENDOR_EXTENSION",
"MEDIUM_WO_VENDOR_EXTENSION",
"MAXIMUM_WO_VENDOR_EXTENSION"
]
},
{
"type": "string"
}
]
},
"interfaceList": {
"type": "string",
"pattern": "^[A-Fa-f0-9]+$"
},
"collectionEntityIpv4Addr": {
"type": "string",
"pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$"
},
"collectionEntityIpv6Addr": {
"type": "string",
"allOf": [
{
"pattern": "^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$"
},
{
"pattern": "^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$"
}
]
}
},
"additionalProperties": false
}6.9 Payload Reference for 4G Policy Data Operations
This section provides payload details for the following 4G Policy Data Operations.
6.9.1 POST - All Entity on 4G Policy Using VSA
{
"subscriber": {
"IMSI": ["302370123456789"],
"ACCOUNTID": ["178322212122"],
"MSISDN": ["15145551234", "15141234567"],
"BillingDay": 6,
"Entitlement": ["DayPass", "DayPassPlus"]
},
"usage": {
"quota": [{
"totalVolume": "100",
"Type": "quota",
"name": "Weekend",
"cid": "9223372036854775808",
"nextResetTime": "2014-01-10T02:00:00Z",
"QuotaState": "active"
},
{
"totalVolume": "100",
"Type": "quota",
"name": "Evenings",
"cid": "9223372036854775809",
"nextResetTime": "2014-02-01T00:00:00Z",
"QuotaState": "active"
}
],
"version": 3
},
"definition": {
"SequenceNumber": 1,
"version": 1,
"DynamicQuota": [{
"InstanceId": "15678",
"Priority": "4",
"InitialInputVolume": "15000",
"InterimReportingInterval": "1000",
"Duration": "100",
"InitialOutputVolume": "5000",
"Type": "pass",
"activationdatetime": "2015-03-09T11:20:32",
"expirationdatetime": "2015-04-09T11:20:32",
"InitialTotalVolume": "20000",
"name": "DynamicAggregateLimit",
"InitialServiceSpecific": "9",
"InitialTime": "135"
}]
},
"state": {
"property": [{
"name": "mcc",
"value": "123"
}, {
"name": "expire",
"value": "201402-09T11:20:32"
}],
"version": 1
}
}6.10 Payload Reference for NEF
This section provides payload details for NEF.
6.10.1 GET - Access and Mobility Data
{
"ratType": "EUTRA",
"location": {
"nrLocation": {
"tai": {
"nid": "",
"tac": "",
"plmnId": {
"mcc": "111",
"mnc": "11"
}
},
"ncgi": {
"nid": "",
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"nrCellId": ""
},
"globalGnbId": {
"nid": "",
"eNbId": "",
"gNbId": {
"gNBValue": "",
"bitLength": 22
},
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"tngfId": "",
"wagfId": "",
"n3IwfId": "",
"ngeNbId": ""
},
"eLocationTimestamp": "2013-09-29T18:46:19Z",
"geodeticInformation": "",
"geographicalInformation": "",
"ageOfLocationInformation": 0
},
"eutraLocation": {
"tai": {
"nid": "",
"tac": "",
"plmnId": {
"mcc": "161",
"mnc": "23"
}
},
"ecgi": {
"nid": "",
"plmnId": {
"mcc": "222",
"mnc": "22"
},
"eutraCellId": ""
},
"ignoreTai": false,
"ignoreEcgi": false,
"globalENbId": {
"nid": "",
"eNbId": "",
"gNbId": {
"gNBValue": "",
"bitLength": 22
},
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"tngfId": "",
"wagfId": "",
"n3IwfId": "",
"ngeNbId": ""
},
"globalNgenbId": {
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"n3IwfId": "0"
},
"geodeticInformation": "12345678912345678989",
"ueLocationTimestamp": "2013-09-29T18:46:19Z",
"geographicalInformation": "1234567891234563",
"ageOfLocationInformation": 0
}
},
"suppFeat": "",
"timeZone": "",
"regStates": [
{
"rmState": "",
"accessType": ""
}
],
"accessType": "3GPP_ACCESS",
"connStates": [
{
"cmState": "",
"accessType": ""
}
],
"locationTs": "2013-09-29T18:46:19Z",
"ratTypesTs": "2013-09-29T18:46:19Z",
"timeZoneTs": "2013-09-29T18:46:19Z",
"currentPlmn": {
"mcc": "111",
"mnc": "12"
},
"regStatesTs": "2013-09-29T18:46:19Z",
"connStatesTs": "2013-09-29T18:46:19Z",
"n3gaLocation": {
"gci": "",
"gli": "asss",
"tnapId": {
"ssId": "",
"bssId": "",
"civicAddress": ""
},
"twapId": {
"ssId": "",
"bssId": "",
"civicAddress": ""
},
"n3IwfId": "a",
"n3gppTai": {
"nid": "",
"tac": "",
"plmnId": {
"mcc": "111",
"mnc": "11"
}
},
"hfcNodeId": {
"hfcNId": ""
},
"portNumber": 0,
"ueIpv4Addr": "198.51.100.1",
"ueIpv6Addr": "2001:db8:85a3::8a2e:370:7334",
"w5gbanLineType": "DSL"
},
"currentPlmnTs": "2013-09-29T18:46:19Z",
"roamingStatus": true,
"roamingStatusTs": "2013-09-29T18:46:19Z",
"smsOverNasStatus": "",
"reachabilityStatus": "",
"smsOverNasStatusTs": "2013-09-29T18:46:19Z",
"reachabilityStatusTs": "2013-09-29T18:46:19Z"
}6.10.2 PUT - Access and Mobility Data
{
"ratType": "EUTRA",
"location": {
"nrLocation": {
"tai": {
"nid": "",
"tac": "",
"plmnId": {
"mcc": "111",
"mnc": "11"
}
},
"ncgi": {
"nid": "",
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"nrCellId": ""
},
"globalGnbId": {
"nid": "",
"eNbId": "",
"gNbId": {
"gNBValue": "",
"bitLength": 22
},
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"tngfId": "",
"wagfId": "",
"n3IwfId": "",
"ngeNbId": ""
},
"eLocationTimestamp": "2013-09-29T18:46:19Z",
"geodeticInformation": "",
"geographicalInformation": "",
"ageOfLocationInformation": 0
},
"eutraLocation": {
"tai": {
"nid": "",
"tac": "",
"plmnId": {
"mcc": "161",
"mnc": "23"
}
},
"ecgi": {
"nid": "",
"plmnId": {
"mcc": "222",
"mnc": "22"
},
"eutraCellId": ""
},
"ignoreTai": false,
"ignoreEcgi": false,
"globalENbId": {
"nid": "",
"eNbId": "",
"gNbId": {
"gNBValue": "",
"bitLength": 22
},
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"tngfId": "",
"wagfId": "",
"n3IwfId": "",
"ngeNbId": ""
},
"globalNgenbId": {
"plmnId": {
"mcc": "111",
"mnc": "11"
},
"n3IwfId": "0"
},
"geodeticInformation": "12345678912345678989",
"ueLocationTimestamp": "2013-09-29T18:46:19Z",
"geographicalInformation": "1234567891234563",
"ageOfLocationInformation": 0
}
},
"suppFeat": "",
"timeZone": "",
"regStates": [
{
"rmState": "",
"accessType": ""
}
],
"accessType": "3GPP_ACCESS",
"connStates": [
{
"cmState": "",
"accessType": ""
}
],
"locationTs": "2013-09-29T18:46:19Z",
"ratTypesTs": "2013-09-29T18:46:19Z",
"timeZoneTs": "2013-09-29T18:46:19Z",
"currentPlmn": {
"mcc": "111",
"mnc": "12"
},
"regStatesTs": "2013-09-29T18:46:19Z",
"connStatesTs": "2013-09-29T18:46:19Z",
"n3gaLocation": {
"gci": "",
"gli": "asss",
"tnapId": {
"ssId": "",
"bssId": "",
"civicAddress": ""
},
"twapId": {
"ssId": "",
"bssId": "",
"civicAddress": ""
},
"n3IwfId": "a",
"n3gppTai": {
"nid": "",
"tac": "",
"plmnId": {
"mcc": "111",
"mnc": "11"
}
},
"hfcNodeId": {
"hfcNId": ""
},
"portNumber": 0,
"ueIpv4Addr": "198.51.100.1",
"ueIpv6Addr": "2001:db8:85a3::8a2e:370:7334",
"w5gbanLineType": "DSL"
},
"currentPlmnTs": "2013-09-29T18:46:19Z",
"roamingStatus": true,
"roamingStatusTs": "2013-09-29T18:46:19Z",
"smsOverNasStatus": "",
"reachabilityStatus": "",
"smsOverNasStatusTs": "2013-09-29T18:46:19Z",
"reachabilityStatusTs": "2013-09-29T18:46:19Z"
}6.10.3 GET - PDUSessionManagementData
{
"dnn": "Label3",
"dnai": "",
"dnaiTs": "",
"ipAddrTs": "2013-09-29T18:46:19Z",
"ipv4Addr": "198.51.100.1",
"suppFeat": "",
"ipv6Addrs": "2001:db8:85a3::8a2e:370:7334",
"ipv6Prefix": "2001:db8:abcd:12::0/64",
"pduSessType": "IPV4",
"pduSessionId": 0,
"pduSessionStatus": "ACTIVE",
"pduSessionStatusTs": "2013-09-29T18:46:19Z",
"n6TrafficRoutingInfo": [
{
"dnai": "sss",
"routeInfo": {
"ipv4Addr": "",
"ipv6Addr": "",
"portNumber": 0
},
"routeProfId": ""
}
],
"n6TrafficRoutingInfoTs": "2013-09-29T18:46:19Z"
}6.10.4 PUT - PDU Session Management Data
{
"dnn": "Label3",
"dnai": "",
"dnaiTs": "",
"ipAddrTs": "2013-09-29T18:46:19Z",
"ipv4Addr": "198.51.100.1",
"suppFeat": "",
"ipv6Addrs": "2001:db8:85a3::8a2e:370:7334",
"ipv6Prefix": "2001:db8:abcd:12::0/64",
"pduSessType": "IPV4",
"pduSessionId": 0,
"pduSessionStatus": "ACTIVE",
"pduSessionStatusTs": "2013-09-29T18:46:19Z",
"n6TrafficRoutingInfo": [
{
"dnai": "sss",
"routeInfo": {
"ipv4Addr": "",
"ipv6Addr": "",
"portNumber": 0
},
"routeProfId": ""
}
],
"n6TrafficRoutingInfoTs": "2013-09-29T18:46:19Z"
}6.10.5 POST - ExposureDataSubscription
{
"notificationUri" : "http://http2-server-service-python36-migration-17.default.svc.cluster.local:8080/notifications",
"monitoredResourceUris" : [
"http://localhost:8081/nudr-dr/v2/subscription-data/extid-868690909214@ext/context-data/amf-3gpp-access"
],
"expiry" : "2050-12-19T10:25:14.090Z",
"supportedFeatures" : "f"
}6.10.6 PUT - ExposureDataSubscription
{
"notificationUri" : "http://http2-server-service-python36-migration-17.default.svc.cluster.local:8080/notifications",
"monitoredResourceUris" : [
"http://localhost:8081/nudr-dr/v2/subscription-data/extid-868690909214@ext/context-data/amf-3gpp-access"
],
"expiry" : "2050-12-19T10:25:14.090Z",
"supportedFeatures" : "fa"
}6.11 Payload Reference for EIR
This section provides payload details for EIR.
6.11.1 GET-equipment-status
Sample Request:
http://10.75.229.117:31040/n5g-eir-eic/v1/equipment-status?pei=imei-1111111111&supi=imsi-1111111112&gpsi=msisdn-1111111121
or
http://10.75.229.117:31040/n5g-eir-eic/v1/equipment-status?pei=imei-1111111111&supi=imsi-1111111112&gpsi=msisdn-1111111121
{
"status": "WHITELISTED"
}