5.27 MBSUserDataIngestSession API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.27.1 Introduction

The Nnef_MBSUserDataIngestSession service shall use the MBSUserDataIngestSession API.

The API URI of MBSUserDataIngestSession API shall be:

{apiRoot}/3gpp-mbs-ud-ingest/v1

with the following components:

– "apiRoot" is set as defined in clause 5.2.4 of 3GPP TS 29.122 [4].

– "apiName" shall be set to "3gpp-mbs-ud-ingest".

– "apiVersion" shall be set to "v1" for the current version defined in the present document.

All resource URIs in the clauses below are defined relative to the above root URI.

5.27.2 Resources

5.27.2.1 Overview

This clause describes the structure for the Resource URIs as shown in figure 5.27.2.1-1 and the resources and HTTP methods used for the MBSUserDataIngestSession API.

Figure 5.27.2.1-1: Resource URI structure of the MBSUserDataIngestSession API

Table 5.27.2.1-1 provides an overview of the resources and applicable HTTP methods.

Table 5.27.2.1-1: Resources and methods overview

Resource name	Resource URI (relative path under API URI)	HTTP method or custom operation	Description (service operation)
MBS User Data Ingest Sessions	/sessions	GET	Retrieve all the active MBS User Data Ingest Sessions managed by the NEF.
MBS User Data Ingest Sessions	/sessions	POST	Request the creation of a new MBS User Data Ingest Session.
Individual MBS User Data Ingest Session	/sessions/{sessionId}	GET	Retrieve an existing Individual MBS User Data Ingest Session managed by the NEF.
		PUT	Update an existing Individual MBS User Data Ingest Session managed by the NEF.
		PATCH	Modify an existing Individual MBS User Data Ingest Session managed by the NEF.
		DELETE	Delete an existing Individual MBS User Data Ingest Session managed by the NEF.
MBS User Data Ingest Session Status Subscriptions	/status-subscriptions	GET	Retrieve all the active MBS User Data Ingest Session Status Subscriptions managed by the NEF.
MBS User Data Ingest Session Status Subscriptions	/status-subscriptions	POST	Request the creation of a new MBS User Data Ingest Session Status Subscription.
Individual MBS User Data Ingest Session Status Subscription	/status-subscriptions/{subscriptionId}	GET	Retrieve an existing Individual MBS User Data Ingest Session Status Subscription managed by the NEF.
		PUT	Update an existing MBS User Data Ingest Session Status Subscription managed by the NEF.
		PATCH	Modify an existing MBS User Data Ingest Session Status Subscription managed by the NEF.
		DELETE	Delete an existing Individual MBS User Data Ingest Session Status Subscription managed by the NEF.

5.27.2.2 Resource: MBS User Data Ingest Sessions

5.27.2.2.1 Introduction

This resource represents the collection of MBS User Data Ingest Sessions managed by the NEF.

This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [3]).

5.27.2.2.2 Resource Definition

Resource URI: {apiRoot}/3gpp-mbs-ud-ingest/v1/sessions

This resource shall support the resource URI variables defined in table 5.27.2.2.2-1.

Table 5.27.2.2.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.27.1.

5.27.2.2.3 Resource Standard Methods

5.27.2.2.3.1 GET

This method allows an AF to retrieve all the active MBS User Data Ingest Sessions managed by the NEF.

This method shall support the URI query parameters specified in table 5.27.2.2.3.1-1.

Table 5.27.2.2.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.2.3.1-2 and the response data structures and response codes specified in table 5.27.2.2.3.1-3.

Table 5.27.2.2.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.27.2.2.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
array(MBSUserDataIngSession)	M	0..N	200 OK	Successful case. All the active MBS User Data Ingest Sessions managed by the NEF are returned.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.2.3.1-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.2.3.1-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.2.3.2 POST

This method enables an AF to request the creation of an MBS User Data Ingest Session at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.2.3.2-1.

Table 5.27.2.2.3.2-1: URI query parameters supported by the POST method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.2.3.2-2 and the response data structures and response codes specified in table 5.27.2.2.3.2-3.

Table 5.27.2.2.3.2-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngSession	M	1	Contains the parameters to request the creation of a new MBS User Data Ingest Session at the NEF.

Table 5.27.2.2.3.2-3: Data structures supported by the POST Response Body on this resource

Data type

Cardinality

Response

Codes

Description

MBSUserDataIngSession

201 Created

Successful case. A new MBS User Data Ingest Session is successfully created and a representation of the created Individual MBS User Data Ingest Session resource is returned.

An HTTP "Location" header that contains the URI of the created Individual MBS User Data Ingest Session resource is also included.

NOTE: The mandatory HTTP error status code for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.2.3.2-4: Headers supported by the 201 response code on this resource

Name

Data type

Cardinality

Description

Location

string

Contains the URI of the newly created resource, according to the structure:

{apiRoot}/3gpp-mbs-ud-ingest/v1/sessions/{sessionId}

5.27.2.2.4 Resource Custom Operations

There are no resource custom operations defined for this resource in this release of the specification.

5.27.2.3 Resource: Individual MBS User Data Ingest Session

5.27.2.3.1 Introduction

This resource represents an Individual MBS User Data Ingest Session resource managed by the NEF.

This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [3]).

5.27.2.3.2 Resource Definition

Resource URI: {apiRoot}/3gpp-mbs-ud-ingest/v1/sessions/{sessionId}

This resource shall support the resource URI variables defined in table 5.27.2.3.2-1.

Table 5.27.2.3.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.27.1.
sessionId	string	Contains the unique identifier of the Individual MBS User Data Ingest Session resource assigned by the NEF.

5.27.2.3.3 Resource Standard Methods

5.27.2.3.3.1 GET

This method allows an AF to retrieve an existing "Individual MBS User Data Ingest Session" resource at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.3.3.1-1.

Table 5.27.2.3.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.3.3.1-2 and the response data structures and response codes specified in table 5.27.2.3.3.1-3.

Table 5.27.2.3.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.27.2.3.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MBSUserDataIngSession	M	1	200 OK	Successful case. The requested Individual MBS User Data Ingest Session resource is successfully returned.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.3.3.1-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.3.3.1-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.3.3.2 PUT

This method enables an AF to request the update of an existing "Individual MBS User Data Ingest Session" resource at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.3.3.2-1.

Table 5.27.2.3.3.2-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.3.3.2-2 and the response data structures and response codes specified in table 5.27.2.3.3.2-3.

Table 5.27.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngSession	M	1	Contains the updated representation of the Individual MBS User Data Ingest Session resource that is to be updated.

Table 5.27.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MBSUserDataIngSession	M	1	200 OK	Successful case. The concerned Individual MBS User Data Ingest Session resource is successfully updated and a representation of the updated resource is returned in the response body.
n/a			204 No Content	Successful case. The concerned Individual MBS User Data Ingest Session resource is successfully updated and no content is returned in the response body.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.3.3.2-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.3.3.2-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.3.3.3 PATCH

This method enables an AF to request the modification of an existing "Individual MBS User Data Ingest Session" resource at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.3.3.3-1.

Table 5.27.2.3.3.3-1: URI query parameters supported by the PATCH method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.3.3.3-2 and the response data structures and response codes specified in table 5.27.2.3.3.3-3.

Table 5.27.2.3.3.3-2: Data structures supported by the PATCH Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngSessionPatch	M	1	Contains the parameters to request the modification of the Individual MBS User Data Ingest Session resource.

Table 5.27.2.3.3.3-3: Data structures supported by the PATCH Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MBSUserDataIngSession	M	1	200 OK	Successful case. The concerned Individual MBS User Data Ingest Session resource is successfully modified and a representation of the updated resource is returned in the response body.
n/a			204 No Content	Successful response. The Individual MBS User Data Ingest Session resource is successfully modified and no content is returned in the response body.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.3.3.3-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.3.3.3-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.3.3.4 DELETE

This method enables an AF to request the deletion of an existing "Individual MBS User Data Ingest Session" resource at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.3.3.4-1.

Table 5.27.2.3.3.4-1: URI query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.3.3.4-2 and the response data structures and response codes specified in table 5.27.2.3.3.4-3.

Table 5.27.2.3.3.4-2: Data structures supported by the DELETE Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.27.2.3.3.4-3: Data structures supported by the DELETE Response Body on this resource

Data type	P	Cardinality	Response Codes	Description
n/a			204 No Content	Successful response. The Individual MBS User Data Ingest Session resource is successfully deleted.
			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.3.3.4-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.3.3.4-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.3.4 Resource Custom Operations

There are no resource custom operations defined for this resource in this release of the specification.

5.27.2.4 Resource: MBS User Data Ingest Session Status Subscriptions

5.27.2.4.1 Introduction

This resource represents the collection of MBS User Data Ingest Session Status Subscriptions managed by the NEF.

This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [3]).

5.27.2.4.2 Resource Definition

Resource URI: {apiRoot}/3gpp-mbs-ud-ingest/v1/status-subscriptions

This resource shall support the resource URI variables defined in table 5.27.2.4.2-1.

Table 5.27.2.4.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.27.1.

5.27.2.4.3 Resource Standard Methods

5.27.2.4.3.1 GET

This method allows an AF to retrieve all the active MBS User Data Ingest Session Status Subscriptions managed by the NEF.

This method shall support the URI query parameters specified in table 5.27.2.4.3.1-1.

Table 5.27.2.4.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.4.3.1-2 and the response data structures and response codes specified in table 5.27.2.4.3.1-3.

Table 5.27.2.4.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.27.2.4.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
array(MBSUserDataIngStatSubsc)	M	0..N	200 OK	Successful case. All the active MBS User Data Ingest Session Status Subscriptions managed by the NEF are returned.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.4.3.1-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.4.3.1-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.4.3.2 POST

This method enables an AF to request the creation of a new MBS User Data Ingest Sesstion Status Subscription at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.4.3.2-1.

Table 5.27.2.4.3.2-1: URI query parameters supported by the POST method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.4.3.2-2 and the response data structures and response codes specified in table 5.27.2.4.3.2-3.

Table 5.27.2.4.3.2-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngStatSubsc	M	1	Contains the parameters to request the creation of a new MBS User Data Ingest Session Status Subscription at the NEF.

Table 5.27.2.4.3.2-3: Data structures supported by the POST Response Body on this resource

Data type

Cardinality

Response

Codes

Description

MBSUserDataIngStatSubsc

201 Created

Successful case. A new MBS User Data Ingest Session Status Subscription is successfully created and a representation of the created Individual MBS User Data Ingest Session Status Subscription resource is returned.

An HTTP "Location" header that contains the URI of the created Individual MBS User Data Ingest Session Status Subscription resource is also included.

NOTE: The mandatory HTTP error status code for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.4.3.2-4: Headers supported by the 201 response code on this resource

Name

Data type

Cardinality

Description

Location

string

Contains the URI of the newly created resource, according to the structure:

{apiRoot}/3gpp-mbs-ud-ingest/v1/status-subscriptions/{subscriptionId}

5.27.2.4.4 Resource Custom Operations

There are no resource custom operations defined for this resource in this release of the specification.

5.27.2.5 Resource: Individual MBS User Data Ingest Session Status Subscription

5.27.2.5.1 Introduction

This resource represents an Individual MBS User Data Ingest Session Status Subscription managed by the NEF.

This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [3]).

5.27.2.5.2 Resource Definition

Resource URI: {apiRoot}/3gpp-mbs-ud-ingest/v1/status-subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 5.27.2.5.2-1.

Table 5.27.2.5.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.27.1.
sessionId	string	Contains the unique identifier of the Individual MBS User Data Ingest Session Status Subscription resource assigned by the NEF.

5.27.2.5.3 Resource Standard Methods

5.27.2.5.3.1 GET

This method allows an AF to retrieve an existing "Individual MBS User Data Ingest Session Status Subscription" resource at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.5.3.1-1.

Table 5.27.2.5.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.5.3.1-2 and the response data structures and response codes specified in table 5.27.2.5.3.1-3.

Table 5.27.2.5.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.27.2.5.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MBSUserDataIngStatSubsc	M	1	200 OK	Successful case. The requested Individual MBS User Data Ingest Session Status Subscription resource is successfully returned.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.5.3.1-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.5.3.1-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.5.3.2 PUT

The PATCH method allows an AF to update an existing "Individual MBS User Data Ingest Session Status Subscription" resource managed by the NEF.

This method shall support the URI query parameters specified in table 5.27.2.5.3.2-1.

Table 5.27.2.5.3.2-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.5.3.2-2 and the response data structures and response codes specified in table 5.27.2.5.3.2-3.

Table 5.27.2.5.3.2-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngStatSubsc	M	1	Contains the parameters to request the modification of an existing "Individual MBS User Data Ingest Session Status Subscription" resource.

Table 5.27.2.5.3.2-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MBSUserDataIngStatSubsc	M	1	200 OK	Successful case. The concerned "Individual MBS User Data Ingest Session Status Subscription" resource is successfully updated and a representation of the updated resource is returned in the response body.
n/a			204 No Content	Successful case. The concerned "Individual MBS User Data Ingest Session Status Subscription" resource is successfully updated, and no content is returned in the response body.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.5.3.2-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.5.3.2-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.5.3.3 PATCH

The PATCH method allows an AF to modify an existing "Individual MBS User Data Ingest Session Status Subscription" resource managed by the NEF.

This method shall support the URI query parameters specified in table 5.27.2.5.3.3-1.

Table 5.27.2.5.3.3-1: URI query parameters supported by the PATCH method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.5.3.3-2 and the response data structures and response codes specified in table 5.27.2.5.3.3-3.

Table 5.27.2.5.3.3-2: Data structures supported by the PATCH Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngStatSubscPatch	M	1	Contains the parameters to request the modification of an existing "Individual MBS User Data Ingest Session Status Subscription" resource.

Table 5.27.2.5.3.3-3: Data structures supported by the PATCH Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MBSUserDataIngStatSubsc	M	1	200 OK	Successful case. The concerned "Individual MBS User Data Ingest Session Status Subscription" resource is successfully modified, and a representation of the updated resource is returned in the response body.
n/a			204 No Content	Successful case. The concerned "Individual MBS User Data Ingest Session Status Subscription" resource is successfully modified and no content is returned in the response body.
n//a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.5.3.3-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.5.3.3-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.5.3.4 DELETE

This method enables an AF to request the deletion of an existing Individual MBS User Data Ingest Session Status Subscription resource at the NEF.

This method shall support the URI query parameters specified in table 5.27.2.5.3.4-1.

Table 5.27.2.5.3.4-1: URI query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 5.27.2.5.3.4-2 and the response data structures and response codes specified in table 5.27.2.5.3.4-3.

Table 5.27.2.5.3.4-2: Data structures supported by the DELETE Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.27.2.5.3.4-3: Data structures supported by the DELETE Response Body on this resource

Data type	P	Cardinality	Response Codes	Description
n/a			204 No Content	Successful response. The Individual MBS User Data Ingest Session Status Subscription resource is successfully deleted.
			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.2.5.3.4-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.27.2.5.3.4-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.27.2.5.4 Resource Custom Operations

There are no resource custom operations defined for this resource in this release of the specification.

5.27.3 Custom Operations without associated resources

There are no custom operations without associated resources defined for this API in this release of the specification.5.27.4 Notifications

5.27.4.1 General

Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [4].

Table 5.27.4.1-1: Notifications overview

Notification

Callback URI

HTTP method or custom operation

Description

(service operation)

MBS User Data Ingest Session Status Notification

{notifUri}

POST

This operation enables the NEF to notify a previously subscribed AF on status changes of an MBS User Data Ingest Session.

5.27.4.2 MBS User Data Ingest Session Status Change Notification

5.27.4.2.1 Description

The MBS user data ingest session status change notification is used by the NEF to report one or several observed MBS user data ingest session status change events to a previously subscribed AF.

5.27.4.2.2 Target URI

The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.27.4.2.2-1.

Table 5.27.4.2.2-1: Callback URI variables

Name	Definition
notifUri	Callback reference provided by the AF during the creation/update/modification of the corresponding MBS User Data Ingest Session Status Subscription.

5.27.4.2.3 Operation Definition

5.27.4.2.3.1 Notification via HTTP POST

This method shall support the request data structures specified in table 5.27.4.2.3.1-1 and the response data structures and response codes specified in table 5.27.4.2.3.1-2.

Table 5.27.4.2.3.1-1: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
MBSUserDataIngStatNotif	M	1	Provides information about the observed MBS user data ingest session status change event notification by the NEF to the AF.

Table 5.27.4.2.3.1-2: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	The MBS User Data Ingest Session Status Change Notification is successfully received.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.27.4.2.3.1-3: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Table 5.27.4.2.3.1-4: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

5.27.4.2.3.2 Notification via Websocket

If supported by both AF and NEF and successfully negotiated, the MBS User Data Ingest Session Status Change Notification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4 of 3GPP TS 29.122 [4].

5.27.5 Data Model

5.27.5.1 General

This clause specifies the application data model supported by the MBSUserDataIngestSession API. Table 5.27.5.1-1 specifies the data types defined for the MBSUserDataIngestSession API.

Table 5.27.5.1-1: MBSUserDataIngestSession specific Data Types

Data type	Clause defined	Description	Applicability

Table 5.27.5.1-2 specifies data types re-used by the MBSUserDataIngestSession API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the MBSUserDataIngestSession API.

Table 5.27.5.1-2: Re-used Data Types

Data type	Reference	Comments	Applicability
MBSUserDataIngSession	3GPP TS 29.580 [66]	Represents MBS User Data Ingest Session parameters.
MBSUserDataIngSessionPatch	3GPP TS 29.580 [66]	Represents the requested modifications to an MBS User Data Ingest Session resource representation.
MBSUserDataIngStatNotif	3GPP TS 29.580 [66]	Represents an MBS User Data Ingest Session Status Notification.
MBSUserDataIngStatSubsc	3GPP TS 29.580 [66]	Represents an MBS User Data Ingest Session Status Subscription.
MBSUserDataIngStatSubscPatch	3GPP TS 29.580 [66]	Represents the requested modifications to an MBS User Data Ingest Session Status Subscription.

5.27.5.2 Structured data types

5.27.5.2.1 Introduction

This clause defines the structures to be used in resource representations.

There are no structured data types defined for this API in this release of the specification.

5.27.5.3 Simple data types and enumerations

5.27.5.3.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

5.27.5.3.2 Simple data types

The simple data types defined in table 5.27.5.3.2-1 shall be supported.

Table 5.27.5.3.2-1: Simple data types

Type Name	Type Definition	Description	Applicability

5.27.6 Used Features

The table below defines the features applicable to the MBSUserDataIngestSession API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].

Table 5.27.6-1: Features used by MBSUserDataIngestSession API

Feature number	Feature Name	Description
1	Notification_websocket	The delivery of notifications over Websocket is supported as described in 3GPP TS 29.122 [4]. This feature requires that the Notification_test_event feature is also supported.
2	Notification_test_event	The testing of notification connection is supported as described in 3GPP TS 29.122 [4].

5.27.7 Error handling

5.27.7.1 General

HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].

In addition, the requirements in the following clauses shall apply.

5.27.7.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the MBSUserDataIngestSession API.

5.27.7.3 Application Errors

The application errors defined for the MBSUserDataIngestSession API are listed in table 5.27.7.3-1.

Table 5.27.7.3-1: Application errors

Application Error	HTTP status code	Description