1. Cloud Native Unified Data Repository REST Specification Document
  2. REST Specifications
  3. Provisioning Operations for UDM Data

Provisioning Operations for UDM Data

This section provides information about the operations supported for UDM data through provisioning interface.

Resource Name: AuthenticationSubscriptionData

HTTP Method: GET, PUT, DELETE

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-subscription

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI:

https://10.75.212.116:31873/nudr-dr-prov/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-subscription 

{
    "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"
}
  • 400: "Invalid URI sent from client"
  • 404: "Data field does not exist "
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-subscription?fields=encOpcKey,algorithmId 

{
    "encOpcKey": "ABED",
    "algorithmId": "algoID"
}
  
PUT

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-subscription

Payload: 
{
  "authenticationMethod" : "5G_AKA",
  "encPermanentKey" : "ABBA",
  "protectionParameterId" : "ProtecID",
  "sequenceNumber" : {
  "sqnScheme" : "GENERAL",
  "sqn" : "123456789ABE",
  "lastIndexes" : {
  "ausf" : 5
  },
  "indLength" : 5,
  "difSign" : "NEGATIVE"
  },
  "authenticationManagementField" : "ABBE",
  "algorithmId" : "algoID",
  "encOpcKey" : "ABED",
  "encTopcKey" : "ACED"
}
  
  • 400: " Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-subscription    

Resource Name: AuthenticationStatus

HTTP Method: PUT, GET, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-status Payload: 
{
  "nfInstanceId" : "abae35e5-cc45-4016-8dd4-89598e5311b9",
  "success" : true,
  "timeStamp" : "2018-01-02T08:17:14.090Z",
  "authType" : "5G_AKA",
  "servingNetworkName" : "5G:mnc123.mcc456.3gppnetwork.org"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
GET Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-status 

{
    "success": true,
    "authType": "5G_AKA",
    "timeStamp": "2018-01-02T08:17:14.090Z",
    "nfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
    "servingNetworkName": "5G:mnc123.mcc456.3gppnetwork.org"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-status?fields=nfInstanceId 
{
    "nfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9"
}
  
DELETE Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-status

  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"

Sub-level Name: Context Data

Resource Name: Amf3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access

Payload: See PUT-Amf3GppAccessRegistration

  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access

Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access/all

   
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access?fields=pei,guami Output:
 {
    "pei": "imei-1000000000000001",
    "guami": {
        "plmnId": {
            "mnc": "123",
            "mcc": "001"
        },
        "amfId": "1234AA"
    }
}
  
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access/all Output: GET - Amf3GppAccessRegistration

Resource Name: AmfNon3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

Base URI: subscription-data/{ueId}/ context-data/amf-non-3gpp-access

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access

Payload: See PUT-AmfNon3GppAccessRegistration

  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE

Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000025/context-data/amf-non-3gpp-access/all    
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access Output: See GET-AmfNon3GppAccessRegistration
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access?fields=backupAmfInfo,ratType Output: 
{
    "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"
                }
            ]
        }
    ]
}
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000025/context-data/amf-non-3gpp-access/all    

Resource Name: SmfRegistrations

HTTP Method: GET, DELETE

Base URI: subscription-data/{ueId}/context-data/smf-registrations

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations Output: 
[
    {
        "supportedFeatures": "supFeature1",
        "dnn": "dnn2",
        "singleNssai": {
            "sd": "abcdef",
            "sst": 32
        },
        "smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
        "emergencyServices": true,
        "pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
        "plmnId": {
            "mnc": "011",
            "mcc": "001"
        },
        "pduSessionId": 123,
        "pgwFqdn": "abcdefgh"
    }
]
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
DELETE

Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations

Resource Name: IndividualSmfRegistration

HTTP Method: PUT, DELETE, GET

Base URI: subscription-data/{ueId}/context-data /smf-registrations/{pduSessionId}

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations/123
Payload: 
{
 "smfInstanceId" : "abae35e5-cc45-4016-8dd4-89598e5311b9",
 "pduSessionId" : 123,
 "singleNssai" : {
 "sst" : 32,
 "sd" : "abcdef"
 },
 "plmnId" : {
 "mcc" : "001",
 "mnc" : "011"
 },
 "supportedFeatures" : "supFeature1",
 "dnn" : "dnn2",
 "emergencyServices" : true,
 "pcscfRestorationCallbackUri" : "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
 "pgwFqdn" : "abcdefgh"
 }
 Output: 
{
 "smfInstanceId" : "abae35e5-cc45-4016-8dd4-89598e5311b9",
 "pduSessionId" : 123,
 "singleNssai" : {
 "sst" : 32,
 "sd" : "abcdef"
 },
 "plmnId" : {
 "mcc" : "001",
 "mnc" : "011"
 },
 "supportedFeatures" : "supFeature1",
 "dnn" : "dnn2",
 "emergencyServices" : true,
 "pcscfRestorationCallbackUri" : "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances",
 "pgwFqdn" : "abcdefgh"
 }
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations/123
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations/123 Output: 
{
 "dnn": "dnn2",
 "plmnId": {
 "mcc": "001",
 "mnc": "011"
 },
 "pgwFqdn": "abcdefgh",
 "singleNssai": {
 "sd": "abcdef",
 "sst": 32
 },
 "pduSessionId": 123,
 "smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
 "emergencyServices": true,
 "supportedFeatures": "supFeature1",
 "pcscfRestorationCallbackUri": "http://ocnrf-ambassador.default.svc.cluster.local/nnrf-nfm/v1/nf-instances"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations/123?fields=dnn Output: 

{
    "dnn": "dnn2",
    "emergencyServices": true
}

Resource Name: Smsf3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access
Payload: 
{
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfMAPAddress": "977347916",
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access Output: 
{
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfMAPAddress": "977347916",
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access?fields=plmnId,smsfInstanceId Output: 
{
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "plmnId": {
        "mnc": "45",
        "mcc": "452"
    }
}

Resource Name: SmsfNon3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-non-3gpp-access

Payload: 
{
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfMAPAddress": "977347916",
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-non-3gpp-access
GET

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-non-3gpp-access

 Output: 
{
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfMAPAddress": "977347916",
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-non-3gpp-access?fields=plmnId,smsfDiameterAddress Output: 
{
    "plmnId": {
        "mnc": "45",
        "mcc": "452"
    },
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}

Resource Name: AccessAndMobilitySubscriptionData

HTTP Method: GET, PUT, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data Sample Output:GET-AccessAndMobilitySubscriptionData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist in data table"
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data?fields=gpsis,nssai,sorInfo  
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist in data table"
PUT Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data

Payload: See PUT - AccessAndMobilitySubscriptionData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE Sample URI:

http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data

 

Resource Name: SmfSelectionSubscriptionData

HTTP Method: PUT, DELETE, GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/smf-selection-subscription-data
Payload: 
{
    "supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
    "subscribedSnssaiInfos" :{
        "snsai1":{"dnnInfos":[
            {
                "dnn":"Dnn1",
                "defaultDnnIndicator": true,
                "lboRoamingAllowed":true,
                "iwkEpsInd": true
            },
            {
                "dnn":"Dnn2",
                "defaultDnnIndicator": false,
                "lboRoamingAllowed":true,
                "iwkEpsInd": true
            }
        ]}
    },
    "sharedSnssaiInfosId":"96367-9z}MD*"
      
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/smf-selection-subscription-data
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/smf-selection-subscription-data Output: 
{
    "supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
    "sharedSnssaiInfosId": "96367-9z}MD*",
    "subscribedSnssaiInfos": {
        "snsai1": {
            "dnnInfos": [{
                    "dnn": "Dnn1",
                    "iwkEpsInd": true,
                    "lboRoamingAllowed": true,
                    "defaultDnnIndicator": true
                },
                {
                    "dnn": "Dnn2",
                    "iwkEpsInd": true,
                    "lboRoamingAllowed": true,
                    "defaultDnnIndicator": false
                }
            ]
        }
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/smf-selection-subscription-data?fields=subscribedSnssaiInfos Output: 
{
    "subscribedSnssaiInfos": {
        "snsai1": {
            "dnnInfos": [
                {
                    "defaultDnnIndicator": true,
                    "iwkEpsInd": true,
                    "dnn": "Dnn1",
                    "lboRoamingAllowed": true
                },
                {
                    "defaultDnnIndicator": false,
                    "iwkEpsInd": true,
                    "dnn": "Dnn2",
                    "lboRoamingAllowed": true
                }
            ]
        }
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Resource Name: SessionManagementSubscriptionData

HTTP Method: GET, PUT, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data Output: GET-SessionManagementSubscriptionData- Provisioning
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data?fields=internalGroupIds,dnnConfigurations Output: GET-SessionManagementSubscriptionData- Provisioning
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
PUT Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data

Payload: PUT-SessionManagementSubscriptionData

  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data

Resource Name: SMSManagementSubscriptionData

HTTP Method: GET, PUT, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sms-mng-data Output: 
{
    "moSmsBarringAll": true,
    "moSmsSubscribed": false,
    "mtSmsBarringAll": true,
    "mtSmsSubscribed": true,
    "supportedFeatures": "CAe8de215CFa721BB2AE7Ef9c5f71a2e",
    "moSmsBarringRoaming": true,
    "mtSmsBarringRoaming": false,
    "sharedSmsMngDataIds": [
        "16994-'JD",
        "693599-9~~GX"
    ]
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sms-mng-data?fields=mtSmsSubscribed,sharedSmsMngDataIds Output: 
{
    "mtSmsSubscribed": true,
    "sharedSmsMngDataIds": [
        "16994-'JD",
        "693599-9~~GX"
    ]
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
PUT

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sms-mng-data

Payload: 

{
    "supportedFeatures":"CAe8de215CFa721BB2AE7Ef9c5f71a2e",
    "mtSmsSubscribed":true,
    "mtSmsBarringAll":true,
    "mtSmsBarringRoaming":false,
    "moSmsSubscribed":false,
    "moSmsBarringAll":true,
    "moSmsBarringRoaming":true,
    "sharedSmsMngDataIds":["16994-'JD","693599-9~~GX"]
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE

Sample URI: http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sms-mng-data

Resource Name: TraceData

HTTP Method: PUT, GET, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/77889/provisioned-data/trace-data 
{
    "traceRef":"070207-baE6Dd",
    "traceDepth": "MINIMUM",
    "neTypeList": "0f4FBEfe95bF8",
    "eventList":  "855B5bf7beC3AFB8c",
    "collectionEntityIpv4Addr": "26.118.255.253",
    "collectionEntityIpv6Addr": "2001:db8:85a3::8a2e:370:7334"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/77889/provisioned-data/trace-data Output: 
{
    "traceRef": "070207-baE6Dd",
    "eventList": "855B5bf7beC3AFB8c",
    "neTypeList": "0f4FBEfe95bF8",
    "traceDepth": "MINIMUM",
    "collectionEntityIpv4Addr": "26.118.255.253",
    "collectionEntityIpv6Addr": "2001:db8:85a3::8a2e:370:7334"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/77889/provisioned-data/trace-data

Resource Name: SMSSubscriptionData

HTTP Method:PUT, GET, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/77889/provisioned-data/sms-data

Payload: 

{ 
   "smsSubscribed":true,
   "sharedSmsSubsDataId":"63472-BTkzoYkBL1"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/77889/provisioned-data/sms-data Output: 
{ 
   "smsSubscribed":true,
   "sharedSmsSubsDataId":"63472-BTkzoYkBL1"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/77889/provisioned-data/sms-data

Sub-level Name: OperatorSpecificData

HTTP Method: GET, PUT, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-specific-data Output: 
{
    "NumberTypeElements": {
        "1": 1.1
    },
    "StringTypeElements": {
        "1": "s"
    },
    "BooleanTypeElements": {
        "1": true
    },
    "IntegerTypeElements": {
        "1": 1
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-specific-data?fields=NumberTypeElements Output: 
{
    "NumberTypeElements": {
        "1": 1.1
    }
}
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-specific-data
Payload: 
{
    "StringTypeElements": {
        "1": "s"
   },
    "IntegerTypeElements": {
        "1": 1
    },
    "NumberTypeElements": {
        "1": 1.1
    },
    "BooleanTypeElements": {
        "1": true
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-specific-data

Sub-level Name: OperatorDeterminedBarringData

HTTP Method: GET, PUT, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-determined-barring-data

Payload: 

{
    "roamingOdb": "OUTSIDE_HOME_PLMN"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-determined-barring-data
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/operator-determined-barring-data Output: 
{
    "roamingOdb": "OUTSIDE_HOME_PLMN"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Sub-level Name: ProvisionedParameterData

HTTP Method: GET, PUT, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/pp-data
Payload: 
{
    "communicationCharacteristics": {
        "ppSubsRegTimer": {
            "subsRegTimer": 12,
            "afInstanceId": "f9dc5b9c-a460-11e9-a2a3-2a2ae2dbcce4",
            "referenceId": 1
        },
 
        "ppActiveTime": {
            "activeTime": 23,
            "afInstanceId": "f9dc5b9c-a460-11e9-a2a3-2a2ae2dbcce4",
            "referenceId": 2
 
        },
        "ppDlPacketCount": 1
 
    },
 
    "supportedFeatures": "751b"
 
 
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/pp-data
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/pp-data Output: 
{
    "supportedFeatures": "751b",
    "communicationCharacteristics": {
        "ppActiveTime": {
            "activeTime": 23,
            "referenceId": 2,
            "afInstanceId": "f9dc5b9c-a460-11e9-a2a3-2a2ae2dbcce4"
        },
        "ppSubsRegTimer": {
            "referenceId": 1,
            "afInstanceId": "f9dc5b9c-a460-11e9-a2a3-2a2ae2dbcce4",
            "subsRegTimer": 12
        },
        "ppDlPacketCount": 1
    }
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Sub-level Name: EeProfileData

HTTP Method: PUT, GET, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ee-profile-data
Payload: 
{
    "restrictedEventTypes":["LOSS_OF_CONNECTIVITY","CHANGE_OF_SUPI_PEI_ASSOCIATION"],
      "supportedFeatures":"fcB2fFC084Fc2d5B4Afcfa2Df8614"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ee-profile-data Output: 
{
    "supportedFeatures": "fcB2fFC084Fc2d5B4Afcfa2Df8614",
    "restrictedEventTypes": [
        "LOSS_OF_CONNECTIVITY",
        "CHANGE_OF_SUPI_PEI_ASSOCIATION"
    ]
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ee-profile-data?fields=restrictedEventTypes Output: 
{
    "restrictedEventTypes": [
        "LOSS_OF_CONNECTIVITY",
        "CHANGE_OF_SUPI_PEI_ASSOCIATION"
    ]
}
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ee-profile-data

Sub-level Name: IdentityData

HTTP Method: PUT, GET, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/identity-data 
{
    "supiList":["imsi-516737872","imsi-516737873"],
    "gpsiList": ["msisdn-101176983803402"]
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/identity-data Output: 
{
    "gpsiList": [
        "msisdn-101176983803402"
    ],
    "supiList": [
        "imsi-516737872",
        "imsi-516737873"
    ]
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/identity-data

Sub-level Name: ue-update-confirmation-data

Resource Name: Sor-data

HTTP Method: PUT, GET, DELETE

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ue-update-confirmation-data/sor-data 
{
    "provisioningTime": "2012-04-23T18:25:43.511Z",
    "ueUpdateStatus": "NOT_SENT",
    "sorXmacIue": "3a84eBBb8C694Cce4ebA2FCC9307af1F",
    "sorMacIue": "3a84eBBb8C694Cce4ebA2FCC9307af1A"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
GET http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ue-update-confirmation-data/sor-data Output: 
{
    "sorMacIue": "3a84eBBb8C694Cce4ebA2FCC9307af1A",
    "sorXmacIue": "3a84eBBb8C694Cce4ebA2FCC9307af1F",
    "ueUpdateStatus": "NOT_SENT",
    "provisioningTime": "2012-04-23T18:25:43.511Z"
}
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ue-update-confirmation-data/sor-data