Content for TS 29.503 Word version: 17.5.0
6 API Definitions
6.1 Nudm_SubscriberDataManagement Service API
6.1.1 API URI
6.1.2 Usage of HTTP
6.1.3 Resources
6.1.4 Custom Operations without associated resources
6.1.5 Notifications
6.1.6 Data Model
6.1.7 Error Handling
6.1.8 Feature Negotiation
6.1.9 Security
...
...
6 API Definitions Word‑p. 94
6.1 Nudm_SubscriberDataManagement Service API Word‑p. 94
6.1.1 API URI Word‑p. 94
6.1.2 Usage of HTTP Word‑p. 95
6.1.2.1 General Word‑p. 95
6.1.2.2 HTTP standard headers Word‑p. 95
6.1.2.2.1 General Word‑p. 95
6.1.2.2.2 Content type Word‑p. 95
6.1.2.2.3 Cache-Control Word‑p. 95
6.1.2.2.4 ETag Word‑p. 95
6.1.2.2.5 If-None-Match Word‑p. 95
6.1.2.2.6 Last-Modified Word‑p. 96
6.1.2.2.7 If-Modified-Since Word‑p. 96
6.1.2.2.8 When to Use Entity-Tags and Last-Modified Dates Word‑p. 96
6.1.2.3 HTTP custom headers Word‑p. 96
6.1.2.3.1 General Word‑p. 96
6.1.3 Resources Word‑p. 96
6.1.3.1 Overview Word‑p. 96
6.1.3.2 Resource: Nssai (Document) Word‑p. 101
6.1.3.2.1 Description Word‑p. 101
6.1.3.2.2 Resource Definition Word‑p. 101
6.1.3.2.3 Resource Standard Methods Word‑p. 101
6.1.3.2.3.1 GET Word‑p. 101
6.1.3.3 Resource: SdmSubscriptions (Collection) Word‑p. 102
6.1.3.3.1 Description Word‑p. 102
6.1.3.3.2 Resource Definition Word‑p. 102
6.1.3.3.3 Resource Standard Methods Word‑p. 103
6.1.3.3.3.1 POST Word‑p. 103
6.1.3.4 Resource: Individual subscription (Document) Word‑p. 104
6.1.3.4.1 Description Word‑p. 104
6.1.3.4.2 Resource Definition Word‑p. 104
6.1.3.4.3 Resource Standard Methods Word‑p. 104
6.1.3.4.3.1 DELETE Word‑p. 104
6.1.3.4.3.2 PATCH Word‑p. 104
6.1.3.5 Resource: AccessAndMobilitySubscriptionData (Document) Word‑p. 105
6.1.3.5.1 Description Word‑p. 105
6.1.3.5.2 Resource Definition Word‑p. 105
6.1.3.5.3 Resource Standard Methods Word‑p. 106
6.1.3.5.3.1 GET Word‑p. 106
6.1.3.5.4 Resource Custom Operations |R16| Word‑p. 107
6.1.3.5.4.1 Overview Word‑p. 107
6.1.3.5.4.2 Operation: update-sor Word‑p. 107
6.1.3.6 Resource: SmfSelectionSubscriptionData (Document) Word‑p. 108
6.1.3.6.1 Description Word‑p. 108
6.1.3.6.2 Resource Definition Word‑p. 108
6.1.3.6.3 Resource Standard Methods Word‑p. 108
6.1.3.6.3.1 GET Word‑p. 108
6.1.3.7 Resource: UeContextInSmfData (Document) Word‑p. 109
6.1.3.7.1 Description Word‑p. 109
6.1.3.7.2 Resource Definition Word‑p. 109
6.1.3.7.3 Resource Standard Methods Word‑p. 109
6.1.3.7.3.1 GET Word‑p. 109
6.1.3.8 Resource: SessionManagementSubscriptionData (Document) Word‑p. 110
6.1.3.8.1 Description Word‑p. 110
6.1.3.8.2 Resource Definition Word‑p. 110
6.1.3.8.3 Resource Standard Methods Word‑p. 110
6.1.3.8.3.1 GET Word‑p. 110
6.1.3.9 Resource: SMSSubscriptionData (Document) Word‑p. 112
6.1.3.9.1 Description Word‑p. 112
6.1.3.9.2 Resource Definition Word‑p. 112
6.1.3.9.3 Resource Standard Methods Word‑p. 112
6.1.3.9.3.1 GET Word‑p. 112
6.1.3.10 Resource: SMSManagementSubscriptionData (Document) Word‑p. 113
6.1.3.10.1 Description Word‑p. 113
6.1.3.10.2 Resource Definition Word‑p. 113
6.1.3.10.3 Resource Standard Methods Word‑p. 114
6.1.3.10.3.1 GET Word‑p. 114
6.1.3.11 Resource: Supi (Document) Word‑p. 114
6.1.3.11.1 Description Word‑p. 114
6.1.3.11.2 Resource Definition Word‑p. 115
6.1.3.11.3 Resource Standard Methods Word‑p. 115
6.1.3.11.3.1 GET Word‑p. 115
6.1.3.12 Resource: IdTranslationResult (Document) Word‑p. 116
6.1.3.12.1 Description Word‑p. 116
6.1.3.12.2 Resource Definition Word‑p. 116
6.1.3.12.3 Resource Standard Methods Word‑p. 116
6.1.3.12.3.1 GET Word‑p. 116
6.1.3.13 Resource: SorAck (Document) Word‑p. 118
6.1.3.13.1 Description Word‑p. 118
6.1.3.13.2 Resource Definition Word‑p. 118
6.1.3.13.3 Resource Standard Methods Word‑p. 118
6.1.3.13.3.1 PUT Word‑p. 118
6.1.3.14 Resource: TraceData (Document) Word‑p. 119
6.1.3.14.1 Description Word‑p. 119
6.1.3.14.2 Resource Definition Word‑p. 119
6.1.3.14.3 Resource Standard Methods Word‑p. 119
6.1.3.14.3.1 GET Word‑p. 119
6.1.3.15 Resource: SharedData (Collection) Word‑p. 120
6.1.3.15.1 Description Word‑p. 120
6.1.3.15.2 Resource Definition Word‑p. 120
6.1.3.15.3 Resource Standard Methods Word‑p. 120
6.1.3.15.3.1 GET Word‑p. 120
6.1.3.16 Resource: SharedDataSubscriptions (Collection) Word‑p. 121
6.1.3.16.1 Description Word‑p. 121
6.1.3.16.2 Resource Definition Word‑p. 121
6.1.3.16.3 Resource Standard Methods Word‑p. 122
6.1.3.16.3.1 POST Word‑p. 122
6.1.3.17 Resource: Individual subscription (Document) Word‑p. 122
6.1.3.17.1 Description Word‑p. 122
6.1.3.17.2 Resource Definition Word‑p. 123
6.1.3.17.3 Resource Standard Methods Word‑p. 123
6.1.3.17.3.1 DELETE Word‑p. 123
6.1.3.17.3.2 PATCH Word‑p. 123
6.1.3.18 Resource: UeContextInSmsfData (Document) Word‑p. 124
6.1.3.18.1 Description Word‑p. 124
6.1.3.18.2 Resource Definition Word‑p. 124
6.1.3.18.3 Resource Standard Methods Word‑p. 125
6.1.3.18.3.1 GET Word‑p. 125
6.1.3.19 Resource: UpuAck (Document) Word‑p. 125
6.1.3.19.1 Description Word‑p. 125
6.1.3.19.2 Resource Definition Word‑p. 125
6.1.3.19.3 Resource Standard Methods Word‑p. 126
6.1.3.19.3.1 PUT Word‑p. 126
6.1.3.20 Resource: GroupIdentifiers (Document) Word‑p. 126
6.1.3.20.1 Description Word‑p. 126
6.1.3.20.2 Resource Definition Word‑p. 126
6.1.3.20.3 Resource Standard Methods Word‑p. 126
6.1.3.20.3.1 GET Word‑p. 126
6.1.3.21 Resource: SnssaisAck (Document) Word‑p. 128
6.1.3.21.1 Description Word‑p. 128
6.1.3.21.2 Resource Definition Word‑p. 128
6.1.3.21.3 Resource Standard Methods Word‑p. 128
6.1.3.21.3.1 PUT Word‑p. 128
6.1.3.22 Resource: CagAck (Document) |R16| Word‑p. 128
6.1.3.22.1 Description Word‑p. 128
6.1.3.22.2 Resource Definition Word‑p. 129
6.1.3.22.3 Resource Standard Methods Word‑p. 129
6.1.3.22.3.1 PUT Word‑p. 129
6.1.3.23 Resource: LcsPrivacySubscriptionData (Document) |R16| Word‑p. 129
6.1.3.23.1 Description Word‑p. 129
6.1.3.23.2 Resource Definition Word‑p. 129
6.1.3.23.3 Resource Standard Methods Word‑p. 130
6.1.3.23.3.1 GET Word‑p. 130
6.1.3.24 Resource: LcsMobileOriginatedSubscriptionData (Document) |R16| Word‑p. 130
6.1.3.24.1 Description Word‑p. 130
6.1.3.24.2 Resource Definition Word‑p. 130
6.1.3.24.3 Resource Standard Methods Word‑p. 131
6.1.3.24.3.1 GET Word‑p. 131
6.1.3.25 Resource: EnhancedCoverageRestrictionData |R16| Word‑p. 131
6.1.3.25.1 Description Word‑p. 131
6.1.3.25.2 Resource Definition Word‑p. 131
6.1.3.25.3 Resource Standard Methods Word‑p. 132
6.1.3.25.3.1 GET Word‑p. 132
6.1.3.26 Resource: UeContextInAmfData (Document) |R16| Word‑p. 132
6.1.3.26.1 Description Word‑p. 132
6.1.3.26.2 Resource Definition Word‑p. 132
6.1.3.26.3 Resource Standard Methods Word‑p. 133
6.1.3.26.3.1 GET Word‑p. 133
6.1.3.27 Resource: V2xSubscriptionData (Document) |R16| Word‑p. 133
6.1.3.27.1 Description Word‑p. 133
6.1.3.27.2 Resource Definition Word‑p. 133
6.1.3.27.3 Resource Standard Methods Word‑p. 133
6.1.3.27.3.1 GET Word‑p. 133
6.1.3.29 Resource: IndividualSharedData (Document) |R16| Word‑p. 135
6.1.3.29.1 Description Word‑p. 135
6.1.3.29.2 Resource Definition Word‑p. 135
6.1.3.29.3 Resource Standard Methods Word‑p. 135
6.1.3.29.3.1 GET Word‑p. 135
6.1.3.30 Resource: ProseSubscriptionData (Document) |R17| Word‑p. 136
6.1.3.30.1 Description Word‑p. 136
6.1.3.30.2 Resource Definition Word‑p. 136
6.1.3.30.3 Resource Standard Methods Word‑p. 136
6.1.3.30.3.1 GET Word‑p. 136
6.1.3.31 Resource: MbsSubscriptionData (Document) |R17| Word‑p. 137
6.1.3.31.1 Description Word‑p. 137
6.1.3.31.2 Resource Definition Word‑p. 137
6.1.3.31.3 Resource Standard Methods Word‑p. 137
6.1.3.31.3.1 GET Word‑p. 137
6.1.4 Custom Operations without associated resources Word‑p. 138
6.1.5 Notifications Word‑p. 138
6.1.5.1 General Word‑p. 138
6.1.5.2 Data Change Notification Word‑p. 138
6.1.6 Data Model Word‑p. 139
6.1.6.1 General Word‑p. 139
6.1.6.2 Structured data types Word‑p. 145
6.1.6.2.1 Introduction Word‑p. 145
6.1.6.2.2 Type: Nssai Word‑p. 146
6.1.6.2.3 Type: SdmSubscription Word‑p. 147
6.1.6.2.4 Type: AccessAndMobilitySubscriptionData Word‑p. 150
6.1.6.2.5 Type: SmfSelectionSubscriptionData Word‑p. 155
6.1.6.2.6 Type: DnnInfo Word‑p. 156
6.1.6.2.7 Type: SnssaiInfo Word‑p. 156
6.1.6.2.8 Type: SessionManagementSubscriptionData Word‑p. 157
6.1.6.2.9 Type: DnnConfiguration Word‑p. 158
6.1.6.2.10 Void
6.1.6.2.11 Type: PduSessionTypes Word‑p. 160
6.1.6.2.12 Type: SscModes Word‑p. 161
6.1.6.2.13 Type: SmsSubscriptionData Word‑p. 161
6.1.6.2.14 Type: SmsManagementSubscriptionData Word‑p. 161
6.1.6.2.15 Type: SubscriptionDataSets Word‑p. 162
6.1.6.2.16 Type: UeContextInSmfData Word‑p. 162
6.1.6.2.17 Type: PduSession Word‑p. 162
6.1.6.2.18 Type: IdTranslationResult Word‑p. 163
6.1.6.2.19 Void
6.1.6.2.20 Void
6.1.6.2.21 Type: ModificationNotification Word‑p. 163
6.1.6.2.22 Type: IpAddress Word‑p. 163
6.1.6.2.23 Type: UeContextInSmsfData Word‑p. 163
6.1.6.2.24 Type: SmsfInfo Word‑p. 163
6.1.6.2.25 Type: AcknowledgeInfo Word‑p. 164
6.1.6.2.26 Type: SorInfo Word‑p. 165
6.1.6.2.27 Type: SharedData Word‑p. 167
6.1.6.2.28 Type: PgwInfo Word‑p. 168
6.1.6.2.29 Type: TraceDataResponse Word‑p. 168
6.1.6.2.30 Type: SteeringContainer Word‑p. 168
6.1.6.2.31 Type: SdmSubsModification Word‑p. 169
6.1.6.2.32 Type: EmergencyInfo Word‑p. 169
6.1.6.2.33 Type: UpuInfo Word‑p. 170
6.1.6.2.34 Type: GroupIdentifiers Word‑p. 171
6.1.6.2.35 Type: NiddInformation |R16| Word‑p. 171
6.1.6.2.36 Type: CagData |R16| Word‑p. 171
6.1.6.2.37 Type: CagInfo |R16| Word‑p. 172
6.1.6.2.38 Type: AdditionalSnssaiData |R16| Word‑p. 172
6.1.6.2.39 Type: VnGroupData |R16| Word‑p. 172
6.1.6.2.40 Type: AppDescriptor |R16| Word‑p. 172
6.1.6.2.41 Type: AppPortId |R16| Word‑p. 173
6.1.6.2.42 Type: LcsPrivacyData |R16| Word‑p. 173
6.1.6.2.43 Type: Lpi |R16| Word‑p. 173
6.1.6.2.44 Type: UnrelatedClass |R16| Word‑p. 173
6.1.6.2.45 Type: PlmnOperatorClass |R16| Word‑p. 174
6.1.6.2.46 Type: ValidTimePeriod |R16| Word‑p. 174
6.1.6.2.47 Type: LcsMoData |R16| Word‑p. 174
6.1.6.2.48 Type: EcRestrictionDataWb |R16| Word‑p. 174
6.1.6.2.49 Type: ExpectedUeBehaviourData |R16| Word‑p. 175
6.1.6.2.50 Void
6.1.6.2.51 Void
6.1.6.2.52 Type: SuggestedPacketNumDl |R16| Word‑p. 175
6.1.6.2.53 Void
6.1.6.2.54 Type: FrameRouteInfo |R16| Word‑p. 176
6.1.6.2.55 Type: SorUpdateInfo |R16| Word‑p. 176
6.1.6.2.56 Type: EnhancedCoverageRestrictionData |R16| Word‑p. 176
6.1.6.2.57 Type: EdrxParameters |R16| Word‑p. 176
6.1.6.2.58 Type: PtwParameters |R16| Word‑p. 177
6.1.6.2.59 Void
6.1.6.2.60 Void
6.1.6.2.61 Void
6.1.6.2.62 Type: ExternalUnrelatedClass |R16| Word‑p. 177
6.1.6.2.63 Type: AfExternal |R16| Word‑p. 177
6.1.6.2.64 Type: LcsClientExternal |R16| Word‑p. 178
6.1.6.2.65 Type: LcsClientGroupExternal |R16| Word‑p. 178
6.1.6.2.66 Type: ServiceTypeUnrelatedClass |R16| Word‑p. 178
6.1.6.2.67 Type: UeId |R16| Word‑p. 179
6.1.6.2.68 Type: DefaultUnrelatedClass |R16| Word‑p. 179
6.1.6.2.69 Type: ContextInfo |R16| Word‑p. 179
6.1.6.2.70 Type: UeContextInAmfData |R16| Word‑p. 179
6.1.6.2.71 Type: V2xSubscriptionData |R16| Word‑p. 180
6.1.6.2.72 Type: LcsBroadcastAssistanceTypesData |R16| Word‑p. 181
6.1.6.2.73 Type: DatasetNames |R16| Word‑p. 184
6.1.6.2.74 Type: PlmnRestriction |R17| Word‑p. 184
6.1.6.2.75 Type: PcfSelectionAssistanceInfo |R17| Word‑p. 185
6.1.6.2.76 Type: ProseSubscriptionData |R17| Word‑p. 185
6.1.6.2.77 Type: IpIndex |R17| Word‑p. 185
6.1.6.2.78 Type: AerialUeSubscriptionInfo |R17| Word‑p. 185
6.1.6.2.79 Type: SmSubsData |R17| Word‑p. 185
6.1.6.2.80 Type: ExtendedSmSubsData |R17| Word‑p. 186
6.1.6.2.81 Type: AmfInfo |R17| Word‑p. 186
6.1.6.2.82 Type: ProSeAllowedPlmn |R17| Word‑p. 186
6.1.6.2.83 Type: ImmediateReport |R17| Word‑p. 186
6.1.6.2.84 Type: MbsSubscriptionData |R17| Word‑p. 187
6.1.6.3 Simple data types and enumerations Word‑p. 187
6.1.6.3.1 Introduction Word‑p. 187
6.1.6.3.2 Simple data types Word‑p. 187
6.1.6.3.3 Enumeration: DataSetName Word‑p. 189
6.1.6.3.4 Void
6.1.6.3.5 Void
6.1.6.3.6 Void
6.1.6.3.7 Enumeration: PduSessionContinuityInd |R16| Word‑p. 189
6.1.6.3.8 Enumeration: LocationPrivacyInd |R16| Word‑p. 189
6.1.6.3.9 Enumeration: PrivacyCheckRelatedAction |R16| Word‑p. 190
6.1.6.3.10 Enumeration: LcsClientClass |R16| Word‑p. 190
6.1.6.3.11 Enumeration: LcsMoServiceClass |R16| Word‑p. 190
6.1.6.3.12 Enumeration: OperationMode |R16| Word‑p. 190
6.1.6.3.13 Enumeration: SorUpdateIndicator |R16| Word‑p. 190
6.1.6.3.14 Enumeration: CodeWordInd |R16| Word‑p. 191
6.1.6.3.15 Enumeration: MdtUserConsent |R16| Word‑p. 191
6.1.6.3.16 Enumeration: SharedDataTreatmentInstruction |R17| Word‑p. 191
6.1.6.3.17 Enumeration: GpsiType |R17| Word‑p. 191
6.1.6.3.18 Enumeration: AerialUeIndication |R17| Word‑p. 191
6.1.6.3.19 Enumeration: ProseDirectAllowed |R17| Word‑p. 192
6.1.7 Error Handling Word‑p. 192
6.1.7.1 General Word‑p. 192
6.1.7.2 Protocol Errors Word‑p. 192
6.1.7.3 Application Errors Word‑p. 192
6.1.8 Feature Negotiation Word‑p. 193
6.1.9 Security Word‑p. 196
