2 Provisioning API Specifications

This section describes provisioning API specifications for Profile Data, NEF Data, EIR Data, Policy Data, SLF Data, UDM Data, and UDSF Data.

2.1 Provisioning Operations for Profile Data

This section provides provisioning operations for Profile data.

Resource Name: ProfileData

HTTP Method: POST, PUT, DELETE, GET

BASE URI: {apiRoot}/nudr-dr-prov/{version}/profile-data/{ue-id}

api-root-> igw-prov-ip:igw-prov-port

Table 2-1 Profile Data

HTTP Method Sample REST URL Description Possible Error Codes
POST https://localhost:9443/nudr-dr-prov/v2/profile-data/msisdn-1111111113

This is for initial subscriber provisioning (create subscriber). For more information about payload, see POST-ProfileData

To add custom fields in the profile data during initial subscriber provisioning (create subscriber). For more information, see Adding Custom Fields under Profile Data
  • 400: "Invalid URI sent from client"
  • 400: "Unknown key, the key provided in the request is invalid"
  • 400: "Payload should contain key-value pair present in URI"
  • 400: "Invalid content request data supplied"
  • 400: "Occurrence constraint violation"
  • 400: "Duplicate key"
PUT https://localhost:9443/nudr-dr-prov/v2/profile-data/nai-3333333332

For more information about the payload, see PUT-ProfileData

To update an existing profile data with custom fields or the custom fields already present in profile data can be updated using following payload:
{
    "profile-data": {
        "MSISDN": [
            "1111111112",
            "1111111113"
        ],
        "Imsi": [
            "2222222221"
        ],
        "profile-fields": {
            "customFieldKey": "CustomValue"
        }
    }
 }
  • 400: "Invalid URI sent from client"
  • 400: "Unknown key, the key provided in the request is invalid"
  • 400: " Payload should contain key-value pair present in URI "
  • 400: "Invalid content request data supplied"
  • 400: "Occurrence constraint violation"
DELETE https://localhost:9443/nudr-dr-prov/v2/profile-data/nai-3333333332 This operation deletes all data from all DATA tables (PCF, UDM etc.).
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"
GET https://localhost:9443/nudr-dr-prov/v2/profile-data/msisdn-1111111113 This operation extracts profile data.
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"

2.2 Provisioning Operations for NEF Data

This section provides provisioning operations for NEF data.

Resource Name: ProfileData

Base URI: {apiRoot}/nudr-dr-prov/v2/profile-data/{ue-id}

Table 2-2 ProfileData

HTTP Method Description Possible Error Codes
POST

http://localhost:8080/nudr-dr-prov/v2/profile-data/msisdn-1111111113

Result Code: 201 Created

Payload: POST - NEF Data		 NA

Resource Name: AccessAndMobilityData, PduSessionManagementData

Base URI: {apiRoot}/nudr-dr/v2/exposure-data/{ueId}

Table 2-3 AccessAndMobilityData, PduSessionManagementData

HTTP Method Description Possible Error Codes
PUT

http://localhost:8080/nudr-dr-prov/v2/exposure-data/msisdn-1111111113

Result Code: 200 OK

Payload:PUT - PDU Session Management Data
  • 400 : "Invalid URI sent from client"
  • 404 : "Subscriber does not exist"
  • 404 : "Data field does not exist"
  • 400 : "Unknown key, the key provided in the request is invalid"
GET

http://localhost:8080/nudr-dr-prov/v2/exposure-data/msisdn-1111111113

Result Code: 200 OK

Payload:GET - PDUSessionManagementData
  • 400 : "Invalid URI sent from client"
  • 404 : "Subscriber does not exist"
  • 404 : "Data field does not exist"
  • 400 : "Unknown key, the key provided in the request is invalid"

2.3 Provisioning Operations Supported for EIR Data

This section provides provisioning operations for EIR data.

Resource Name: EIR Data

HTTP Method: PUT, DELETE, GET

BASE URI: {apiRoot}/n5g-eir-prov/v1/equipment-status/{ueId}

Table 2-4 EIR Provisioning APIs

HTTP Method Description Sample Request Sample Response Possible Error Codes
PUT

Create EIR subscriber profile. Profile data and equipment status data are mandatory to create subscriber profile.

 http://localhost:8080/n5g-eir-prov/v1/equipment-status/imei-1111111111
Use the following payload to:
  • Create EIR profile if the IMEI is not provisioned on EIR.
  • Update equipment status and add IMSI/MSISDN keys to existing IMEI already provisioned
  • Update the equipment status of an existing subscriber
{
    "profile-data": {
        "IMEI": ["1111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    },
    "equipment-status" : {        
        "grey": true,
        "black": true,
        "white": true    
    }
}

IMEI key cannot be modified once provisioned

201 Created
  • 400: Invalid content request data supplied
  • 400: Schema validation failed for this request
  • 400: Invalid JSON payload
  • 400: Invalid URI sent from client
  • 400: Payload should contain key-value pair present in URI
  • 400: Unknown key, the key imsi123 provided in the request is invalid
  • 400: Invalid content, equipment status cannot be empty
  • 400: Invalid content, equipment status cannot have all its content set to false
  • 400: Invalid content, equipment status missing for EIR profile
  • 400: Keys other than IMEI in URI not allowed for EIR profile update
  • 400: Invalid Key Value
PUT EIR profile provisioning with imeisv http://localhost:8080/n5g-eir-prov/v1/equipment-status/imeisv-1111111111111110

The below payload will support to CREATE EIR Profile

{
    "profile-data": {
        "IMEISV": ["1111111111111110"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    },
    "equipment-status" : {        
        "grey": true,
        "black": true,
        "white": true    
    }
}

201 Created
  • 400: Invalid content request data supplied
  • 400: Schema validation failed for this request
  • 400: Invalid JSON payload
  • 400: Invalid URI sent from client
  • 400: Payload should contain key-value pair present in URI
  • 400: Unknown key, the key imsi123 provided in the request is invalid
  • 400: Invalid content, equipment status cannot be empty
  • 400: Invalid content, equipment status cannot have all its content set to false
  • 400: Invalid content, equipment status missing for EIR profile
  • 400: Keys other than IMEI in URI not allowed for EIR profile update
  • 400: Invalid Key Value
PUT

Updates the EIR subscriber profile for an existing IMEI and IMEISV.

Does patch operation on the existing EIR subscriber and includes provisions keys in payload if not already provisioned

Updates the equipment status with profile update.

MEI and IMEISV cannot be modified

 http://localhost:8080/n5g-eir-prov/v1/equipment-status/imei-1111111111
{
    "profile-data": {
        "IMEI": ["1111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
}
{
    "profile-data": {
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
}
{
    "profile-data": {
        "IMEI": ["1111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
    "equipment-status"{
       "grey": true,
        "black": true,
        "white": true
    }
}
http://localhost:8080/n5g-eir-prov/v1/equipment-status/imeisv-1111111111111111
{
    "profile-data": {
        "IMEISV": ["1111111111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
}
{
    "profile-data": {
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
}
{
    "profile-data": {
        "IMEISV": ["1111111111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
    "equipment-status"{
       "grey": true,
        "black": true,
        "white": true
    }
}

201 Created
  • 400: Invalid content request data supplied
  • 400: Schema validation failed for this request
  • 400: Invalid JSON payload
  • 400: Invalid URI sent from client
  • 400: Payload should contain key-value pair present in URI
  • 400: Unknown key, the key imsi123 provided in the request is invalid
  • 400: Invalid content, equipment status cannot be empty
  • 400: Invalid content, equipment status cannot have all its content set to false
  • 400: Invalid content, equipment status missing for EIR profile
  • 400: Keys other than IMEI in URI not allowed for EIR profile update
  • 400: Invalid Key Value
PUT Updates the equipment status for an existing IMEI and IMEISV http://localhost:8080/n5g-eir-prov/v1/equipment-status/imei-1111111111
{
    "equipment-status":{
        "grey": true,
        "black": false,
        "white": true
    }
}
{
    "profile-data": {
        "IMEI": ["1111111111"]
    },
    "equipment-status":{
        "grey": true,
        "black": false,
        "white": true
    }
}
{
    "profile-data": {
        "IMEI": ["1111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
    "equipment-status"{
       "grey": true,
        "black": true,
        "white": true
    }
}
http://localhost:8080/n5g-eir-prov/v1/equipment-status/imeisv-1111111111111111
{
    "equipment-status":{
        "grey": true,
        "black": false,
        "white": true
    }
}
{
    "profile-data": {
        "IMEISV": ["1111111111111111"]
    },
    "equipment-status":{
        "grey": true,
        "black": false,
        "white": true
    }
}
{
    "profile-data": {
        "IMEISV": ["1111111111111111"],
        "IMSI": ["1111111121","1111111131"],
        "MSISDN": ["1111111112","11111111113"]
    }
    "equipment-status"{
       "grey": true,
        "black": true,
        "white": true
    }
}

201 Created
  • 400: Invalid content request data supplied
  • 400: Schema validation failed for this request
  • 400: Invalid JSON payload
  • 400: Invalid URI sent from client
  • 400: Payload should contain key-value pair present in URI
  • 400: Unknown key, the key imsi123 provided in the request is invalid
  • 400: Invalid content, equipment status cannot be empty
  • 400: Invalid content, equipment status cannot have all its content set to false
  • 400: Invalid content, equipment status missing for EIR Profile
  • 400: Keys other than IMEI in URI not allowed for EIR profile update
  • 400: Invalid Key Value
PUT

Updates EIR and IMSI/MSISDN keys to existing IMEI

Update and delete subscriber profile.

Does patch operation on the existing subscriber

Delete keys included in payload, if not present

 http://localhost:8080/n5g-eir-prov/v1/profile-update/imei-1111111111/deletekeys
{
    "profile-data": {
        "IMSI": ["1111111131","1111111141"],
        "MSISDN": ["1111111113","1111111114"]
    }
}
 204 No Content
  • 400: Invalid content request data supplied
  • 400: Schema validation failed for this request
  • 400: Invalid JSON payload
  • 400: Invalid URI sent from client
  • 400: Unknown key, the key imsi123 provided in the request is invalid
  • 400: Keys other than IMEI in URI not allowed for EIR profile update
EIR Update IMSI/MSISDN keys to existing IMEISV http://localhost:8080/n5g-eir-prov/v1/profile-update/imeisv-1111111111/deletekeys
{
    "profile-data": {
        "IMSI": ["1111111131","1111111141"],
        "MSISDN": ["1111111113","1111111114"]
    }
}
 204 No Content
  • 400: Schema validation failed for this request
  • 400: Invalid JSON payload
  • 400: Invalid URI sent from client
  • 400: Unknown key, the key imsi123 provided in the request is invalid
  • 400: Keys other than IMEI in URI not allowed for EIR profile update
DELETE Delete EIR profile using IMEI http://localhost:8080/n5g-eir-prov/v1/equipment-status/imei-1111111111

204 No Content
  • 404: Subscriber does not exist
DELETE Delete EIR profile using IMEISV http://localhost:8080/n5g-eir-prov/v1/equipment-status/imeisv-1111111111111111

204 No Content
  • 404: Subscriber does not exist
GET Retrieve complete EIR profile using IMEI http://localhost:8080/n5g-eir-prov/v1/equipment-status/imei-1111111111

200 OK

Response

{
    "profile-data": {
        "MSISDN": [
            "1111111112"
        ],
        "IMSI": [
            "1111111121"
        ],
        "IMEI": [
            "1111111111"
        ]
    },
    "equipment-status": {
        "white": true,
        "grey": true,
        "black": true
    }
}
  • 400: Invalid URI sent from client
  • 404: Subscriber does not exist
GET Retrieve complete EIR profile using IMEISV http://localhost:8080/n5g-eir-prov/v1/equipment-status/imeisv-1111111111111111

200 OK

Response

{
    "profile-data": {
        "MSISDN": [
            "1111111112"
        ],
        "IMSI": [
            "1111111121"
        ],
        "IMEISV": [
            "1111111111111111"
        ]
    },
    "equipment-status": {
        "white": true,
        "grey": true,
        "black": true
    }
}
  • 400: Invalid URI sent from client
  • 404: Subscriber does not exist

2.4 Provisioning Operations for PCF Data

This section provides provisioning operations for PCF data.

Note:

UDR accepts custom fields and entities by default. To validate schema for the custom fields or entities, additional configuration is required in UDR. For more information, see Schema Management Specifications. If schema definition is not added for custom fields, UDR skips the schema validation and accepts the custom fields as received in the request payload.

Resource Name: AM, SM, UEPolicySet

HTTP Method: PUT, GET, DELETE

Base URI: {apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}

Table 2-5 AM, SM, UEPolicySet

HTTP Method Sample REST URL Description Possible Error Codes
PUT http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-461772271137732

To add the AM, SM, UEPolicySet information.

Note:
  • In the 4G subscriber profile fields, State must be under sm-data/VendorSpecific-000111
  • The policy data provisioning operation API must have usage and definition information under sm-data/VendorSpecific-000111 content.

    The same must be converted to 5G data and placed under sm-data/umData and sm-data/umDataLimits.

  • Add all the 4G quota and dynamic quota information under sm-data/umData and sm-data/umDataLimits respectively
  • All 5G policy data like smPolicySnssaiData must be under sm-data

Payload: See PUT-AM SM UEPolicyData

To add Policy Data Provisioning along with VSA Data.

Payload: See PUT-Policy Data with VSA Data
  • 400: Blob syntax error with corresponding error details
  • 400: Invalid URI sent from client
PUT (update or delete PCF data) NA To update am-data and delete sm-data information.

Payload: See PUT - update am-data and delete sm-data

NA
GET http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-461772271137732 To view the AM, SM, UEPolicySet information.
  • 400: Invalid URI sent from client"
  • 404: Subscriber does not exist"
  • 404: Data field does not exist
  • 400: Unknown key, the key provided in the request is invalid
DELETE http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-461772271137732 To delete the AM, SM, UEPolicySet information.
  • 400: Invalid URI sent from client
  • 404: Subscriber does not exist
  • 404: Data field does not exist
  • 400: Unknown key, the key provided in the request is invalid

2.5 Subscriber Provisioning APIs for SLF

This section describes the Subscriber Provisioning APIs on SLF.

The Subscriber Provisioning APIs allows PUT, DELETE, and GET operations for imsi, nai, accountID, msisdn, and extid subscribers. The URL template used is http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/<subscriber_type>-<subscriber_id>.

Sample URL is as follows:
  • http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/imsi-2222222221
  • http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/nai-test@xyz.com
  • http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/accountID-12345678912345678912345678
  • http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/msisdn-19195225555
  • http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/extid-user@xyz.com

Table 2-6 Subscriber Provisioning APIs

Operation Type Sample Request Sample Response Possible Error Codes
PUT

http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/accountID-12345678912345678912345678

{ "profile-data": { "imsi": ["2222222221", "2222222222"], "nai": ["test@xyz.com"], "accountID": ["12345678912345678912345678"], "msisdn": ["19195225555", "19195225556"], "extid": ["user@xyz.com"] }, "slfGroupName": "IMSGrp1" }

Add custom fields under profile data using the following payload

{ "profile-data": { "imsi": ["2222222221", "2222222222"], "nai": ["test@xyz.com"], "accountID": ["12345678912345678912345678"], "msisdn": ["19195225555", "19195225556"], "extid": ["user@xyz.com"], "profile-fields": { "customFieldKey": "customValue" } }, "slfGroupName": "IMSGrp1" }

The CHFGroupId provisioning of custom fields is done above. The sample payload for the same is as follows:

{ "profile-data": { "imsi": ["2222222221", "2222222222"], "nai": ["test@xyz.com"], "accountID": ["12345678912345678912345678"], "msisdn": ["19195225555", "19195225556"], "extid": ["user@xyz.com"], "profile-fields": { "CHFGroupId": "CHFGrp1" } }, "slfGroupName": "IMSGrp1" }

 201 Created
  • 404: Group Not Found
  • 400: Schema validation failed for this request
  • 400: Invalid JSON Payload
  • 400: Invalid URI sent from client
  • 400: Payload should contain key-value pair present in URI
  • 400: Unknown key, the key imsi123 provided in the request is invalid
DELETE

http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/accountID-12345678912345678912345678

 204 No Content
  • 404: Subscriber does not exist
GET http://localhost:8080/nudr-group-id-map-prov/v1/slf-group/accountID-12345678912345678912345678

200 OK

{ "profile-data": { "imsi": ["2222222221", "2222222222"], "nai": ["test@xyz.com"], "accountID": ["12345678912345678912345678"], "msisdn": ["19195225555", "19195225556"], "extid": ["user@xyz.com"] }, "slfGroupName": "IMSGrp1" }
  • 404: Subscriber does not exist
  • 400: Invalid URI sent from client

2.6 SLF GroupName Configuration APIs for SLF

This section describes SLF GroupName Configuration APIs. The details are as follows:

Table 2-7 SLF GroupName Configuration APIs

Operation Type Sample Request Sample Response Possible Error Codes
PUT

http://localhost:8080/slf-group-prov/v1/slf-group

{ "slfGroupName": "IMSGrp1", "slfGroupType": "LteHss", "nfGroupIDs": { "NEF": "nef-group-name1", "UDM": "udm-group-name1", "PCF": "pcf-group-name1", "AUSF": "ausf-group-name1" } }

 201 Created
  • 400: Schema validation failed for this request
  • 400: Invalid JSON Payload
  • 400: Invalid URI sent from client
DELETE http://localhost:8080/slf-group-prov/v1/slf-group?slfGroupName="IMSGrp1" 204 No Content
  • 404: Group Not Found
  • 403: Subscriber linked to the group
  • 400: Invalid URI sent from client
GET http://localhost:8080/slf-group-prov/v1/slf-group?slfGroupName="IMSGrp1" 200 OK

{ "slfGroupName": "IMSGrp1", "slfGroupType": "LteHss", "nfGroupIDs": { "NEF": "nef-group-name1", "UDM": "udm-group-name1", "PCF": "pcf-group-name1", "AUSF": "ausf-group-name1" } }
  • 404: Group Not Found
  • 400: Invalid URI sent from client

2.7 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

Table 2-8 AuthenticationSubscriptionData

HTTP Method Sample REST URL Description Possible Error Codes
GET

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"
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-subscription?fields=encOpcKey,algorithmId 

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

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 NA NA

Resource Name: AuthenticationStatus

HTTP Method: PUT, GET, DELETE

Table 2-9 AuthenticationStatus

HTTP Method Sample REST URL Description Possible Error Codes
PUT 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

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 "
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-status?fields=nfInstanceId 
{
    "nfInstanceId": "abae35e5-cc45-4016-8dd4-89598e5311b9"
}
 NA
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/authentication-data/authentication-status NA
  • 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

Table 2-10 Amf3GppAccessRegistration

HTTP Method Sample REST URL Description Possible Error Codes
PUT 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access NA NA
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access/all NA NA
GET 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"
    }
}
 NA
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-3gpp-access/all Output: GET - Amf3GppAccessRegistration NA

Resource Name: AmfNon3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

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

Table 2-11 AmfNon3GppAccessRegistration

HTTP Method Sample REST URL Description Possible Error Codes
PUT 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/amf-non-3gpp-access NA NA
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000025/context-data/amf-non-3gpp-access/all NA NA
GET 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 "
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"
                }
            ]
        }
    ]
}
NA
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000025/context-data/amf-non-3gpp-access/all NA NA

Resource Name: SmfRegistrations

HTTP Method: GET, DELETE

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

Table 2-12 SmfRegistrations

HTTP Method Sample REST URL Description Possible Error Codes
GET 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations NA NA

Resource Name: IndividualSmfRegistration

HTTP Method: PUT, DELETE, GET

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

Table 2-13 IndividualSmfRegistration

HTTP Method Sample REST URL Description Possible Error Codes
PUT 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations/123 NA
  • 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 "
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smf-registrations/123?fields=dnn Output: 

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

Resource Name: Smsf3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

Table 2-14 Smsf3GppAccessRegistration

HTTP Method Sample REST URL Description Possible Error Codes
PUT 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/context-data/smsf-3gpp-access NA NA
GET 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 "
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"
    }
}
 NA

Resource Name: SmsfNon3GppAccessRegistration

HTTP Method: PUT, DELETE, GET

Table 2-15

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

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

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

 NA NA
GET

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 "
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"
    }
}
 NA

Resource Name: AccessAndMobilitySubscriptionData

HTTP Method: GET, PUT, DELETE

Table 2-16 AccessAndMobilitySubscriptionData

HTTP Method Sample REST URL Description Possible Error Codes
GET 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"
http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data?fields=gpsis,nssai,sorInfo NA
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist in data table"
PUT http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data Payload: SeePUT - AccessAndMobilitySubscriptionData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/am-data NA NA

Resource Name: SmfSelectionSubscriptionData

HTTP Method: PUT, DELETE, GET

Table 2-17 SmfSelectionSubscriptionData

HTTP Method Sample REST URL Description Possible Error Codes
PUT 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/smf-selection-subscription-data NA
GET 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 "
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

Table 2-18 SessionManagementSubscriptionData

HTTP Method Sample REST URL Description Possible Error Codes
GET 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 "
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 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 http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000089/77889/provisioned-data/sm-data NA NA

Resource Name: SMSManagementSubscriptionData

HTTP Method: GET, PUT, DELETE

Table 2-19 SMSManagementSubscriptionData

HTTP Method Sample REST URL Description Possible Error Codes
GET 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 "
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

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

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

 NA NA

Resource Name: TraceData

HTTP Method: PUT, GET, DELETE

Table 2-20 TraceData

HTTP Method Sample REST URL Description 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 NA NA

Resource Name: SMSSubscriptionData

HTTP Method:PUT, GET, DELETE

Table 2-21 SMSSubscriptionData

HTTP Method Sample REST URL Description 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 NA NA

Sub-level Name: OperatorSpecificData

HTTP Method: GET, PUT, DELETE

Table 2-22 OperatorSpecificData

HTTP Method Sample REST URL Description 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
    }
}
NA
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 NA NA

Sub-level Name: OperatorDeterminedBarringData

HTTP Method: GET, PUT, DELETE

Table 2-23 OperatorDeterminedBarringData

HTTP Method Sample REST URL Description 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 NA NA
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

Table 2-24 ProvisionedParameterData

HTTP Method Sample REST URL Description 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 NA NA
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

Table 2-25 EeProfileData

HTTP Method Sample REST URL Description 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"
    ]
}
NA
DELETE http://localhost:8080/nudr-dr-prov/v1/subscription-data/imsi-911000000028/ee-profile-data NA NA

Sub-level Name: IdentityData

HTTP Method: PUT, GET, DELETE

Table 2-26 IdentityData

HTTP Method Sample REST URL Description 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 NA NA

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

Resource Name: Sor-data

HTTP Method: PUT, GET, DELETE

Table 2-27 Sor-data

HTTP Method Sample REST URL Description 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 NA NA

2.8 4G Policy Data Operations

The 4G Policy Data operations support the default entities using Vendor Specific Attributes (VSA) entities. The details are as follows:

Note:

UDR accepts custom fields and entities by default. To validate schema for the custom fields or entities, additional configuration is required in UDR. For more information, see Schema Management Specifications. If schema definition is not added for custom fields, UDR skips the schema validation and accepts the custom fields as received in the request payload.

Table 2-28 Default Entities Supported on 4G UDR using VSA

HTTP Method Resource Name Sample REST URL Description Possible Result Codes
POST All Entity {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa

For more information about the request payload, see POST - All Entity on 4G Policy Using VSA.

  • 201: Created
  • 400: Bad Request
  • 400: Duplicate Entry
GET All Entity {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa
  • 200: OK
  • 404: Subscriber does not exists
  • 404: "data field does not exists"
GET Subscriber {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=subscriber

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=subscriber

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/subscriber?fields=MSISDN,Tier,Entitlement,BillingDay

Response Body
{
"MSISDN": ["33123654862"],
"Entitlement": ["DayPass","WeekPass","Weekend"],
"Tier": "Prepaid",
"BillingDay": 23
}
  • 200: OK
  • 404: Subscriber does not exists
  • 404: "data field does not exists"
DELETE Subscriber {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa

This API deletes the entire subscriber and VSA data.
  • 204: No Content
  • 404: Subscriber does not exists
PUT Subscriber {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa

Payload
{
    "subscriber": {
        "SequenceNumber": 3,
        "MSISDN": [
            "13121149999"
        ],
        "BillingDay": 3,
        "operateTime": "20140513162800",
        "Tier": 1,
            "custom2": "abc",    
            "custom3": "abc123"
    }
}
  • 201: Created
  • 400: "Invalid URI sent from client"
  • 409 conflict: " sequence no invalid"
PATCH subscriber {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/subscriber

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/imsi-305801234567890/sm-data/vsa/subscriber

Request Body
[{
 "op": "add",
 "filters": null,
 "patchFields": {
    "Entitlement": ["DayPass"]
 }
},
{
 "op": "replace",
 "filters": null,
 "patchFields": {
   "MSISDN": ["14161234567"]
 }
{
 "op": "delete",
 "filters": null,
 "patchFields": {
    "Entitlement": null
 }
}
}]
  • 201: Created
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exist
PUT Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa

Payload
{
    "usage": {
      "SequenceNumber": 1,
      "quota": [
        {
            "totalVolume": "166000",
            "grantedTotalVolume": "0",
            "name": "AggregateQuota1",
            "grantedinputVolume": "0",
            "nextResetTime": "2010-05-22T00:00:00-05:00Z",
            "time": "3400",
            "outputVolume": "5010",
            "inputVolume": "10000",
            "grantedoutputVolume": "0",
            "quotaState": "valid",
            "serviceSpecific": "22",
            "cid": "9223372036854775808"
        }
      ],
      "version": 3
    }
}
  • 201: Created
  • 400 : "Invalid URI sent from client"
  • 409 conflict : " sequence no invalid"
PUT Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/usage/quota/row

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa/usage/quota/row

Payload
{
    "usage": {
      "SequenceNumber": 1,
      "quota": [
        {
            "totalVolume": "166000",
            "grantedTotalVolume": "0",
            "name": "AggregateQuota1",
            "grantedinputVolume": "0",
            "nextResetTime": "2010-05-22T00:00:00-05:00Z",
            "time": "3400",
            "outputVolume": "5010",
            "inputVolume": "10000",
            "grantedoutputVolume": "0",
            "quotaState": "valid",
            "serviceSpecific": "22",
            "cid": "9223372036854775808"
        }
      ],
      "version": 3
    }
}
  • 201: created
  • 404: Subscriber does not exists
  • 400: Bad Request
GET Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=usage

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=usage

Payload
{
    "usage": {
      "SequenceNumber": 1,
      "quota": [
        {
            "totalVolume": "166000",
            "grantedTotalVolume": "0",
            "name": "AggregateQuota1",
            "grantedinputVolume": "0",
            "nextResetTime": "2010-05-22T00:00:00-05:00Z",
            "time": "3400",
            "outputVolume": "5010",
            "inputVolume": "10000",
            "grantedoutputVolume": "0",
            "quotaState": "valid",
            "serviceSpecific": "22",
            "cid": "9223372036854775808"
        }
      ],
      "version": 3
    }
}
  • 200: Ok
  • 404: Subscriber does not exists
  • 404: data field does not exist
GET Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/usage/quota/row?name=Q1&cid=11223344

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/usage/quota/row?name=Q1&cid=11223344

Response Body
{
    "usage": {
      "SequenceNumber": 1,
      "quota": [
        {
            "totalVolume": "166000",
            "grantedTotalVolume": "0",
            "name": "Q1",
            "grantedinputVolume": "0",
            "nextResetTime": "2010-05-22T00:00:00-05:00Z",
            "time": "3400",
            "outputVolume": "5010",
            "inputVolume": "10000",
            "grantedoutputVolume": "0",
            "quotaState": "valid",
            "serviceSpecific": "22",
            "cid": "11223344"
        }
      ],
      "version": 3
    }
}
  • 200: Ok
  • 404: Subscriber does not exists
  • 404: data field does not exist
GET Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/usage/quota/row?fields=outputvolume&name=Q3&cid=11223344

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/usage/quota/row?fields=outputvolume&name=Q3&cid=11223344

Response Body
{
    "outputVolume": "4000"
}
  • 200: Ok
  • 404: Subscriber does not exists
  • 404: data field does not exist
DELETE Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=usage http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=usage
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exists
DELETE Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/usage/quota/row http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/usage/quota/row?name=Q1&cid=11223344
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exists
PATCH Quota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/usage/quota/row

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/usage/quota/row

Request Body
[{
   "op": "replace",
   "filters": {
      "name": "Q1"
    },
   "patchFields": {
     "inputVolume": "1000"
   }
},
{
   "op": "delete",
   "filters": {
      "name": "Q1"
    },
   "patchFields": {
     "OutputVolume": null
   },
{
   "op": "reset",
   "filters": {
      "name": "Q1"
    },
   "patchFields": null
}]
  • 204: No Content
  • 404: Subscriber does not exists
  • 404 : data field does not exist
PUT State {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa

Payload
{
    "state": {
        "SequenceNumber":0,
        "property": [
            {
                "name": "mcc",
                "value": "315"
            },
            {
                "name": "expire",
                "value": "20130801T09:00:00"
            },
            {
                "name": "approved",
                "value": "no"
            }
        ],
        "version": 1
    }
}
  • 201: Created
  • 400 : "Invalid URI sent from client"
  • 409 conflict : " sequence no invalid"
GET State {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=state

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=state

Payload
{
    "state": {
   "SequenceNumber":0,
        "property": [
            {
                "name": "mcc",
                "value": "315"
            },
            {
                "name": "expire",
                "value": "20130801T09:00:00"
            },
            {
                "name": "approved",
                "value": "no"
            }
        ],
        "version": 1
    }
}
  • 200: Ok
  • 404 : "Subscriber does not exist"
  • 404: data field does not exists
GET State {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/state/property/row?fields=mcc,expire

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/state/property/row?fields=mcc,expire

Response Body
{
 "property": [{
    "name": "mcc",
    "value": "315"
  },
  {
    "name": "expire",
    "value": "20130801T09:00:00"
   }]
}
  • 200: Ok
  • 404: Subscriber does not exists
  • 404 : data field does not exist
DELETE State {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=state http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=state
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exists
PATCH State {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/state/property/row

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/imsi-302370123456789/sm-data/vsa/state/property/row

Request Body
[
{
   "op": "replace",
   "filters": null,
   "patchFields": {
     "mcc": "302"
   }
},
{
   "op": "replace",
   "filters": null,
   "patchFields": {
     "approved": "no"
   }
},
{
   "op": "delete",
   "filters": null,
   "patchFields": {
     "mcc": null
   }
}
]
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exist
PUT DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa

Payload
{
    "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:32Z",
                "expirationdatetime": "2015-04-09T11:20:32Z",
                "InitialTotalVolume": "20000",
                "name": "DynamicAggregateLimit",
                "InitialServiceSpecific": "9",
                "InitialTime": "135"
            }
        ]
    }
}
  • 201: Created
  • 400: "Invalid URI sent from client"
  • 409 conflict: " sequence no invalid"
PUT DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/definition/DynamicQuota/row

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/definition/DynamicQuota/row

Request Body
{
"definition":
   "DynamicQuota": [{
     "InstanceId": "15678",
     "Priority": "4",
     "InitialInputVolume": "1500",
     "InterimReportingInterval": "100",
     "Duration": "10",
     "InitialOutputVolume": "500",
     "Type": "pass",
     "activationdatetime": "2015-03-09T11:20:32Z",
     "expirationdatetime": "2015-04-09T11:20:32Z",
     "InitialTotalVolume": "2000",
     "name": "AggregateLimit",
     "InitialServiceSpecific": "4",
     "InitialTime": "135"
   }]
 }
}
  • 201: created
  • 404: Subscriber does not exists
  • 400: Bad Request
GET DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=definition

http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=definition

Payload
{
    "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:32Z",
                "expirationdatetime": "2015-04-09T11:20:32Z",
                "InitialTotalVolume": "20000",
                "name": "DynamicAggregateLimit",
                "InitialServiceSpecific": "9",
                "InitialTime": "135"
            }
        ]
    }
}
  • 200: Ok
  • 404: "Subscriber does not exist"
  • 404: data field does not exist
GET DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/definition/DynamicQuota/row?name=Q1&cid=11223344

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/definition/DynamicQuota/row?name=DQ1&InstanceId=11223344

Response Body
{
    "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:32Z",
                "expirationdatetime": "2015-04-09T11:20:32Z",
                "InitialTotalVolume": "20000",
                "name": "DynamicAggregateLimit",
                "InitialServiceSpecific": "9",
                "InitialTime": "135"
            }
        ]
    }
}
  • 200: Ok
  • 404: Subscriber does not exists
  • 404: data field does not exist
GET DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/definition/DynamicQuota/row?name=DQ3&InstanceId=15678&fields=InstanceId,InitialTotalVolume,InitialInputVolume

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-15145551234/sm-data/vsa/definition/DynamicQuota/row?name=DQ3&InstanceId=15678&fields=InstanceId,InitialTotalVolume,InitialInputVolume

Response Body 
{
    "InstanceId": "15678"
    "InitialTotalVolume": "2000"
    "InitialInputVolume": "1500"
}
  • 200: Ok
  • 404: Subscriber does not exists
  • 404: data field does not exist
DELETE DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=definition http://localhost:8080/nudr-dr-prov/v2/policy-data/msisdn-1111111111/sm-data/vsa?fields=definition
  • 204: No Content
  • 404: Subscriber does not exists
  • 404 : data field does not exist
DELETE DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/definition/DynamicQuota/row?name=DQ1 http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/definition/DynamicQuota/row?name=DQ1
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exist
PATCH DynamicQuota {apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa/definition/DynamicQuota/row

http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa/definition/DynamicQuota/row

Request Body
[
{
   "op": "replace",
   "filters": {
      "name": "DQ1",
      "InstanceId": "15678"
    },
   "patchFields": {
     "InitialTotalVolume": "1000"
   }
},
{
   "op": "delete",
   "filters": {
      "name": "DQ1",
      "InstanceId": "11223344"
    },
   "patchFields": {
     "InitialInputVolume": null
   }
}
]
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exist
DELETE All Entities Except Subscriber entity { apiRoot}/nudr-dr-prov/v2/policy-data/{ueId}/sm-data/vsa?fields=all http://5G_UDR_IP:PORT/nudr-dr-prov/v2/policy-data/msisdn-33123654862/sm-data/vsa?fields=all

This API deletes all VSA data (quota, state, and dynamicQuota) except subscriber entity.
  • 204: No Content
  • 404: Subscriber does not exists
  • 404: data field does not exist