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

Operations Supported for UDM

This section provides information about the operations supported for UDM as per 29.505 v16.2.

Sub-level Name: Authentication Data

Resource Name: AuthenticationSubscriptionData

HTTP Method: GET, PATCH

Base URI: /subscription-data/{ueId}/authentication-data/authentication-subscription

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/authentication-data/authentication-subscription Output: 
{
    "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: "Subscriber does not exist"
  • 404: "Data field does not exist "

Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/authentication-data/authentication-subscription?fields=encOpcKey,algorithmId

Output: 
{
    "encOpcKey": "ABED",
    "algorithmId": "algoID"
}
PATCH

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

Payload: 
case1: REPLACE
[{
    "op" : "replace",
    "path" : "/sequenceNumber/sqn",
    "value" : "123456789ABC"
}]
 
 
case2: ADD
case3: REMOVE
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Resource Name: AuthenticationStatus

HTTP Method: PUT, GET

Base URI: /subscription-data/{ueId}/authentication-data/authentication-status

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI:
http://localhost:8080/nudr-dr/v2/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/v2/subscription-data/imsi-911000000028/authentication-data/authentication-status?fields=nfInstanceId,success Output: 
{
    "nfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9",
    "success": true
}
  
Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/authentication-data/authentication-status Output: 
{
    "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 "

Sub-level Name: Context Data

Resource Name: ContextData

HTTP Method: GET

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

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data Output: See GET-ContextData
Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data?context-dataset-names=SMSF_3GPP Output: GET - Context Data - SMSF

Resource Name: Amf3GppAccessRegistration

HTTP Method: PUT, PATCH, GET

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

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

Payload: See PUT - Amf3GppAccessRegistration

  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
PATCH Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/amf-3gpp-access Payload: See PATCH - Amf3GppAccessRegistration
  • 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/v2/subscription-data/imsi-911000000028/context-data/amf-3gpp-access Output: See GET-Amf3GppAccessRegistration
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/amf-3gpp-access?fields=pei,ratType,epsInterworkingInfo,backupAmfInfo,drFlag Output: See GET-Amf3GppAccessRegistration

Resource Name: AmfNon3GppAccessRegistration

HTTP Method: PUT, PATCH, 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/v2/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"
PATCH Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access Payload: 
case1: REPLACE
[{
    "op" : "replace",
    "path" : "/backupAmfInfo/0/guamiList/0/plmnId/mcc",
    "value" : "998"
}]
case2: ADD
[{
    "op" : "add",
    "path" : "/backupAmfInfo/0/guamiList/1",
    "value" : {
                    "amfId": "5678AA",
                    "plmnId": {
                        "mcc": "666",
                        "mnc": "456"
                    }
              }
}]
case3: REMOVE
[{
    "op" : "remove",
    "path" : "/backupAmfInfo/0/guamiList/2"
}]
  • 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/v2/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/v2/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access?fields=amfInstanceId,guami Output: See GET-AmfNon3GppAccessRegistration

Resource Name: SmfRegistrations

HTTP Method: GET

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/v2/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 "

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/v2/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/v2/subscription-data/imsi-911000000028/context-data/smf-registrations/123  
GET Sample URI: http://localhost:8080/nudr-dr/v2/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/v2/subscription-data/imsi-911000000028/context-data/smf-registrations/123?fields=singleNssai,smfInstanceId

Output: 
{
    "singleNssai": {
        "sd": "abcdef",
        "sst": 32
    },
    "smfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9"
}

Resource Name: Smf3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

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

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PUT Sample URI: http://localhost:8080/nudr-dr/v2/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/v2/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access
GET Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access Output: 
{
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "smsfMAPAddress": "977347916",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "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/v2/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access?fields=smsfDiameterAddress,smsfMAPAddress Output: 
{
    "smsfMAPAddress": "977347916",
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}

Resource Name: SmfNon3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

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

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

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

Payload: 
{
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "smsfMAPAddress": "977347916",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "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/v2/subscription-data/imsi-911000000028/context-data/smsf-non-3gpp-access

GET

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

Output: 
{
    "plmnId": {
        "mcc": "452",
        "mnc": "45"
    },
    "smsfInstanceId": "69d3da66-9e25-11e9-a2a3-2a2ae2dbcce4",
    "smsfMAPAddress": "977347916",
    "supportedFeatures": "BA2b5d3b977eF2458EEC80592E",
    "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/v2/subscription-data/imsi-911000000028/context-data/smsf-non-3gpp-access?fields=smsfMAPAddress,smsfDiameterAddress Output: 
{
    "smsfMAPAddress": "977347916",
    "smsfDiameterAddress": {
        "name": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh",
        "realm": "uLmBAnz2b7S6OevNkC7tHvcEZidEXppNIp7Le9yXzucgboiXFRkYg6597LBi31nOBxEBV2ZePCfKpUiEB0ULZMxudPsPepud.emteshurwdldooeh"
    }
}

Resource Name: AccessAndMobilitySubscriptionData

HTTP Method: GET

Base URI: /subscription-data/{ueId}/{servingPlmnId}/provisioned-data /am-data

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

Resource Name: SmfSelectionSubscriptionData

HTTP Method: GET

Base URI: /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr/v2/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/v2/subscription-data/imsi-911000000089/77889/provisioned-data/smf-selection-subscription-data?fields=subscribedSnssaiInfos,supportedFeatures Output: 
{
    "supportedFeatures": "692F296F2Cb3BCA76Bc1E126FeEC12",
    "subscribedSnssaiInfos": {
        "snsai1": {
            "dnnInfos": [
                {
                    "defaultDnnIndicator": true,
                    "iwkEpsInd": true,
                    "dnn": "Dnn1",
                    "lboRoamingAllowed": true
                },
                {
                    "defaultDnnIndicator": false,
                    "iwkEpsInd": true,
                    "dnn": "Dnn2",
                    "lboRoamingAllowed": true
                }
            ]
        }
    }
}

Resource Name: SessionManagementSubscriptionData

HTTP Method: GET

Base URI: /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data Output: GET-SessionManagementSubscriptionData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data?fields=internalGroupIds,singleNssai

Output: 
[
    {
        "singleNssai": {
            "sd": "ABC654",
            "sst": 1
        },
        "internalGroupIds": [
            "9ABAB803-203-299-95A9",
            "9ABAB803-203-299-95A2",
            "79e0c480-719-085-f2A55e6DDc91Df802438"
        ]
    }
]

Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/77889/provisioned-data/sm-data?single-nssai=1-ABC654&dnn=dnn1&fields=internalGroupIds,singleNssai

Output: 
[
{
   "singleNssai": {
       "sd": "ABC654",
       "sst": 1
   },
   "internalGroupIds": [
       "9ABAB803-203-299-95A9",
       "9ABAB803-203-299-95A2",
       "79e0c480-719-085-f2A55e6DDc91Df802438"
   ]
}
]

Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/77889/provisioned-data/sm-data?dnn=dnn1&fields=internalGroupIds,singleNssai

sm-data should be provisioned for a subscriber with same ueId, same servingPlmId but different single-Nssai

Output: 
[
    {
        "singleNssai": {
            "sd": "ABC654",
            "sst": 1
        },
        "internalGroupIds": [
            "9ABAB803-203-299-95A9",
            "9ABAB803-203-299-95A2",
            "79e0c480-719-085-f2A55e6DDc91Df802438"
        ]
    },
    {
        "singleNssai": {
            "sst": 2
        },
        "internalGroupIds": [
            "9ABAB803-203-299-95A9",
            "9ABAB803-203-299-95A2",
            "79e0c480-719-085-f2A55e6DDc91Df802438"
        ]
    }
]

Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/77889/provisioned-data/sm-data?single-nssai=1-ABC654&fields=internalGroupIds,singleNssai

Output: 
[
{
   "singleNssai": {
       "sd": "ABC654",
       "sst": 1
   },
   "internalGroupIds": [
       "9ABAB803-203-299-95A9",
       "9ABAB803-203-299-95A2",
       "79e0c480-719-085-f2A55e6DDc91Df802438"
   ]
}
]

Resource Name: SMSManagementSubscriptionData

HTTP Method: GET

Base URI: /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET Sample URI: http://localhost:8080/nudr-dr/v2/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 "

Resource Name: TraceData

HTTP Method: GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/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 "

Resource Name: SMSSubscriptionData

HTTP Method: GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/77889/provisioned-data/sms-data Output: 
{ 
   "smsSubscribed":true,
   "sharedSmsSubsDataId":"63472-BTkzoYkBL1"
}

Sub-level Name: Provisioned Data

Resource Name: ProvisionedData

HTTP Method: GET

Base URI: /subscription-data/{ueId}/{servingPlmnId}/provisioned-data

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

http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data

 Output: GET-ProvisionedData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Sample URI: http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000089/77889/provisioned-data?dataset-names=AM,SM

Output: GET-ProvisionedData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

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

Resource Name: Sor-data

HTTP Method: GET, PUT

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/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 "
PUT Sample URI:

http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/ue-update-confirmation-data/sor-data

Payload: 

{
    "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"

Sub-level Name: OperatorSpecificData

HTTP Method: GET, PATCH

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/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 "
PATCH http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/operator-specific-data
Payload: 
case1: REPLACE
[{
    "op" : "replace",
    "path" : "/IntegerTypeElements/1",
    "value" : 2
}]
Case2: ADD

case3: REMOVE
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "

Sub-level Name: OperatorDeterminedBarringData

HTTP Method: GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/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: PATCH, GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
PATCH http://localhost:8080/nudr-dr/v2/subscription-data/imsi-911000000028/pp-data
Payload: 
case1: REPLACE
[{
    "op" : "replace",
    "path" : "/communicationCharacteristics/ppSubsRegTimer/subsRegTimer",
    "value" : 13
}]
case2: ADD
case3: REMOVE
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist "
GET http://localhost:8080/nudr-dr/v2/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: GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/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/v2/subscription-data/imsi-911000000028/ee-profile-data?fields=restrictedEventTypes Output: 
{
    "restrictedEventTypes": [
        "LOSS_OF_CONNECTIVITY",
        "CHANGE_OF_SUPI_PEI_ASSOCIATION"
    ]
}

Sub-level Name: IdentityData

HTTP Method: GET

Operation Type Sample Request REST URL Sample Response Possible Error Codes
GET http://localhost:8080/nudr-dr/v2/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 "