5.2.51 Resource: UserConsentData
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.51.1 Description
This resource represents UE’s subscribed User Consent Data for a UE identifier. It is queried by the UDM during User Consent Data Retrieval.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).
5.2.51.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/uc-data
This resource shall support the resource URI variables defined in table 5.2.51.2-1.
Table 5.2.51.2-1: Resource URI variables for this resource
Name |
Definition |
apiRoot |
See 3GPP TS 29.504 [2] clause 6.1.1 |
ueId |
Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [4] clause 5.9.2). |
5.2.51.3 Resource Standard Methods
5.2.51.3.1 GET
This method shall support the URI query parameters specified in table 5.2.51.3.1-1.
Table 5.2.51.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
supported-features |
SupportedFeatures |
O |
0..1 |
see 3GPP TS 29.500 [8] clause 6.6 |
uc-purpose |
UcPurpose |
O |
0..1 |
Represents the user consent purpose. pattern: See pattern of type UcPurpose in 3GPP TS 29.503 [6] |
This method shall support the request data structures specified in table 5.2.51.3.1-2 and the response data structures and response codes specified in table 5.2.51.3.1-3.
Table 5.2.51.3.1-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.2.51.3.1-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
UcSubscriptionData |
M |
1 |
200 OK |
Upon success, a response body containing UE’s subscribed User Consent Data. |
NOTE: In addition, common data structures as listed in table 5.5-1 are supported. |