MBS User Services

/mbs-user-services

GET

Retrieve all the active MBS User Services managed by the MBSF.

POST

Request the creation of a new MBS User Service.

Individual MBS User Service

/mbs-user-services/{mbsUserServId}

GET

Retrieve an existing MBS User Service managed by the MBSF.

PUT

Request the update of an existing MBS User Service managed by the MBSF.

PATCH

Request the modification of an existing MBS User Service managed by the MBSF.

DELETE

Request the deletion of an existing MBS User Service managed by the MBSF.

apiRoot

string

See clause 6.1.1.

n/a

n/a

array(MBSUserService)

M

0..N

200 OK

Successful case. All the active MBS User Services managed by the MBSF are returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserService

M

1

Contains the parameters to request the creation of a new MBS User Service.

MBSUserService

M

1

201 Created

Successful case. The MBS User Service is successfully created and a representation of the created Individual MBS User Service resource is returned.

An HTTP "Location" header that contains the URI of the created Individual MBS User Service resource shall also be included.

NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

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

{apiRoot}/nmbsf-mbs-us/<apiVersion>/mbs-user-services/{mbsUserServId}

apiRoot

string

See clause 6.1.1.

mbsUserServId

string

Represents the unique identifier of the Individual MBS User Service resource, assigned by the MBSF.

n/a

n/a

MBSUserService

M

1

200 OK

Successful case. The requested Individual MBS User Service resource is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserService

M

1

Contains the updated representation of the existing Individual MBS User Service resource that is to be updated.

MBSUserService

M

1

200 OK

Successful case. The concerned Individual MBS User Service resource is successfully updated and a representation of the updated resource is returned to the NF service consumer in the response body.

n/a

204 No Content

Successful case. The concerned Individual MBS User Service resource is successfully updated and no content is returned in the response body.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserServicePatch

M

1

Contains the parameters to request the modification of an existing Individual MBS User Service resource.

MBSUserService

M

1

200 OK

Successful case. The concerned Individual MBS User Service resource is successfully modified and a representation of the updated resource is returned to the NF service consumer in the response body.

n/a

204 No Content

Successful case. The concerned Individual MBS User Service resource is successfully modified and no content is returned in the response body.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

Successful case. The concerned Individual MBS User Service resource is successfully deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

MBSUserService

6.1.6.2.2

Represents the parameters of an MBS User Service.

MBSUserServicePatch

6.1.6.2.4

Represents the requested modifications to the parameters of an MBS User Service.

ServiceAnnouncementMode

6.1.6.3.3

Represents a service announcement mode.

ServiceNameDescription

6.1.6.2.3

Represents a set of per language service Name and/or service description.

ServiceType

6.1.6.3.4

Represents MBS User Service distribution type.

MbsServiceType

3GPP TS 29.571 [17]

Indicates whether this MBS User Service is distributed via Multicast MBS Session(s) or Broadcast MBS Session(s).

NetworkAreaInfo

3GPP TS 29.554 [16]

Contains the service areas in which this MBS User Service is to be made available.

SupportedFeatures

3GPP TS 29.571 [17]

Used to negotiate the applicability of optional features.

Uri

3GPP TS 29.571 [17]

Represents a URI.

extServiceIds

array(Uri)

M

1..N

Represents the external service identifier(s) of this MBS User Service.

servType

MbsServiceType

M

1

Indicates the requested service type (i.e. multicast or broadcast).

servClass

Uri

M

1

Represents the class of the MBS User Service, expressed as a term identifier from the OMA BCAST Service Class Registry [19], e.g.:

urn:oma:bcast:oma_bsc:st:1.0.

servAnnModes

array(ServiceAnnouncementMode)

M

1..N

Represents the MBS User Service Announcement Mode(s), i.e. how the MBS User Service Announcement compiled by the MBSF is advertised to the MBSF Client.

servNameDescs

array(ServiceNameDescription)

M

1..N

Contains one or several set(s) of per language distinguishing service name and/or service description for this MBS User Service.

mainServLang

string

O

0..1

Represents the main service language of this MBS User Service.

suppFeat

SupportedFeatures

C

0..1

Used to negotiate the supported optional features of the API described in clause 6.1.8.

This attribute shall be provided in the HTTP POST request and response if feature negotiation needs to take place.

servName

string

C

0..1

Represents a distinguishing name for this MBS User Service per language.

(NOTE)

servDescrip

string

C

0..1

Contains a description of this MBS User Service per language.

(NOTE)

language

string

M

1

Represents the language of the distinguishing name and description for this MBS User Service.

NOTE: At least one of the "servName" attribute and the "servDescrip" attribute shall be included.

extServiceIds

array(Uri)

O

1..N

Represents the updated set of external service identifier(s) of the MBS User Service.

servClass

Uri

O

0..1

Represents the class of the MBS User Service, expressed as a term identifier from the OMNA BCAST Service Class Registry [19].

servAnnModes

array(ServiceAnnouncementMode)

O

1..N

Represents the updated MBS User Service Announcement Mode(s).

servNameDescs

array(ServiceNameDescription)

O

1..N

Contains the updated set(s) of per language distinguishing service name and/or service description for the MBS User Service.

mainServLang

string

O

0..1

Represents the main service language of the MBS User Service.

VIA_MBS_5

Indicates that the MBS User Service Announcement compiled by the MBSF is advertised to the MBSF Client at reference point MBS-5.

VIA_MBS_DISTRIBUTION_SESSION

Indicates that the MBS User Service Announcement compiled by the MBSF is advertised to the MBSF Client via the MBS Distribution Session.

PASSED_BACK

Indicates that the MBS User Service Announcement compiled by the MBSF is passed back to the MBS Application Provider.

MBS User Data Ingest Sessions

/sessions

GET

Retrieve all the active MBS User Data Ingest Sessions managed by the MBSF.

POST

Request the creation of a new MBS User Data Ingest Session.

Individual MBS User Data Ingest Session

/sessions/{sessionId}

GET

Retrieve an existing MBS User Data Ingest Session managed by the MBSF.

PUT

Update an existing MBS User Data Ingest Session managed by the MBSF.

PATCH

Modify an existing MBS User Data Ingest Session managed by the MBSF.

DELETE

Delete an existing MBS User Data Ingest Session managed by the MBSF.

MBS User Data Ingest Session Status Subscriptions

/status-subscriptions

GET

Retrieve all the active MBS User Data Ingest Session Status Subscriptions managed by the MBSF.

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 MBS User Data Ingest Session Status Subscription managed by the MBSF.

PUT

Update an existing MBS User Data Ingest Session Status Subscription managed by the MBSF.

PATCH

Modify an existing MBS User Data Ingest Session Status Subscription managed by the MBSF.

DELETE

Delete an existing MBS User Data Ingest Session Status Subscription managed by the MBSF.

apiRoot

string

See clause 6.2.1.

n/a

n/a

array(MBSUserDataIngSession)

M

0..N

200 OK

Successful case. All the active MBS User Data Ingest Sessions managed by the MBSF are returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The manadatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserDataIngSession

M

1

Contains the parameters to request the creation of a new MBS User Data Ingest Session.

MBSUserDataIngSession

M

1

201 Created

Successful case. The 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 resource URI of the created "Individual MBS User Data Ingest Session" resource is also included.

NOTE: The manadatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

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

{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/sessions/{sessionId}

apiRoot

string

See clause 6.2.1.

sessionId

string

Represents the unique identifier of the "Individual MBS User Data Ingest Session" resource, assigned by the MBSF.

n/a

n/a

MBSUserDataIngSession

M

1

200 OK

Successful case. The requested "Individual MBS User Data Ingest Session" resource is successfully returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The manadatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserDataIngSession

M

1

Contains the updated representation of the existing "Individual MBS User Data Ingest Session" resource that is to be updated.

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 to the NF service consumer 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.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserDataIngSessionPatch

M

1

Contains the parameters to request the modification of an existing "Individual MBS User Data Ingest Session" resource.

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 to the NF service consumer in the response body.

n/a

204 No Content

Successful case. The concerned "Individual MBS User Data Ingest Session" resource is successfully modified and no content is returned in the response body.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

Successful case. The concerned "Individual MBS User Data Ingest Session" resource is successfully deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

apiRoot

string

See clause 6.2.1.

n/a

n/a

array(MBSUserDataIngStatSubsc)

M

0..N

200 OK

Successful case. All the active MBS User Data Ingest Session Status Subscriptions managed by the MBSF are returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The manadatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserDataIngStatSubsc

M

1

Contains the parameters to request the creation of a new MBS User Data Ingest Session Status Subscription.

MBSUserDataIngStatSubsc

M

1

201 Created

Successful case. The 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 resource URI of the created "Individual MBS User Data Ingest Session Status Subscription" resource shall also be included.

NOTE: The manadatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

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

{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/status-subscriptions/{subscriptionId}

apiRoot

string

See clause 6.2.1.

subscriptionId

string

Represents the unique identifier of the "Individual MBS User Data Ingest Session Status Subscription" resource, assigned by the MBSF.

n/a

n/a

MBSUserDataIngStatSubsc

M

1

200 OK

Successful case. The requested "Individual MBS User Data Ingest Session Status Subscription" resource is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The manadatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserDataIngStatSubsc

M

1

Contains the updated representation of the existing "Individual MBS User Data Ingest Session Status Subscription" resource that is to be updated.

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 to the NF service consumer 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.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

MBSUserDataIngStatSubscPatch

M

1

Contains the parameters to request the modification of an existing "Individual MBS User Data Ingest Session Status Subscription" resource.

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 to the NF service consumer 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.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

Successful case. The concerned "Individual MBS User Data Ingest Session Status Subscription" resource is successfully deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative MBSF (service) instance.

NOTE: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative MBSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

MBS User Data Ingest Session Status Notification

{notifUri}

POST

This operation enables the MBSF to notify the NF service consumer (e.g. AF, NEF) on status changes of an MBS User Data Ingest Session.

notifUri

String formatted as URI with the Callback URI towards which the MBS User Data Ingest Session Status Notifications should be sent.

MBSUserDataIngStatNotif

M

1

Represents an MBS User Data Ingest Session Status Notification.

n/a

204 No Content

The MBS User Data Ingest Session Status Notification is successfully received.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF service consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF service consumer (service) instance where the notification should be sent.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

AddFecParams

6.2.6.2.15

Represents additional scheme-specific parameters for AL-FEC configuration.

DistributionMethod

6.2.6.3.3

Represents the MBS Distribution method.

Event

6.2.6.3.4

Represents MBS User Data Ingest Session Status events.

EventNotification

6.2.6.2.10

Represents an MBS User Data Ingest Session Status event notification related information.

FECConfig

6.2.6.2.14

Represents FEC configuration information.

MBSDistSessionAnmt

6.2.6.2.12

Represents the set of MBS Distribution Session Announcements currently associated with this MBS User Service Announcement.

MBSDistributionSessionInfo

6.2.6.2.3

Represents MBS Distribution Session information.

MBSUserDataIngSession

6.2.6.2.2

Represents MBS User Data Ingest Session information.

MBSUserDataIngSessionPatch

6.2.6.2.4

Represents the requested modification to an MBS User Data Ingest Session.

MBSUserDataIngStatNotif

6.2.6.2.9

Represents an MBS User Data Ingest Session Status Notification.

MBSUserDataIngStatSubsc

6.2.6.2.7

Represents an MBS User Data Ingest Session Status Subscription.

MBSUserDataIngStatSubscPatch

6.2.6.2.16

Represents the requested modifications to an MBS User Data Ingest Session Status Subscription.

MBSUserServAnmt

6.2.6.2.11

Represents the MBS User Service Announcement currently associated with the MBS User Data Ingest Session.

ObjectDistMethAnmtInfo

6.2.6.2.13

Represents MBS Distribution Session Announcement parameters for Object Distribution Method.

ObjectDistrMethInfo

6.2.6.2.5

Represents additional MBS Distribution Session parameters for Object Distribution Method.

PacketDistrMethInfo

6.2.6.2.6

Represents additional MBS Distribution Session parameters for Packet Distribution Method.

SubscribedEvent

6.2.6.2.8

Represents a subscribed MBS User Data Ingest Session Status event and the related information.

BitRate

3GPP TS 29.571 [17]

Represents Bit Rate.

MbsServiceInfo

3GPP TS 29.571 [17]

Represents MBS Service Information.

ExternalMbsServiceArea

3GPP TS 29.571 [17]

Represents an external MBS Service Area.

DateTime

3GPP TS 29.122 [18]

Represents an absolute date time with the format "date-time", as defined in OpenAPI Specification [6].

DistSessionState

3GPP TS 29.581 [19]

Represents state of an MBS Distribution Session.

MbsFsaId

3GPP TS 29.571 [17]

Represents an MBS Frequency Selection Area ID, for a broadcast MBS session.

MbsServiceArea

3GPP TS 29.571 [17]

Represents an MBS service area.

MbsServiceInfo

3GPP TS 29.571 [17]

Represents the MBS Service Information.

MbsSessionId

3GPP TS 29.571 [17]

Represents an MBS Session Identifier.

MbStfIngestAddr

3GPP TS 29.581 [19]

Represents MBSTF ingest endpoint addresses.

ObjAcquisitionMethod

3GPP TS 29.581 [19]

Represents the Object Acquisition Method.

ObjDistributionOperatingMode

3GPP TS 29.581 [19]

Represents the operation mode for an Object distribution method.

PacketDelBudget

3GPP TS 29.571 [17]

Represents Unsigned integer indicating Packet Delay Budget expressed in milliseconds.

ServiceNameDescription

Clause 6.1.6.2.3

Represents a set of per language service Name and/or service description.

PktDistributionOperatingMode

3GPP TS 29.581 [19]

Represents the operation mode for a Packet distribution method.

PktIngestMethod

3GPP TS 29.581 [19]

Represents packets ingest method.

TimeWindow

3GPP TS 29.122 [18]

Represents a Time Window.

Tmgi

3GPP TS 29.571 [17]

Represents Temporary Mobile Group Identity.

Uri

3GPP TS 29.571 [17]

Represents Uniform Resource Identifier.

SupportedFeatures

3GPP TS 29.571 [17]

Used to negotiate the applicability of optional features.

mbsDisSessInfos

map(MBSDistributionSessionInfo)

M

1..N

Represents one or more MBS Distribution Session(s) composing the MBS User Data Ingest Session.

The key of the map shall be set to the value of the "mbsDistSessionId" attribute of the MBSDistributionSessionInfo data structure encoding the corresponding map entry.

actPeriods

array(TimeWindow)

O

1..N

Represents periods of time during which the MBS User Data Ingest Session is active in the MBS System.

If omitted, the session shall stay active until it is explicitly terminated by the AF.

mbsUserServAnmt

MBSUserServAnmt

O

0..1

Represents the MBS User Service Announcement currently associated with the MBS User Data Ingest Session.

This attribute may only be present in an HTTP POST/PATCH response to an MBS User Data Ingest Session creation/modification request and only if all the constituent MBS Distribution Sessions are in the "ESTABLISHED" or "ACTIVE" state and the "PASSED_BACK" service announcement mode is provisioned within the service announcement modes supported for the parent Individual MBS User Service identified by the "mbsUserServId" attribute.

mbsUserServId

string

M

1

Represents the Identifier of the parent MBS User Service.

suppFeat

SupportedFeatures

C

0..1

Used to negotiate the supported optional features of the API as described in clause 6.2.8.

This attribute shall be present only in an HTTP POST/PUT request or response and if feature negotiation needs to take place.

mbsDistSessionId

string

C

0..1

Represents the identifier of the MBS Distribution Session.

This attribute shall only be present in the response to an MBS User Data Ingest Session creation request or a subsequent MBS User Data Ingest Session update/modification request.

mbsSessionId

MbsSessionId

O

0..1

Represents the identifier of the MBS Session to which the MBS Distribution Session is related.

It can be set to the Temporary Mobile Group Identity (TMGI) or Source-Specific Multicast (SSM) IP address of the MBS Session corresponding to this MBS Distribution Session.

When this attribute is absent or present and contains a source specific multicast address and the "locationDependent" attribute is present and set to "true", then:

– TMGI allocation shall be performed by the MBSF; and

– This attribute shall be present in the HTTP POST response to the corresponding MBS User Data Ingest session creation request and contain the allocated TMGI value.

mbsServInfo

MbsServiceInfo

O

0..1

Contains the MBS Service Information for the MBS session.

maxContBitRate

BitRate

M

1

Represents the maximum bit rate for content in this MBS Distribution Session.

maxContDelay

PacketDelBudget

O

0..1

Represents the maximum end-to-end distribution delay that is tolerated for content in this MBS Distribution Session.

distrMethod

DistributionMethod

M

1

Represents the distribution method for this MBS Distribution Session.

fecConfig

FECConfig

O

0..1

Represents the AL-FEC (Application Level – Forward Error Correction) configuration information to be used by the MBSTF to protect this MBS Distribution Session.

objDistrInfo

ObjectDistrMethInfo

C

0..1

Represents the MBS Distribution Session parameters for Object Distribution Method.

This attribute shall only be present when the "distrMethod" attribute value is set as "OBJECT".

pckDistrInfo

PacketDistrMethInfo

C

0..1

Represents the MBS Distribution Session parameters for Packet Distribution Method.

This attribute shall only be present when the "distrMethod" attribute is set to "PACKET".

trafficMarkingInfo

string

O

0..1

Contains traffic marking information (e.g. a Differentiated Services Code Point) to be applied by the MBSTF to outgoing traffic.

This attribute shall be encoded as two octet string in hexadecimal representation. The first octet shall contain the DSCP value in the IPv4 Type-of-Service or the IPv6 Traffic-Class field, and the second octet shall contain the ToS/Traffic Class mask field, which shall be set to "0xFC".

mbsDistSessState

DistSessionState

C

0..1

Represents the state of the MBS Distribution Session.

This attribute shall only be present in the HTTP POST/PUT/PATCH response to the corresponding MBS User Data Ingest session creation or update/modification request.

tgtServAreas

MbsServiceArea

O

0..1

Represents the set of target service area(s) constituting the MBS Service Area of the MBS Distribution Session.

This attribute may be present only in the case of a trusted/internal AF (i.e. MBS Application Provider).

extTgtServAreas

ExternalMbsServiceArea

O

0..1

Represents the set of target service area(s) constituting the external MBS Service Area (i.e. list of geographical area(s) or civic address(es)) of the MBS Distribution Session.

This attribute may be present only in the case of an untrusted/external AF (MBS Application Provider).

mbsFSAId

MbsFsaId

O

0..1

Represents MBS Frequency Selection Assistance information corresponding to this MBS Distribution Session.

This attribute may be included only if the parent MBS User Service is of Broadcast service type.

locationDependent

boolean

O

0..1

Represents an indication that this MBS Distribution Session belongs to a location-dependent MBS.

This attribute shall be:

– set to "true" to indicate that the MBS Distribution Session belongs to a location-dependent MBS; or

– set to "false" to indicate that the MBS Distribution Session does not belong to a location-dependent MBS.

The default value is "false", if omitted.

multiplexedServFlag

boolean

O

0..1

Represents an indication that this MBS Distribution Session belongs to a multiplex, i.e. forms part of a set of MBS Distribution Sessions under the same parent MBS User Data Ingest Session with identical or empty sets of target service areas and multiplexed onto the same MBS Session at the MB-SMF.

This attribute shall be:

– set to "true" to indicate that the MBS Distribution Session belongs to a multiplex; or

– set to "false" to indicate that the MBS Distribution Session does not belong to a multiplex.

The default value is "false", if omitted.

restrictedFlag

boolean

O

0..1

Represents an indication that this MBS Distribution Session is not open to any UE, i.e. restricted to a set of UEs according to their MBS related subscription information.

This attribute may be included only if the parent MBS User Service is of Multicast service type.

This attribute shall be:

– set to "true" to indicate that this MBS Distribution Session is restricted to a set of UE(s); or

– set to "false" to indicate that this MBS Distribution Session is open to any UE.

The default value is "false", if omitted.

actPeriods

array(TimeWindow)

O

1..N

Represents periods of time during which the MBS User Data Ingest Session is active in the MBS System.

mbsDisSessInfos

map(MBSDistributionSessionInfo)

O

1..N

Contains the requested modifications to one or more MBS Distribution Session(s) composing the MBS User Data Ingest Session.

operatingMode

ObjDistributionOperatingMode

M

1

Represents the operating mode for the Object distribution method.

objAcqMethod

ObjAcquisitionMethod

M

1

Represents the object(s) acquisition method.

objAcqIds

array(Uri)

M

1..N

Represents the object(s) to be ingested and distributed by the MBSTF during this MBS Distribution Session.

objIngUri

Uri

O

0..1

Represents a prefix substituted by the MBSTF with the Object distribution base URL prior to the distribution of the ingested objects.

When the "objAcqMethod" is set to "PULL", this attribute is provided by the AF and present in the creation and/or update/modification of the corresponding MBS User Data Ingest Session.

When the "objAcqMethod" is set to "PUSH", this attribute is provided by the MBSF and present in the response to the creation and/or update/modification request of the corresponding MBS User Data Ingest Session.

objDistrUri

Uri

O

0..1

Represents a prefix substituted by the MBSTF in place of the Object ingest base URL prior to the distribution of the ingested objects.

objRepairUri

Uri

O

0..1

Represents the object repair base URI. It contains a URI prefix substituted by the MBSTF Client in place of the Object distribution base URI when repairing objects not received completely intact from this MBS Distribution Session. The value shall point to the MBS AS.

This attribute may only be present in responses to MBS User Data Ingest Session creation/update/modification requests.

operatingMode

PktDistributionOperatingMode

M

1

Contains the desired operating mode for the Packet distribution method.

pckIngMethod

PktIngestMethod

M

1

Represents the packets ingest method, i.e. unicast ingest or multicast ingest.

ingEndpointAddrs

MbStfIngestAddr

M

1

The endpoint addresses used by the AF (e.g. MBS Application Provider) and the MBSTF to establish a connection at reference point Nmb8 prior to the commencement of the MBS User Data Ingest Session.

In the case of Proxy mode, this shall be the Source-Specific Multicast (SSM) endpoint addresses (including the source IP address, destination multicast group address and destination UDP port) and provided either by the AF (e.g. MBS Application Provider) or by the MBSF.

In the case of Forward-only mode, this shall be the IP addresses and UDP port numbers at the source and destination ends of the content ingest tunnel, and provided respectively by the AF (e.g. MBS Application Provider) and the MBSTF.

mbsIngSessionId

string

M

1

Represents the identifier of the MBS User Data Ingest Session to which the subscription is related.

eventSubscs

array(SubscribedEvent)

M

1..N

Represents the list of subscribed MBS User Data Ingest Session Status event(s).

notifUri

Uri

M

1

Represents the notification URI to be used for MBS User Data Ingest Session Status event(s) reporting.

statusEvent

Event

M

1

Represents the subscribed MBS User Data Ingest Session Status event.

mbsDistSessionId

string

C

0..1

Represents the identifier for the MBS Distribution Session to which the subscribed MBS User Data Ingest Session Status event is related.

This attribute shall be provided if the subscribed event is related to a particular MBS Distribution Session within the concerned Individual MBS User Data Ingest Session.

mbsIngSessionId

string

M

1

Represents the identifier for the MBS User Data Ingest Session to which the notification is related .

eventNotifs

array(EventNotification)

M

1..N

Represents the set of reported MBS User Data Ingest Session Status event(s) and the related information.

statusEvent

Event

M

1.

Represents the reported MBS User Data Ingest Session Status event.

mbsDisSessionId

string

C

0..1

Represents the identifier for the MBS Distribution Session to which the reported event is related.

This attribute shall be provided if the reported event relates to a particular MBS Distribution Session within the concerned Individual MBS User Data Ingest Session.

statusAddInfo

string

O

0..1

Represents additional information on the reported MBS User Data Ingest Session Status event within the "statusEvent" attribute.

timeStamp

DateTime

M

1

Represents the time at which the MBS User Data Ingest Session Status event is observed.

extServiceId

array(string)

M

1..N

Represents the external service identifier(s) of this MBS User Service.

servClass

string

M

1

Represents the class of the MBS User Service, expressed as a term identifier from the OMA BCAST Service Class Registry [19].

startTime

DateTime

O

0..1

Represents the start time from which this MBS User Service Announcement is valid.

If not present, the announcement is already valid.

endTime

DateTime

O

0..1

Represents the end time after which this MBS User Service Announcement is no longer valid.

If not present, the announcement is valid indefinitely.

servNameDescs

array(ServiceNameDescription)

M

1..N

Contains one or several set(s) of per language distinguishing service name and/or service description for this MBS User Service.

mainServLang

string

O

0..1

Represents the main service language of this MBS User Service.

mbsDistSessAnmt

map(MBSDistSessionAnmt)

C

1..N

Represents the set of MBS Distribution Session Announcements currently associated with this MBS User Service Announcement.

The key of the map shall be set to any string value.

mbsSessionId

MbsSessionId

O

0..1

Represents the MBS Distribution Session Identifier with the Temporary Mobile Group Identity (TMGI) or Source-Specific Multicast (SSM) IP address of the MBS Session supporting this MBS Distribution Session.

mbsFSAId

MbsFsaId

O

0..1

Represents MBS Frequency Selection Assistance information corresponding to the MBS Distribution Session.

This attribute may be included only if the parent MBS User Service is of Broadcast service type.

distrMethod

DistributionMethod

M

1

Represents the distribution method of this MBS Distribution Session.

objDistrAnnInfo

ObjectDistMethAnmtInfo

O

0..1

Represents MBS Distribution Session Announcement parameters for Object Distribution Method.

May only be present when the "distrMethod" attribute value is set as "OBJECT".

sesDesInfo

array(string)

M

1..N

Represnts the additional parameters needed to receive the MBS Distribution Session from which this announcement is derived, including relevant User Plane traffic flow parameters.

objDistrSched

TimeWindow

O

0..1

Represents a schedule indicating when individual objects are to be delivered on the corresponding MBS Distribution Session.

This attribute may be present only when this information has been provided in the Object acquisition identifiers of the corresponding MBS Distribution Session.

objDistrBaseUri

Uri

O

0..1

Represents a URI prefix substituted by the MBSTF Client with the Object repair base URI when repairing objects not received completely intact from the corresponding MBS Distribution Session.

This attribute may be present only when object repair is provisioned for the corresponding MBS Distribution Session.

objRepBaseUri

Uri

O

0..1

Represents the base URI of the MBS AS to be used for object repair of the corresponding MBS Distribution Session.

This attribute may be present only when object repair is provisioned for the corresponding MBS Distribution Session.

fecScheme

Uri

M

1

Contains the AL-FEC scheme to be used by the MBSTF.

It shall be identified using a term from the IANA: "Reliable Multicast Transport (RMT) FEC Encoding IDs and FEC Instance IDs" [20] expressed as a URN, e.g.:

urn:ietf:rmt:fec:encoding:0

fecOverhead

integer

M

1

The overhead of AL-FEC protection, corresponding to a proportion of the (unprotected) MBS data, expressed in the form of a percentage.

additionalParams

array(AddFecParams)

O

1..N

Represents additional scheme-specific parameters for AL-FEC configuration, encoded using uncontrolled {name, value} pairs.

paramName

string

M

1

Contains the name of the FEC configuration parameter.

paramValue

string

M

1

Contains the value of the FEC configuration parameter.

eventSubscs

array(SubscribedEvent)

O

1..N

Represents the updated list of subscribed MBS User Data Ingest Session Status event(s).

notifUri

Uri

O

0..1

Represents the updated notification URI to be used for MBS User Data Ingest Session Status event(s) reporting.

OBJECT

Indicates the Object Distribution Method.

PACKET

Indicates the Packet Distribution Method.

USER_DATA_ING_SESS_STARTING

Indicates that the MBS User Data Ingest Session is starting.

This is an "MBS User Data Ingest Session" level event.

USER_DATA_ING_SESS_STARTED

Indicates that the MBS User Data Ingest Session started.

This is an "MBS User Data Ingest Session" level event.

USER_DATA_ING_SESS_TERMINATED

Indicates that the MBS User Data Ingest Session is terminated.

This is an "MBS User Data Ingest Session" level event.

DIST_SESS_STARTING

Indicates that the MBS Distribution Session is starting.

This is an "MBS Distribution Session" level event.

DIST_SESS_STARTED

Indicates that the MBS Distribution Session started.

This is an "MBS Distribution Session" level event.

DIST_SESS_TERMINATED

Indicates that the MBS Distribution Session is terminated.

This is an "MBS Distribution Session" level event.

DIST_SESS_SERV_MNGT_FAILURE

Indicates that the MBS Distribution Session could not be started (e.g. the necessary resources could not be allocated by the MBS system).

This is an "MBS Distribution Session" level event.

DIST_SESS_POL_CRTL_FAILURE

Indicates that the MBS Distribution Session could not be started because of a policy authorization/control failure or rejection.

This is an "MBS Distribution Session" level event.

DATA_INGEST_FAILURE

The MBS User Data Ingest failed because the MBSTF is expecting data (the MBS Session is active), but not receiving it.

This is an "MBS Distribution Session" level event.

DELIVERY_STARTED

The MBS User Data delivery is started.

SESSION_TERMINATED

The MBS User Data Ingest Session is terminated.