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.583 Word version: 18.1.1

1… 5…

5.1 Introduction 5.2 PIN_ASRegistration Service 5.3 PIN_ASServiceSwitch Service 5.4 PIN_ASServiceContinuity Service 6.1 PIN_ASRegistration Service API 6.2 PIN_ASServiceSwitch API 6.3 PIN_ASServiceContinuity API

5 Services offered by PIN Server p. 10

5.1 Introduction p. 10

5.2 PIN_ASRegistration Service p. 10

5.2.1 Service Description p. 10

5.2.2 Service Operations p. 10

5.2.2.1 Introduction p. 10

5.2.2.2 PIN_ASRegistration_Request p. 11

5.2.2.2.1 General p. 11

5.2.2.2.2 PAS Registration Creation p. 11

5.2.2.3 PIN_ASRegistration_Update p. 11

5.2.2.3.1 General p. 11

5.2.2.3.2 Updating an existing Registration p. 11

5.2.2.4 PIN_ASRegistration_Deregister p. 12

5.2.2.4.1 General p. 12

5.2.2.4.2 Deregistering the Registration p. 12

5.3 PIN_ASServiceSwitch Service p. 12

5.3.1 Service Description p. 12

5.3.2 Service Operations p. 13

5.3.2.1 Introduction p. 13

5.3.2.2 PIN_ASServiceSwitch_Subscribe p. 13

5.3.2.2.1 General p. 13

5.3.2.2.2 Service Switch Information Subscription Creation p. 13

5.3.2.3 PIN_ASServiceSwitch_Notify p. 13

5.3.2.3.1 General p. 13

5.3.2.3.2 Service Switch Information Notification p. 14

5.3.2.4 PIN_ASServiceSwitch_Update p. 14

5.3.2.4.1 General p. 14

5.3.2.4.2 Service Switch Information Update p. 14

5.3.2.5 PIN_ASServiceSwitch_Unsubscribe p. 15

5.3.2.5.1 General p. 15

5.3.2.5.2 Unsubscribing the Service Switch Information p. 15

5.4 PIN_ASServiceContinuity Service p. 15

5.4.1 Service Description p. 15

5.4.2 Service Operations p. 15

5.4.2.1 Introduction p. 15

5.4.2.2 PIN_ASServiceContinuity_Subscribe p. 16

5.4.2.2.1 General p. 16

5.4.2.2.2 Service Continuity Information Subscription Creation p. 16

5.4.2.3 PIN_ASServiceContinuity_Notify p. 16

5.4.2.3.1 General p. 16

5.4.2.3.2 Service Continuity Information Notification p. 17

5.4.2.4 PIN_ASServiceContinuity_Update p. 17

5.4.2.4.1 General p. 17

5.4.2.4.2 Service Continuity Information Update p. 17

5.4.2.5 PIN_ASServiceContinuity_Unsubscribe p. 18

5.4.2.5.1 General p. 18

5.4.2.5.2 Unsubscribing the Service Continuity Information p. 18

6 API Definitions p. 18

6.1 PIN_ASRegistration Service API p. 18

6.1.1 Introduction p. 18

6.1.2 Usage of HTTP p. 19

6.1.3 Resources p. 19

6.1.3.1 Overview p. 19

6.1.3.2 Resource: PAS Registrations p. 20

6.1.3.2.1 Description p. 20

6.1.3.2.2 Resource Definition p. 20

6.1.3.2.3 Resource Standard Methods p. 20

6.1.3.2.3.1 POST p. 20

6.1.3.2.4 Resource Custom Operations p. 21

6.1.3.3 Resource: Individual PAS Registration p. 21

6.1.3.3.1 Description p. 21

6.1.3.3.2 Resource Definition p. 21

6.1.3.3.3 Resource Standard Methods p. 21

6.1.3.3.3.1 GET p. 21

6.1.3.3.3.2 PUT p. 22

6.1.3.3.3.3 DELETE p. 23

6.1.3.3.3.4 PATCH p. 24

6.1.3.3.4 Resource Custom Operations p. 25

6.1.4 Custom Operations without associated resources p. 25

6.1.5 Notifications p. 25

6.1.6 Data Model p. 25

6.1.6.1 General p. 25

6.1.6.2 Structured data types p. 26

6.1.6.2.1 Introduction p. 26

6.1.6.2.2 Type: PASRegistration p. 26

6.1.6.2.3 Type: ConnectivityInfo p. 27

6.1.6.2.4 Type: PASRegistrationPatch 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.7.1 General p. 27

6.1.7.2 Protocol Errors p. 27

6.1.7.3 Application Errors p. 28

6.1.8 Feature negotiation p. 28

6.1.9 Security p. 28

6.2 PIN_ASServiceSwitch API p. 28

6.2.1 Introduction p. 28

6.2.2 Usage of HTTP p. 28

6.2.3 Resources p. 29

6.2.3.1 Overview p. 29

6.2.3.2 Resource: Service Switch Information Subscriptions p. 29

6.2.3.2.1 Description p. 29

6.2.3.2.2 Resource Definition p. 29

6.2.3.2.3 Resource Standard Methods p. 30

6.2.3.2.3.1 POST p. 30

6.2.3.2.4 Resource Custom Operations p. 30

6.2.3.3 Resource: Individual Service Switch Information Subscription p. 31

6.2.3.3.1 Description p. 31

6.2.3.3.2 Resource Definition p. 31

6.2.3.3.3 Resource Standard Methods p. 31

6.2.3.3.3.1 GET p. 31

6.2.3.3.3.2 PATCH p. 32

6.2.3.3.3.3 PUT p. 33

6.2.3.3.3.4 DELETE p. 34

6.2.3.3.4 Resource Custom Operations p. 35

6.2.4 Custom Operations without associated resources p. 35

6.2.5 Notifications p. 35

6.2.5.0 General p. 35

6.2.5.1 Service Switch Information Notification p. 36

6.2.5.1.1 Description p. 36

6.2.5.1.2 Target URI p. 36

6.2.5.1.3 Standard Methods p. 36

6.2.5.1.3.1 POST 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: ServiceSwitchInfo p. 38

6.2.6.2.3 Type: ServiceSwitchInfoPatch p. 38

6.2.6.2.4 Type: ServiceSwitchInfoNotification p. 39

6.2.6.2.5 Type: ServiceSwitchReportInfo 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 Enumeration: EventType p. 39

6.2.7 Error Handling p. 39

6.2.7.1 General p. 39

6.2.7.2 Protocol Errors p. 39

6.2.7.3 Application Errors p. 40

6.2.8 Feature negotiation p. 40

6.2.9 Security p. 40

6.3 PIN_ASServiceContinuity API p. 40

6.3.1 Introduction p. 40

6.3.2 Usage of HTTP p. 40

6.3.3 Resources p. 41

6.3.3.1 Overview p. 41

6.3.3.2 Resource: Service Continuity Information Subscriptions p. 41

6.3.3.2.1 Description p. 41

6.3.3.2.2 Resource Definition p. 41

6.3.3.2.3 Resource Standard Methods p. 42

6.3.3.2.3.1 POST p. 42

6.3.3.2.4 Resource Custom Operations p. 42

6.3.3.3 Resource: Individual Service Continuity Information Subscription p. 43

6.3.3.3.1 Description p. 43

6.3.3.3.2 Resource Definition p. 43

6.3.3.3.3 Resource Standard Methods p. 43

6.3.3.3.3.1 GET p. 43

6.3.3.3.3.2 PATCH p. 44

6.3.3.3.3.3 PUT p. 45

6.3.3.3.3.4 DELETE p. 46

6.3.3.3.4 Resource Custom Operations p. 47

6.3.4 Custom Operations without associated resources p. 47

6.3.5 Notifications p. 47

6.3.5.0 General p. 47

6.3.5.1 Service Continuity Information Notification p. 48

6.3.5.1.1 Description p. 48

6.3.5.1.2 Target URI p. 48

6.3.5.1.3 Standard Methods p. 48

6.3.5.1.3.1 POST p. 48

6.3.6 Data Model p. 49

6.3.6.1 General p. 49

6.3.6.2 Structured data types p. 50

6.3.6.2.1 Introduction p. 50

6.3.6.2.2 Type: ServiceContinuityInfo p. 50

6.3.6.2.3 Type: ServiceContinuityInfoPatch p. 50

6.3.6.2.4 Type: ServiceContinuityInfoNotification p. 51

6.3.6.2.5 Type: ServiceContinuityReportInfo p. 51

6.3.6.3 Simple data types and enumerations p. 51

6.3.6.3.1 Introduction p. 51

6.3.6.3.2 Enumeration: EventType p. 51

6.3.7 Error Handling p. 51

6.3.7.1 General p. 51

6.3.7.2 Protocol Errors p. 52

6.3.7.3 Application Errors p. 52

6.3.8 Feature negotiation p. 52

6.3.9 Security p. 52

7 Using Common API Framework p. 53

7.1 General p. 53

7.2 Security p. 53

A (Normative) OpenAPI specification p. 54

A.1 General p. 54

A.2 PIN_ASRegistration API p. 54

A.3 PIN_ASServiceSwitch API p. 58

A.4 PIN_ASServiceContinuity API p. 63

$ Change history p. 69