MBS Sessions

/mbs-sessions

POST

Create an MBS Session.

Individual MBS Session

/mbs-sessions/{mbsSessionRef}

PATCH

Modify an existing Individual MBS Session resource.

DELETE

Delete an existing Individual MBS Session resource.

MBS Session Subscriptions

/mbs-sessions/subscriptions

GET

Retrieve all the MBS Session Subscriptions

POST

Create an MBS Session Subscription.

Individual MBS Session Subscription

/mbs-sessions/subscriptions/{subscriptionId}

GET

Retrieve an existing Individual MBS Session Subscription resource.

DELETE

Delete an existing Individual MBS Session Subscription resource.

MBS Parameters Provisionings

/mbs-pp

GET

Retrieve all the MBS Parameters Provisioning resources.

POST

Request the creation of a new MBS Parameters Provisioning.

Individual MBS Parameters Provisioning

/mbs-pp/{mbsPpId}

GET

Retrieve an existing individual MBS Parameters Provisioning resource.

PUT

Request the update of an existing Individual MBS Parameters Provisioning resource.

PATCH

Request the modification of an existing Individual MBS Parameters Provisioning resource.

DELETE

Request the deletion of an existing Individual MBS Parameters Provisioning resource.

apiRoot

string

See clause 5.20.1.

N/A

MbsSessionCreateReq

M

1

Representation of the MBS session to be created at the NEF.

MbsSessionCreateRsp

M

1

201 Created

Successful case. A representation of the created Individual MBS Session resource is returned.

The URI of the created resource shall be returned in an HTTP "Location" header.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

ProblemDetails

O

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: 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.

NOTE 2: Failure cases are described in clause 5.20.7.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-mbs-session/v1/mbs-sessions/{mbsSessionRef}

apiRoot

string

See clause 5.20.1.

mbsSessionRef

string

Contains the identifier of the Individual MBS Session resource assigned by the NEF.

n/a

array(PatchItem)

M

1

Represents the list of modifications to be applied to the concerned existing Individual MBS Session resource, as specified in clause 4.6.1.1.3 of 3GPP TS 29.501 [32].

n/a

204 No Content

Successful response. The Individual MBS Session resource was successfully modified.

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].

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: 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.

NOTE 2: Failure cases are described in clause 5.20.7.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

n/a

n/a

n/a

204 No Content

Successful response. The Individual MBS Session resource was 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].

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

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.

NOTE 2: Failure cases are described in clause 5.20.7.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

String

M

1

An alternative URI of the resource located in an alternative NEF.

apiRoot

string

See clause 5.20.1.

n/a

n/a

array(MbsSessionSubsc)

M

0..N

200 OK

Successful case. All the MBS Session Subscription resources managed by the NEF are 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.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

n/a

MbsSessionSubsc

M

1

Representation of the MBS session to be created at the NEF.

MbsSessionSubsc

M

1

201 Created

Successful case. A representation of the created Individual MBS Session Subscription resource is returned.

The URI of the created resource is returned in an HTTP "Location" header.

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.

Location

string

M

1

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

{apiRoot}/3gpp-mbs-session/v1/mbs-sessions/subscriptions/{subscriptionId}

apiRoot

string

See clause 5.20.1.

subscriptionId

string

Identifier of the Individual MBS Session Subscription resource.

n/a

n/a

MbsSessionSubsc

M

1

200 OK

Successful case. The requested Individual MBS Session Subscription resource is 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.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

n/a

n/a

n/a

204 No Content

Successful case. The concerned Individual MBS Session Subscription resource is successfully deleted.

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 DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

apiRoot

string

See clause 5.20.1.

n/a

n/a

array(MbsPpData)

M

1..N

200 OK

Successful case. All the Individual MBS Parameters Provisionings resources managed by the NEF are 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.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

n/a

MbsPpData

M

1

Representation of the MBS session to be created in the NEF.

MbsPpData

M

1

201 Created

Successful case. A representation of the created Individual MBS Parameters Provisioning resource is returned.

The URI of the created resource shall be returned in an HTTP "Location" header.

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.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-mbs-session/v1/mbs-pp/{mbsPpId}

apiRoot

string

See clause 5.20.1.

mbsPpId

string

Identifier of the Individual MBS Parameters Provisioning resource.

n/a

n/a

MbsPpData

M

1

200 OK

Successful case. The requested Individual MBS Parameters Provisioning 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.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

n/a

MbsPpData

M

1

Represents the updated Individual MBS Parameters Provisioning resource representation.

MbsPpData

200 OK

Successful response. The Individual MBS Parameters Provisioning resource is successfully updated and a representation of the updated resource is returned in the response body.

n/a

204 No Content

Successful response. The Individual MBS Parameters Provisioning resource is successfully updated and no content is to be 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 1: 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.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

n/a

MbsPpDataPatch

M

1

Represents the requested modifications to the Individual MBS Parameters Provisioning resource.

MbsPpData

200 OK

Successful response. The Individual MBS Parameters Provisioning 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 Parameters Provisioning resource is successfully modified and no content is to be 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 1: 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.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

n/a

n/a

n/a

204 No Content

Successful case. The concerned Individual MBS Parameters Provisioning resource is successfully deleted.

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 DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative target URI of the resource located in an alternative NEF.

MBS Session Status Notification

{notificationUri}

POST

Enables to notify a previously subscribed AF on MBS session status information.

notificationUri

Uri

Callback URIprovided by the AF during the creation/modification of the subscription.

MbsSessionStatusNotif

M

1

Represents the MBS Session Status information to be reported to the AF.

n/a

204 No Content

The MBS Session Status 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.

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

MbsPpData

5.20.5.2.6

Represents MBS Parameters Provisioning data.

MbsPpDataPatch

5.20.5.2.8

Represents the requested modification to existing MBS Parameters Provisioning data.

MbsSessAuthData

5.20.5.2.7

Represents the MBS Session Authorization data.

MbsSessionCreateReq

5.20.5.2.2

Represents the parameters to request MBS Session creation.

MbsSessionCreateResp

5.20.5.2.3

Represents the parameters to be returned in an MBS Session creation response.

MbsSessionSubsc

5.20.5.2.4

Represents an MBS Session Subscription.

MbsSessionStatusNotif

5.20.5.2.5

Represents an MBS Session Status notification.

5MbsAuthorizationInfo

3GPP TS 29.503 [17]

Contains the MBS Session authorization information.

DateTime

3GPP TS 29.122 [4]

Represents a date and a time

ExternalGroupId

3GPP TS 29.122 [4]

Represents the External Group Identifier for a user group.

Gpsi

3GPP TS 29.571 [8]

Represents a GPSI.

MbsSession

3GPP TS 29.571 [8]

Represents MBS session information.

MbsSessionId

3GPP TS 29.571 [8]

Represents the identifier of an MBS Session.

PatchItem

3GPP TS 29.571 [8]

Represents the requested modifications to a resource via the PATCH method.

MbsSessionEventReportList

3GPP TS 29.571 [8]

Represents the list of MBS Session Event Report(a).

MbsSessionSubscription

3GPP TS 29.571 [8]

Represents an MBS Session Subscription

SupportedFeatures

3GPP TS 29.571 [8]

Represents the list of supported feature(s) and used to negotiate the applicability of the optional features.

Tmgi

3GPP TS 29.571 [8]

Represents a TMGI.

TunnelAddress

3GPP TS 29.571 [8]

Represents a Tunnel Address (UDP/IP).

Uri

3GPP TS 29.122 [4]

Represents a URI.

afId

string

M

1

Contains the identifier of the AF that is sending the request.

mbsSession

MbsSession

M

1

MBS session to be created.

suppFeat

SupportedFeatures

C

0..1

Contains the list of supported features.

This attribute shall be provided in the HTTP POST request to create a new MBS session, if feature negotiation needs to take place.

mbsSession

MbsSession

M

1

Represents the created MBS session.

eventList

MbsSessionEventReportList

C

0..1

Contains a list of MBS Session Status Event(s) report(s), if available.

suppFeat

SupportedFeatures

C

0..1

Contains the list of supported features.

This attribute shall be provided in the HTTP POST response to a request to create a new MBS session, if it was present in the corresponding HTTP POST request.

afId

string

M

1

Contains the identifier of the AF that is sending the request.

subscription

MbsSessionSubscription

M

1

Represents the parameters of the MBS Session Status subscription to be created

subscriptionId

string

C

0..1

Contains the identifier of the created Individual MBS Session Subscription resource.

This attribute shall only be present in the HTTP POST response to an MBS session creation request.

eventList

MbsSessionEventReportList

M

1

Contains the reported MBS session event(s) and the related information.

afId

string

M

1

Contains the identifier of the AF that is sending the request.

mbsSessAuthData

MbsSessAuthData

C

0..1

Contains the MBS Session Authorization data that the AF requests to provision.

This attribute shall be present when the AF request to provision MBS Session Authorization data.

suppFeat

SupportedFeatures

C

0..1

Contains the list of supported features among the ones defined in clause 5.20.6.

This attribute shall be provided when feature negocation needs to take place.

extGroupId

ExternalGroupId

M

1

Represents the external group identifier of the targeted multicast MBS Group.

gpsisList

map(Gpsi)

C

1..N

Represents the list of the GPSI(s) of the member UE(s) constituting the multicast MBS group.

Any value of type string can be used as a key of the map.

This attribute shall be present only if the multicast MBS group has not yet been created or the list of its member(s) needs to be updated.

mbsSessionIdList

5MbsAuthorizationInfo

M

1

Contains the identifier(s) of the multicast MBS Session(s) that the multicast MBS group is authorized to join.

mbsSessAuthData

MbsSessAuthData

O

0..1

Contains the modified MBS Session Authorization data that the AF requests to provision.

suppFeat

SupportedFeatures

O

0..1

Contains the modified list of supported features among the ones defined in clause 5.20.6.

TRANS_RESOURCE_RES_FAILURE

500 Internal Server Error

Indicates that the MBS Session creation failed due to transmission resources reservation failure.

INVALID_MBS_SERVICE_INFO

400 Bad Request

The provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization.

FILTER_RESTRICTIONS_NOT_OBSERVED

400 Bad Request

The MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [64] not being observed.

MBS_SERVICE_INFO_NOT_AUTHORIZED

403 Forbidden

The provided MBS Service Information is rejected.

MBS_SESSION_ALREADY_CREATED

403 Forbidden

The requested MBS session has already been created at the NEF/MB-SMF.

OVERLAPPING_MBS_SERVICE_AREA

403 Forbidden

The provided MBS service area overlaps with the MBS service area of an existing MBS Session that shares the same MBS session Identifier.

UNKNOWN_TMGI

404 Not Found

The TMGI provided in the request does not exist.

MBS_SESSION_CONTEXT_NOT_FOUND

404 Not Found

The targeted Individual MBS Session does not exist.

UNKNOWN_MBS_SERVICE_AREA

404 Not Found

The requested MBS service area (e.g. identified by the Area Session ID) cannot be found.