Content for TS 29.563 Word version: 18.4.0
6 API Definitions
6.1 Nhss_UEAuthentication Service API
6.2 Nhss_SubscriberDataManagement Service API
6.3 Nhss_UEContextManagement Service API
6.4 Nhss_EventExposure Service API
A OpenAPI specification
B Withdrawn API versions
$ Change history
6 API Definitions p. 23
6.1 Nhss_UEAuthentication Service API p. 23
6.1.1 Introduction p. 23
6.1.2 Usage of HTTP p. 24
6.1.2.1 General p. 24
6.1.2.2 HTTP standard headers p. 24
6.1.2.2.1 General p. 24
6.1.2.2.2 Content type p. 24
6.1.2.3 HTTP custom headers p. 24
6.1.2.3.1 General p. 24
6.1.3 Resources p. 24
6.1.3.1 Overview p. 24
6.1.4 Custom Operations without associated resources p. 25
6.1.4.1 Overview p. 25
6.1.4.2 Operation: Generate AV p. 25
6.1.4.2.1 Description p. 25
6.1.4.2.2 Operation Definition p. 25
6.1.5 Notifications p. 26
6.1.6 Data Model p. 26
6.1.6.1 General p. 26
6.1.6.2 Structured data types p. 27
6.1.6.2.1 Introduction p. 27
6.1.6.2.2 Type: AvGenerationRequest p. 27
6.1.6.2.3 Type: AvGenerationResponse p. 27
6.1.6.3 Simple data types and enumerations p. 27
6.1.6.3.1 Introduction p. 27
6.1.6.3.2 Simple data types p. 27
6.1.7 Error Handling p. 27
6.1.8 Feature negotiation p. 28
6.1.9 Security |R18| p. 28
6.1.10 HTTP redirection |R18| p. 28
6.2 Nhss_SubscriberDataManagement Service API p. 28
6.2.1 API URI p. 28
6.2.2 Usage of HTTP p. 29
6.2.2.1 General p. 29
6.2.2.2 HTTP standard headers p. 29
6.2.2.2.1 General p. 29
6.2.2.2.2 Content type p. 29
6.2.2.3 HTTP custom headers p. 29
6.2.2.3.1 General p. 29
6.2.3 Resources p. 30
6.2.3.1 Overview p. 30
6.2.3.2 Resource: UeContextInPgwData p. 30
6.2.3.2.1 Description p. 30
6.2.3.2.2 Resource Definition p. 30
6.2.3.2.3 Resource Standard Methods p. 31
6.2.3.3 Resource: Subscriptions p. 32
6.2.3.3.1 Description p. 32
6.2.3.3.2 Resource Definition p. 32
6.2.3.3.3 Resource Standard Methods p. 32
6.2.3.4 Resource: Individual subscription p. 33
6.2.4 Custom Operations without associated resources |R17| p. 36
6.2.5 Notifications |R17| p. 36
6.2.5.1 General p. 36
6.2.5.2 Data Change Notification p. 36
6.2.6 Data Model p. 37
6.2.6.1 General p. 37
6.2.6.2 Structured data types p. 38
6.2.6.2.1 Introduction p. 38
6.2.6.2.2 Type: UeContextInPgwData p. 38
6.2.6.2.3 Type: SubscriptionData p. 39
6.2.6.2.4 Type: SubscriptionDataSets p. 39
6.2.6.3 Simple data types and enumerations p. 39
6.2.6.3.1 Introduction p. 39
6.2.6.3.2 Simple data types p. 39
6.2.7 Error Handling p. 40
6.2.8 Feature Negotiation p. 40
6.2.9 Security |R18| p. 40
6.2.10 HTTP redirection |R18| p. 40
6.3 Nhss_UEContextManagement Service API p. 41
6.3.1 Introduction p. 41
6.3.2 Usage of HTTP p. 41
6.3.2.1 General p. 41
6.3.2.2 HTTP standard headers p. 41
6.3.2.2.1 General p. 41
6.3.2.2.2 Content type p. 41
6.3.2.3 HTTP custom headers p. 41
6.3.2.3.1 General p. 41
6.3.3 Resources p. 42
6.3.3.1 Overview p. 42
6.3.4 Custom Operations without associated resources p. 42
6.3.4.1 Overview p. 42
6.3.4.2 Operation: deregister-sn p. 42
6.3.4.2.1 Description p. 42
6.3.4.2.2 Operation Definition p. 42
6.3.4.3 Operation: imei-update p. 43
6.3.4.3.1 Description p. 43
6.3.4.3.2 Operation Definition p. 43
6.3.4.4 Operation: roaming-status-update |R17| p. 44
6.3.4.4.1 Description p. 44
6.3.4.4.2 Operation Definition p. 44
6.3.5 Notifications p. 45
6.3.6 Data Model p. 45
6.3.6.1 General p. 45
6.3.6.2 Structured data types p. 46
6.3.6.2.1 Introduction p. 46
6.3.6.2.2 Type: DeregistrationRequest p. 46
6.3.6.2.3 Type: ImeiUpdateInfo p. 46
6.3.6.2.4 Type: ImeiUpdateResponse |R17| p. 47
6.3.6.2.5 Type: RoamingStatusUpdateInfo |R17| p. 47
6.3.6.3 Simple data types and enumerations p. 47
6.3.7 Error Handling p. 48
6.3.8 Feature Negotiation p. 48
6.3.9 Security |R18| p. 49
6.3.10 HTTP redirection |R18| p. 49
6.4 Nhss_EventExposure Service API p. 49
6.4.1 API URI p. 49
6.4.2 Usage of HTTP p. 49
6.4.2.1 General p. 49
6.4.2.2 HTTP standard headers p. 49
6.4.2.2.1 General p. 49
6.4.2.2.2 Content type p. 50
6.4.2.3 HTTP custom headers p. 50
6.4.2.3.1 General p. 50
6.4.3 Resources p. 50
6.4.3.1 Overview p. 50
6.4.3.2 Resource: EeSubscriptions (Collection) p. 51
6.4.3.2.1 Description p. 51
6.4.3.2.2 Resource Definition p. 51
6.4.3.2.3 Resource Standard Methods p. 51
6.4.3.3 Resource: Individual subscription (Document) p. 52
6.4.4 Custom Operations without associated resources p. 55
6.4.5 Notifications p. 55
6.4.5.1 General p. 55
6.4.5.2 Event Occurrence Notification p. 56
6.4.6 Data Model p. 57
6.4.6.1 General p. 57
6.4.6.2 Structured data types p. 57
6.4.6.2.1 Introduction p. 57
6.4.6.2.2 Type: EeSubscription p. 58
6.4.6.2.3 Type: CreatedEeSubscription p. 59
6.4.6.2.4 Type: MonitoringConfiguration p. 60
6.4.6.2.5 Type: MonitoringReport p. 60
6.4.6.2.6 Type: Report p. 61
6.4.6.2.7 Type: ReportingOptions p. 61
6.4.6.2.8 Type: LocationReportingConfiguration p. 61
6.4.6.2.9 Type: ReachabilityForSmsReport p. 62
6.4.6.2.10 Type: LossConnectivityConfiguration p. 62
6.4.6.2.11 Type: ReachabilityForDataConfiguration p. 62
6.4.6.2.12 Type: PduSessionStatusCfg p. 62
6.4.6.2.13 Type: ReachabilityForDataReport p. 63
6.4.6.2.14 Type: FailedMonitoringConfiguration |R17| p. 63
6.4.6.2.15 Type: EeSubscriptionErrorAddInfo |R18| p. 63
6.4.6.2.16 Type: EeSubscriptionError |R18| p. 63
6.4.6.3 Simple data types and enumerations p. 63
6.4.7 Error Handling p. 65
6.4.8 Feature Negotiation p. 65
6.4.9 Security p. 66
6.4.10 HTTP redirection |R18| p. 66
A (Normative) OpenAPI specification p. 67
A.1 General p. 67
A.2 Nhss_UEAuthentication API p. 67
A.3 Nhss_SubscriberDataManagement API p. 69
A.4 Nhss_UEContextManagement API p. 73
A.5 Nhss_EE API p. 77
B Withdrawn API versions p. 85
B.1 General p. 85
$ Change history p. 86
