Tech-invite 3GPPspace IETFspace

21 22 23 24 25 26 27 28 29 31 32 33 34 35 36 37 38 4‑5x

Content for TS 29.580 Word version: 19.1.0

1… 5…

5.1 Introduction 5.2 Nmbsf_MBSUserService Service 5.3 Nmbsf_MBSUserDataIngestSession Service 6.1 Nmbsf_MBSUserService Service API 6.2 Nmbsf_MBSUserDataIngestSession Service API A.1 General A.2 Nmbsf_MBSUserService API A.3 Nmbsf_MBSUserDataIngestSession API B.1 General B.2 Nmbsf_MBSUserService API B.3 Nmbsf_MBSUserDataIngestSession API

5 Services offered by the MBSF p. 12

5.1 Introduction p. 12

5.2 Nmbsf_MBSUserService Service p. 12

5.2.1 Service Description p. 12

5.2.2 Service Operations p. 12

5.2.2.1 Introduction p. 12

5.2.2.2 Nmbsf_MBSUserService_Create service operation p. 13

5.2.2.2.1 General p. 13

5.2.2.2.2 MBS User Service Creation p. 13

5.2.2.3 Nmbsf_MBSUserService_Retrieve service operation p. 14

5.2.2.3.1 General p. 14

5.2.2.3.2 MBS User Service Retrieval p. 14

5.2.2.4 Nmbsf_MBSUserService_Update service operation p. 15

5.2.2.4.1 General p. 15

5.2.2.4.2 MBS User Service Update p. 15

5.2.2.5 Nmbsf_MBSUserService_Delete service operation p. 15

5.2.2.5.1 General p. 15

5.2.2.5.2 MBS User Service Deletion p. 16

5.3 Nmbsf_MBSUserDataIngestSession Service p. 17

5.3.1 Service Description p. 17

5.3.2 Service Operations p. 17

5.3.2.1 Introduction p. 17

5.3.2.2 Nmbsf_MBSUserDataIngestSession_Create service operation p. 18

5.3.2.2.1 General p. 18

5.3.2.2.2 MBS User Data Ingest Session Creation p. 18

5.3.2.3 Nmbsf_MBSUserDataIngestSession_Retrieve service operation p. 19

5.3.2.3.1 General p. 19

5.3.2.3.2 MBS User Data Ingest Session Retrieval p. 20

5.3.2.4 Nmbsf_MBSUserDataIngestSession_Update service operation p. 20

5.3.2.4.1 General p. 20

5.3.2.4.2 MBS User Data Ingest Session Update p. 20

5.3.2.5 Nmbsf_MBSUserDataIngestSession_Delete service operation p. 22

5.3.2.5.1 General p. 22

5.3.2.5.2 MBS User Data Ingest Session Deletion p. 22

5.3.2.6 Nmbsf_MBSUserDataIngestSession_StatusSubscribe service operation p. 22

5.3.2.6.1 General p. 22

5.3.2.6.2 MBS User Data Ingest Session Status Subscription Creation p. 23

5.3.2.7 Nmbsf_MBSUserDataIngestSession_StatusSubscribeMod service operation p. 23

5.3.2.7.1 General p. 23

5.3.2.7.2 MBS User Data Ingest Session Status Subscription Update p. 24

5.3.2.8 Nmbsf_MBSUserDataIngestSession_StatusUnsubscribe service operation p. 24

5.3.2.8.1 General p. 24

5.3.2.8.2 MBS User Data Ingest Session Status Subscription Deletion p. 24

5.3.2.9 Nmbsf_MBSUserDataIngestSession_StatusNotify service operation p. 25

5.3.2.9.1 General p. 25

5.3.2.9.2 MBS User Data Ingest Session Status Notification p. 25

6 API Definitions p. 27

6.1 Nmbsf_MBSUserService Service API p. 27

6.1.1 Introduction p. 27

6.1.2 Usage of HTTP p. 27

6.1.2.1 General p. 27

6.1.2.2 HTTP standard headers p. 27

6.1.2.2.1 General p. 27

6.1.2.2.2 Content type p. 27

6.1.2.3 HTTP custom headers p. 28

6.1.3 Resources p. 28

6.1.3.1 Overview p. 28

6.1.3.2 Resource: MBS User Services p. 28

6.1.3.2.1 Description p. 28

6.1.3.2.2 Resource Definition p. 29

6.1.3.2.3 Resource Standard Methods p. 29

6.1.3.2.3.1 GET p. 29

6.1.3.2.3.2 POST p. 30

6.1.3.2.4 Resource Custom Operations p. 31

6.1.3.3 Resource: Individual MBS User Service p. 31

6.1.3.3.1 Description p. 31

6.1.3.3.2 Resource Definition p. 31

6.1.3.3.3 Resource Standard Methods p. 31

6.1.3.3.3.1 GET p. 31

6.1.3.3.3.2 PUT p. 32

6.1.3.3.3.3 PATCH p. 33

6.1.3.3.3.4 DELETE p. 35

6.1.4 Custom Operations without associated resources p. 36

6.1.5 Notifications p. 36

6.1.6 Data Model p. 36

6.1.6.1 General p. 36

6.1.6.2 Structured data types p. 36

6.1.6.2.1 Introduction p. 36

6.1.6.2.2 Type: MBSUserService p. 37

6.1.6.2.3 Type: ServiceNameDescription p. 37

6.1.6.2.4 Type: MBSUserServicePatch p. 38

6.1.6.3 Simple data types and enumerations p. 38

6.1.6.3.1 Introduction p. 38

6.1.6.3.2 Simple data types p. 38

6.1.6.3.3 Enumeration: ServiceAnnouncementMode p. 38

6.1.6.4 Data types describing alternative data types or combinations of data types p. 39

6.1.6.5 Binary data p. 39

6.1.6.5.1 Binary Data Types p. 39

6.1.7 Error Handling p. 39

6.1.7.1 General p. 39

6.1.7.2 Protocol Errors p. 39

6.1.7.3 Application Errors p. 39

6.1.8 Feature negotiation p. 39

6.1.9 Security p. 39

6.2 Nmbsf_MBSUserDataIngestSession Service API p. 41

6.2.1 Introduction p. 41

6.2.2 Usage of HTTP p. 41

6.2.2.1 General p. 41

6.2.2.2 HTTP standard headers p. 41

6.2.2.2.1 General p. 41

6.2.2.2.2 Content type p. 41

6.2.2.3 HTTP custom headers p. 41

6.2.3 Resources p. 42

6.2.3.1 Overview p. 42

6.2.3.2 Resource: MBS User Data Ingest Sessions p. 43

6.2.3.2.1 Description p. 43

6.2.3.2.2 Resource Definition p. 43

6.2.3.2.3 Resource Standard Methods p. 44

6.2.3.2.3.1 GET p. 44

6.2.3.2.3.2 POST p. 45

6.2.3.2.4 Resource Custom Operations p. 46

6.2.3.3 Resource: Individual MBS User Data Ingest Session p. 46

6.2.3.3.1 Description p. 46

6.2.3.3.2 Resource Definition p. 46

6.2.3.3.3 Resource Standard Methods p. 46

6.2.3.3.3.1 GET p. 46

6.2.3.3.3.2 PUT p. 47

6.2.3.3.3.3 PATCH p. 49

6.2.3.3.3.4 DELETE p. 50

6.2.3.3.4 Resource Custom Operations p. 51

6.2.3.4 Resource: MBS User Data Ingest Session Status Subscriptions p. 51

6.2.3.4.1 Description p. 51

6.2.3.4.2 Resource Definition p. 51

6.2.3.4.3 Resource Standard Methods p. 51

6.2.3.4.3.1 GET p. 51

6.2.3.4.3.2 POST p. 52

6.2.3.4.4 Resource Custom Operations p. 53

6.2.3.5 Resource: Individual MBS User Data Ingest Session Status Subscription p. 53

6.2.3.5.1 Description p. 53

6.2.3.5.2 Resource Definition p. 53

6.2.3.5.3 Resource Standard Methods p. 54

6.2.3.5.3.1 GET p. 54

6.2.3.5.3.2 PUT p. 55

6.2.3.5.3.3 PATCH p. 56

6.2.3.5.3.4 DELETE p. 57

6.2.3.5.4 Resource Custom Operations p. 58

6.2.4 Custom Operations without associated resources p. 58

6.2.5 Notifications p. 59

6.2.5.1 General p. 59

6.2.5.2 MBS User Data Ingest Session Status Notification p. 59

6.2.5.2.1 Description p. 59

6.2.5.2.2 Target URI p. 59

6.2.5.2.3 Standard Methods p. 59

6.2.5.2.3.1 POST p. 59

6.2.6 Data Model p. 60

6.2.6.1 General p. 60

6.2.6.2 Structured data types p. 63

6.2.6.2.1 Introduction p. 63

6.2.6.2.2 Type: MBSUserDataIngSession p. 64

6.2.6.2.3 Type: MBSDistributionSessionInfo p. 67

6.2.6.2.4 Type: MBSUserDataIngSessionPatch p. 72

6.2.6.2.5 Type: ObjectDistrMethInfo p. 73

6.2.6.2.6 Type: PacketDistrMethInfo p. 74

6.2.6.2.7 Type MBSUserDataIngStatSubsc p. 74

6.2.6.2.8 Type SubscribedEvent p. 74

6.2.6.2.9 Type MBSUserDataIngStatNotif p. 75

6.2.6.2.10 Type EventNotification p. 75

6.2.6.2.11 Type MBSUserServAnmt p. 76

6.2.6.2.12 Type MBSDistSessionAnmt p. 77

6.2.6.2.13 Type ObjectDistMethAnmtInfo p. 78

6.2.6.2.14 Type: FECConfig p. 78

6.2.6.2.15 Type: AddFecParams p. 79

6.2.6.2.16 Type MBSUserDataIngStatSubscPatch p. 79

6.2.6.2.17 Type MbsDistSessFailure |R18| p. 79

6.2.6.2.18 Type MbsDistSessFailureSets |R18| p. 79

6.2.6.2.19 Type RepetitionRuleRm |R18| p. 80

6.2.6.3 Simple data types and enumerations p. 80

6.2.6.3.1 Introduction p. 80

6.2.6.3.2 Simple data types p. 80

6.2.6.3.3 Enumeration: DistributionMethod p. 80

6.2.6.3.4 Enumeration: Event p. 80

6.2.6.3.5 Enumeration: DistSessionFailure |R18| p. 81

6.2.6.4 Data types describing alternative data types or combinations of data types p. 82

6.2.6.4.1 Type: ProblemDetailsMBS |R18| p. 82

6.2.6.5 Binary data p. 82

6.2.6.5.1 Binary Data Types p. 82

6.2.7 Error Handling p. 82

6.2.7.1 General p. 82

6.2.7.2 Protocol Errors p. 83

6.2.7.3 Application Errors p. 83

6.2.8 Feature negotiation p. 83

6.2.9 Security p. 84

A (Normative) OpenAPI specification p. 85

A.1 General p. 85

A.2 Nmbsf_MBSUserService API p. 86

A.3 Nmbsf_MBSUserDataIngestSession API p. 92

B Withdrawn API versions p. 109

B.1 General p. 109

B.2 Nmbsf_MBSUserService API p. 109

B.3 Nmbsf_MBSUserDataIngestSession API p. 109

$ Change history p. 110