Allocate

/allocate

POST

Request the allocation of TMGI(s) for new MBS session(s) or the refresh of the expiry time of already allocated TMGI(s).

Deallocate

/deallocate

POST

Request the deallocation of TMGI(s).

TmgiAllocRequest

M

1

Represents the parameters to request the allocation of TMGI(s) for new MBS session(s) or the refresh of the expiry time of already allocated MBS TMGI(s).

TmgiAllocResponse

M

1

200 OK

Successful case: The TMGI allocation information (e.g. allocated MBS TMGIs, expiry time) or the refreshed expiry time for the concerned already allocated MBS TMGI(s) is/are returned to the requesting AF.

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

TmgiDeallocRequest

M

1

Represents the MBS TMGI(s) deallocation request information (e.g. list of MBS TMGI(s) to be deallocated).

n/a

204 No Content

Successful case: The requested MBS TMGI(s) are deallocated.

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

Notification of Allocated MBS TMGI(s) Timer Expiry

{notificationUri}

POST

Enable the NEF to notify an AF of the timer expiry for already allocated MBS TMGI(s).

notificationUri

Callback URIprovided by the AF during the MBS TMGI(s) allocation or expiry time refresh request as defined in table 5.19.5.2.2-1.

ExpiryNotif

M

1

Represents the MBS TMGI(s) timer expiry notification information (e.g. list of MBS TMGI(s) for which the timer has expired).

n/a

204 No Content

The notification is received successfully.

n/a

307 Temporary Redirect

Temporary redirection, during event notification. 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, during event notification. 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.

TmgiAllocRequest

5.19.5.2.2

Represents the full set of parameters to initiate a TMGI(s) allocation request or the refresh of the expiry time of already allocated TMGI(s).

TmgiAllocResponse

5.19.5.2.3

Represents TMGI(s) allocation information or the refreshed expiry time for already allocated TMGI(s).

TmgiDeallocRequest

5.19.5.2.4

Represents information to request the deallocation of TMGI(s).

ExpiryNotif

5.19.5.2.5

Represents TMGI(s) timer expiry notification information.

Tmgi

3GPP TS 29.571 [8]

Contains a TMGI.

TmgiAllocate

3GPP TS 29.532 [52]

Contains parameters to initiate a TMGI(s) allocation request or the refresh of the expiry time of already allocated TMGI(s).

TmgiAllocated

3GPP TS 29.532 [52]

Contains the TMGI(s) allocation information or the refreshed expiry time for already allocated TMGI(s).

Uri

3GPP TS 29.122 [4]

Contains a TMGI.

WebsockNotifConfig

3GPP TS 29.122 [4]

Contains the configuration parameters to set up notification delivery over Websocket protocol.

afId

string

M

1

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

tmgiParams

TmgiAllocate

M

1

Contains the parameters to request the allocation of TMGI(s) for new MBS session(s) or the refresh of the expiry time of already allocated MBS TMGI(s).

notificationUri

Uri

O

0..1

The notification URI via which the AF desires to receive notifications on timer expiry for MBS TMGI(s).

requestTestNotification

boolean

O

0..1

Indicates whether sending a test notification shall be performed.

Set to "true" by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122 [4].

Set to "false" or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Represents configuration parameters to set up notification delivery over the Websocket protocol.

Notification_websocket

suppFeat

SupportedFeatures

C

0..1

Indicates the features supported by the AF.

This attribute shall be provided if feature negotiation needs to take place.

tmgiInfo

TmgiAllocated

M

1

Contains the MBS TMGI(s) allocation information or the refreshed expiry time for already allocated MBS TMGI(s).

suppFeat

SupportedFeatures

C

0..1

Indicates the features supported by both the AF and the NEF.

This attribute shall be provided if feature negotiation needs to take place and it was provided by the AF in the corresponding request body.

afId

string

M

1

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

tmgis

array(Tmgi)

M

1..N

Contains the list of TMGI(s) to be deallocated.

tmgis

array(Tmgi)

M

1..N

Contains the list of previously allocated MBS TMGI(s) for which the timer expired.

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