5 Services offered by the MBSF
29.5803GPP5G SystemMulticast/Broadcast Service Function servicesRelease 17Stage 3TS
5.1 Introduction
The MBSF provides the following services:
– Nmbsf_MBSUserService
– Nmbsf_MBSUserDataIngestSession
Table 5.1-1 summarizes the corresponding APIs defined for this specification.
Table 5.1-1: API Descriptions
Service Name |
Clause |
Description |
OpenAPI Specification File |
apiName |
Annex |
Nmbsf_MBSUserService |
5.2 |
MBS User Management Service |
TS29580_Nmbsf_MBSUserService.yaml |
nmbsf-mbs-us |
A.2 |
Nmbsf_MBSUserDataIngestSession |
5.3 |
MBS User Data Ingest Session Management Service |
TS29580_Nmbsf_MBSUserDataIngestSession.yaml |
nmbsf-mbs-ud-ingest |
A.3 |
5.2 Nmbsf_MBSUserService Service
5.2.1 Service Description
The Nmbsf_MBSUserService service exposed by the MBSF enables an NF service consumer to:
– create a new MBS User Service;
– retrieve the properties of an existing MBS User Service;
– update/modify the properties of an existing MBS User Service; and
– delete an existing MBS User Service.
5.2.2 Service Operations
5.2.2.1 Introduction
The service operations defined for the Nmbsf_MBSUserService service are shown in table 5.2.2.1-1.
Table 5.2.2.1-1: Nmbsf_MBSUserService Service Operations
Service Operation Name |
Description |
Initiated by |
Nmbsf_MBSUserService_Create |
This service operation enables the NF service consumer to create a new MBS User Service. |
AF, NEF |
Nmbsf_MBSUserService_Retrieve |
This service operation enables the NF service consumer to retrieve the properties of an existing MBS User Service. |
AF, NEF |
Nmbsf_MBSUserService_Update |
This service operation enables the NF service consumer to update an existing MBS User Service. |
AF, NEF |
Nmbsf_MBSUserService_Delete (NOTE) |
This service operation enables the NF service consumer to delete an existing MBS User Service. |
AF, NEF |
NOTE: This service operation corresponds to the Nmbsf_MBSUserService_Destroy service operation defined in 3GPP TS 26.502 [15]. |
5.2.2.2 Nmbsf_MBSUserService_Create service operation
5.2.2.2.1 General
This service operation is used by an NF service consumer to request the creation of a new MBS User Service at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserServie_Create" service operation:
– MBS User Service Creation.
5.2.2.2.2 MBS User Service Creation
Figure 5.2.2.2.2-1 depicts a scenario where an NF service consumer requests the creation of a new MBS User Service at the MBSF.
Figure 5.2.2.2.2-1: MBS User Service Creation procedure
1. In order to request the creation of a new MBS User Service, the NF service consumer shall send an HTTP POST request message to the MBSF targeting the "MBS User Services" collection resource, using the URI "{apiRoot}/nmbsf-mbs-us/<apiVersion>/mbs-user-services" as shown in step 1 of figure 5.2.2.2.2-1, with the request body including the MBSUserService data structure which shall contain:
– a list of external service identifier(s), within the "extServiceIds" attribute;
– the service type, within the the "servType" attribute;
– the service class, within the "servClass" attribute;
– a list of service announcement mode(s), within the "servAnnModes" attribute;
– one or several set(s) of per language service name(s) and/or service description(s), with the "servNameDescs" attribute; and
– the list of supported features, if feature negotiation needs to take place, within the "suppFeat" attribute;
and may include:
– the main service language, within the "mainServLang" attribute.
2. Upon success, the MBSF shall create a new "Individual MBS User Service" resource and respond to the NF service consumer with a "201 Created" status code, as shown in step 2 of figure 5.2.2.2.2-1, including an HTTP Location header field containing the URI of the created resource, and the response body containing a representation of the created "Individual MBS User Service" resource within the MBSUserService data structure.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.1.7, and respond to the NF service consumer with an appropriate error status code.
5.2.2.3 Nmbsf_MBSUserService_Retrieve service operation
5.2.2.3.1 General
This service operation is used by an NF service consumer to retrieve the properties of an existing MBS User Service at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserServie_Retrieve" service operation:
– MBS User Service Retrieval.
5.2.2.3.2 MBS User Service Retrieval
Figure 5.2.2.3.2-1 depicts a scenario where an NF service consumer requests the retrieval of the properties of an existing MBS User Service from the MBSF.
Figure 5.2.2.3.2-1: MBS User Service Retrieval procedure
1. In order to retrieve the properties of an existing MBS User Service, the NF service consumer shall send an HTTP GET request message targeting the corresponding "Individual MBS User Service" resource, using the URI "{apiRoot}/nmbsf-mbs-us/<apiVersion>/mbs-user-services/{mbsUserServId}", as shown in step 1 of figure 5.2.2.3.2-1.
If the MBSF determines that the received HTTP GET request needs to be redirected, the MBSF shall send an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall respond to the NF service consumer with an HTTP "200 OK" status code, as shown in step 2 of figure 5.2.2.3.2-1, with the response body including a representation of the requested "Individual MBS User Service" resource within the MBSUserService data structure.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.1.7, and respond to the NF service consumer with an appropriate error status code.
5.2.2.4 Nmbsf_MBSUserService_Update service operation
5.2.2.4.1 General
This service operation is used by an NF service consumer to request the update or modification of an existing MBS User Service at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserServie_Update" service operation:
– MBS User Service Update.
5.2.2.4.2 MBS User Service Update
Figure 5.2.2.4.2-1 depicts a scenario where an NF service consumer requests the update of an existing MBS User Service at the MBSF.
Figure 5.2.2.4.2-1: MBS User Service Update procedure
1. In order to request the update or modification of an existing MBS User Service, the NF service consumer shall send an HTTP PUT or PATCH request message targeting the corresponding "Individual MBS User Service" resource, using the URI "{apiRoot}/nmbsf-mbs-us/<apiVersion>/mbs-user-services/{mbsUserServId}" as shown in step 1 of figure 5.2.2.4.2-1, with the request body including the MBSUserService data structure (when HTTP PUT is used) or the MBSUserServicePatch data structure (when HTTP PATCH is used). Only the "servType" attribute shall not be updated.
If the MBSF determines that the received HTTP PUT or PATCH request message needs to be redirected, the MBSF shall send an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall update the concerned "Individual MBS User Service" resource and respond to the NF service consumer with either:
a) an HTTP "200 OK" status code with the response body containing the updated representation of the resource within the MBSUserService data structure, as shown in step 2a of figure 5.2.2.4.2-1; or
b) an HTTP "204 No Content" status code, as shown in step 2b of figure 5.2.2.4.2-1.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.1.7, and respond to the NF service consumer with an appropriate error status code.
5.2.2.5 Nmbsf_MBSUserService_Delete service operation
5.2.2.5.1 General
This service operation is used by the NF service consumer to request the deletion of an existing MBS User Service at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserServie_Delete" service operation:
– MBS User Service Deletion.
5.2.2.5.2 MBS User Service Deletion
Figure 5.2.2.5.2-1 depicts a scenario where an NF service consumer requests the deletion of an existing MBS User Service at the MBSF.
Figure 5.2.2.5.2-1: MBS User Service Deletion procedure
1. In order to request the deletion of an existing MBS User Service, the NF service consumer shall send an HTTP DELETE request message targeting the corresponding "Individual MBS User Service" resource using the URI "{apiRoot}/nmbsf-mbs-us/<apiVersion>/mbs-user-services/{mbsUserServId}", as shown in step 1 of figure 5.2.2.5.2-1.
If the MBSF determines that the received HTTP DELETE request needs to be redirected, the MBSF shall send an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall:
– delete the targeted "Individual MBS User Service" resource; and
– respond to the NF service consumer with an HTTP "204 No Content" status code, as shown in step 2 of figure 5.2.2.5.2-1.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.1.7, and respond to the NF service consumer with an appropriate error status code.
5.3 Nmbsf_MBSUserDataIngestSession Service
5.3.1 Service Description
The Nmbsf_MBSUserDataIngestSession service exposed by the MBSF enables an NF service consumer to:
– create an MBS User Data Ingest Session, including a set of subordinate MBS Distribution Session(s);
– retrieve the properties of an existing MBS User Data Ingest Session;
– update an existing MBS User Data Ingest Session and its set of subordinate MBS Distribution Session(s);
– delete an MBS User Data Ingest Session along with its subordinate MBS Distribution Session(s);
– create a subscription to monitor event(s) related to the MBS User Data Ingest Session;
– update or modify an existing subscription to MBS User Data Ingest Session event(s) monitoring;
– delete an existing subscription to MBS User Data Ingest Session event(s) monitoring; and
– receive notification(s) about the event(s) related to the MBS User Data Ingest Session.
5.3.2 Service Operations
5.3.2.1 Introduction
The service operations defined for the Nmbsf_MBSUserDataIngestSession service are shown in table 5.3.2.1-1.
Table 5.3.2.1-1: Nmbsf_MBSUserDataIngestSession Service Operations
Service Operation Name |
Description |
Initiated by |
Nmbsf_MBSUserDataIngestSession_Create |
This service operation enables the NF service consumer to request the creation of an MBS User Data Ingest Session, including a set of subordinate MBS Distribution Session(s). |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_Retrieve |
This service operation enables the NF service consumer to retrieve the properties of an existing MBS User Data Ingest Session. |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_Update |
This service operation enables the NF service consumer to update an existing MBS User Data Ingest Session and its set of subordinate MBS Distribution Session(s). |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_Delete (NOTE) |
This service operation enables the NF service consumer to delete an existing MBS User Data Ingest Session along with its subordinate MBS Distribution Session(s). |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_StatusSubscribe |
This service operation enables the NF service consumer to request the creation of a subscription to monitor event(s) related to an MBS User Data Ingest Session. |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_StatusSubscribeMod |
This service operation enables the NF service consumer to request the update or modification of an existing subscription to monitor event(s) related to an MBS User Data Ingest Session. |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_StatusUnsubscribe |
This service operation enables the NF service consumer to request the deletion of an existing subscription to MBS User Data Ingest Session event(s) monitoring. |
AF, NEF |
Nmbsf_MBSUserDataIngestSession_StatusNotify |
This service operation enables the NF service consumer to receive notification(s) from the MBSF about the event(s) related to an MBS User Data Ingest Session. |
MBSF |
NOTE: This service operation corresponds to the Nmbsf_MBSUserDataIngestSession_Destroy service operation defined in 3GPP TS 26.502 [15]. |
5.3.2.2 Nmbsf_MBSUserDataIngestSession_Create service operation
5.3.2.2.1 General
This service operation is used by the NF service consumer to request the creation of an MBS User Data Ingest Session including a set of subordinate MBS Distribution Session(s).
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_Create" service operation:
– MBS User Data Ingest Session Creation.
5.3.2.2.2 MBS User Data Ingest Session Creation
Figure 5.3.2.2.2-1 depicts a scenario where an NF service consumer requests the creation of an MBS User Data Ingest Session, including a set of subordinate MBS Distribution Session(s), at the MBSF.
Figure 5.3.2.2.2-1: MBS User Data Ingest Session Creation procedure
1. In order to create a new MBS User Data Ingest Session, including a set of subordinate MBS Distribution Session(s), the NF service consumer shall send an HTTP POST request message targeting the "Individual MBS User Data Ingest Sessions" collection resource, using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/sessions" as shown in step 1 of figure 5.3.2.2.2-1, with the request body including the MBSUserDataIngSession data structure which shall contain:
– the identifier of the parent MBS User Service, within the "mbsUserServId" attribute;
– one or several MBS Distribution Session(s), within the "mbsDisSessInfos" attribute; and
– the list of supported features, if feature negotiation needs to take place, within the "suppFeat" attribute;
and may include:
– one or several set(s) of period(s) of time during which the MBS User Data Ingest Session is active in the MBS System, within the "actPeriods" attribute.
NOTE: At the end of the last time period provided within the "actPeriods" attribute, the MBS User Data Ingest Session is automatically released and deleted by the MBSF.
Within the "mbsDisSessInfos" attribute, the parameters of each MBS Distribution Session to be created are provided within the MBSDistributionSessionInfo data structure encoding the corresponding map entry, and:
– if no MBS session identifier is provided, i.e. the "mbsSessionId" is not provided, the MBSF shall request TMGI allocation as part of the creation of the corresponding MBS session at the MB-SMF; and
– if a source specific multicast address (SSM) is provided within the "mbsSessionId" attribute and the "locationDependent" attribute is present and set to "true" (i.e. to indicate a location dependent MBS service), the MBSF shall also request TMGI allocation as part of the creation of the corresponding MBS session at the MB-SMF.
2. Upon success, the MBSF shall create a new "Individual MBS User Data Ingest Session" resource and respond to the NF service consumer with an HTTP "201 Created" status code, as shown in step 2 of figure 5.3.2.2.2-1, including an HTTP Location header field containing the URI of the created resource, and the response body containing a representation of the created "Individual MBS User Data Ingest Session" resource within the MBSUserDataIngSession data structure.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.3 Nmbsf_MBSUserDataIngestSession_Retrieve service operation
5.3.2.3.1 General
This service operation is used by the NF service consumer to retrieve the properties of an existing MBS User Data Ingest Session.
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_Retrieve" service operation:
– MBS User Data Ingest Session Retrieval.
5.3.2.3.2 MBS User Data Ingest Session Retrieval
Figure 5.3.2.3.2-1 depicts a scenario where an NF service consumer retrieves the properties of an existing MBS User Data Ingest Session from the MBSF.
Figure 5.3.2.3.2-1: MBS User Data Ingest Session Retrieval procedure
1. In order to retrieve the properties of an existing MBS User Data Ingest Session, the NF service consumer shall send an HTTP GET request message targeting the corresponding "Individual MBS User Data Ingest Session" resource using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/sessions/{sessionId}" as shown in step 1 of figure 5.3.2.3.2-1.
If the MBSF determines that the received HTTP GET request message needs to be redirected, the MBSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon the reception of the HTTP GET request message, the MBSF shall respond with an HTTP "200 OK" status code, as shown in figure 5.3.2.3.2-1, step 2, with the response body including a representation of the requested "Individual MBS User Data Ingest Session" resource within the MBSUserDataIngSession data structure.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.4 Nmbsf_MBSUserDataIngestSession_Update service operation
5.3.2.4.1 General
This service operation is used by the NF service consumer to request the update of an existing MBS User Data Ingest Session and potentially also its set of subordinate MBS Distribution Session(s) at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_Update" service operation:
– MBS User Data Ingest Session Update.
5.3.2.4.2 MBS User Data Ingest Session Update
Figure 5.3.2.4.2-1 depicts a scenario where an NF service consumer requests the update or modification of an existing MBS User Data Ingest Session and potentially also its set of subordinate MBS Distribtion Session(s) at the MBSF.
Figure 5.3.2.4.2-1: MBS User Data Ingest Session Update procedure
1. In order to request the update or modification of an existing MBS User Data Ingest Session and potentially also its set of subordinate MBS Distribution Session(s), the NF service consumer shall send an HTTP PUT or PATCH request message targeting the corresponding "Individual MBS User Data Ingest Session" resource using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/sessions/{sessionId}", as shown in step 1 of figure 5.3.2.4.2-1, with the request body including the MBSUserDataIngSession data structure (for an HTTP PUT request) or the MBSUserDataIngSessionPatch data structure (for an HTTP PATCH request).
The attributes that may be updated/modified at any time are as follows:
– the active periods of the MBS User Data Ingest Session, within the "actPeriods" attribute; and
– within each map entry of the "mbsDisSessInfos" attribute encoded using the MBSDistributionSessionInfo data structure:
– the MBS Service Information, within the "mbsServInfo" attribute;
– the MBS Frequency Selection Area (FSA) Identifier, for a broadcast service type, within the "mbsFSAId" attribute;
– the target service area(s), within the "tgtServAreas" attribute.
The other attributes, except the "mbsSessionId", the "mbsDisSessionId" and the "locationDependent" attributes, which shall not be updated, all the other attributes within each map entry of the "mbsDisSessInfos" attribute encoded using the MBSDistributionSessionInfo data structure may be updated only if the MBS Distribution Session is in "INACTIVE" state.
As part of an MBS User Data Ingest Session update procedure, the AF may also add new MBS Distribution Session(s) and/or remove existing MBS Distribution Session(s). In order to do so:
– if a new MBS Distribution Session shall be created, the AF shall include its properties encoded using the MBSDistributionSessionInfo data structure as a map entry within the "mbsDisSessInfos" attribute with a newly assigned string based map key that shall be unique within the scope of the parent MBS User Data Ingest Session; and
– if an existing MBS Distribution Session shall be deleted, the AF shall include the corresponding map entry set to the value "NULL" within the "mbsDisSessInfos" attribute with the map key set to its string based map key provisioned during the request that initially created the MBS Distribution Session.
If the MBSF determines that the received HTTP PUT or PATCH request needs to be redirected, the MBSF shall send an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall respond with either:
a) an HTTP "200 OK" status code with the response body containing the updated representation of the "Individual MBS User Data Ingest Session" resource within the MBSUserDataIngSession data structure, as shown in step 2a of figure 5.3.2.4.2-1; or
b) an HTTP "204 No Content" status code, as shown in step 2b of figure 5.3.2.4.2-1.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.5 Nmbsf_MBSUserDataIngestSession_Delete service operation
5.3.2.5.1 General
This service operation is used by the NF service consumer to request the deletion of an MBS User Data Ingest Session along with its subordinate MBS Distribution Session(s) at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_Delete" service operation:
– MBS User Data Ingest Session Deletion.
5.3.2.5.2 MBS User Data Ingest Session Deletion
Figure 5.3.2.5.2-1 depicts a scenario where an NF service consumer requests the deletion of an existing MBS User Data Ingest Session at the MBSF.
Figure 5.3.2.5.2-1: MBS User Data Ingest Session Deletion procedure
1. In order to request the deletion of an existing MBS User Data Ingest Session along with its subordinate MBS Distribution Session(s), the NF service consumer shall send an HTTP DELETE request message targeting the corresponding "Individual MBS User Data Ingest Session" resource using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/sessions/{sessionId}", as shown in step 1 of figure 5.3.2.5.2-1.
If the MBSF determines that the received HTTP DELETE request message needs to be redirected, the MBSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall:
– delete the targeted "Individual MBS User Data Ingest Session" resource; and
– respond with an HTTP "204 No Content" status code, as shown in step 2 of figure 5.3.2.5.2-1.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.6 Nmbsf_MBSUserDataIngestSession_StatusSubscribe service operation
5.3.2.6.1 General
This service operation is invoked by an NF service consumer to request the creation of a subscription to MBS User Data Ingest Session Status event(s) reporting at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_StatusSubscribe" service operation:
– MBS User Data Ingest Session Status Subscription Creation.
5.3.2.6.2 MBS User Data Ingest Session Status Subscription Creation
Figure 5.3.2.6.2-1 depicts a scenario where an NF service consumer requests the creation of a subscription to MBS User Data Ingest Session Status event(s) reporting at the MBSF.
Figure 5.3.2.6.2-1: MBS User Data Ingest Session Status Subscription Creation procedure
1. In order to request the creation of a new MBS User Data Ingest Session Status Subscription, the NF service consumer shall send an HTTP POST request message targeting the "MBS User Data Ingest Session Status Subscriptions" resource using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/status-subscriptions" as shown in step 1 of figure 5.3.2.6.2-1, with the request body including the MBSUserDataIngStatSubsc data structure that shall contain:
– the identifier of the MBS User Data Ingest Session to which the subscription is related, within the "mbsIngSessionId" attribute;
– the URI towards which the notifications should be sent, within the "notifUri" attribute; and
– the list of subscribed MBS User Data Ingest Session Status event(s), within the "eventSubscs" attribute.
2. Upon success, the MBSF shall create a new "Individual MBS User Data Ingest Session Status Subscription" resource and respond to the NF service consumer with an HTTP "201 Created" status code, as shown in step 2 of figure 5.3.2.6.2-1, including an HTTP Location header field containing the URI of the created resource, i.e. "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/status-subscriptions/{subscriptionId}", and the response body containing a representation of the created "Individual MBS User Data Ingest Session Status Subscription" resource within the MBSUserDataIngStatSubsc data structure.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.7 Nmbsf_MBSUserDataIngestSession_StatusSubscribeMod service operation
5.3.2.7.1 General
This service operation is invoked by an NF service consumer to request the update/modification of a subscription to MBS User Data Ingest Session Status event(s) reporting at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_StatusSubscribeMod" service operation:
– MBS User Data Ingest Session Status Subscription Update.
5.3.2.7.2 MBS User Data Ingest Session Status Subscription Update
Figure 5.3.2.6.2-1 depicts a scenario where an NF service consumer requests the update/modification of a subscription to MBS User Data Ingest Session Status event(s) reporting at the MBSF.
Figure 5.3.2.7.2-1: MBS User Data Ingest Session Status Subscription Update procedure
1. In order to request the update or modification of an existing MBS User Data Ingest Session Status Subscription, the NF service consumer shall send an HTTP PUT or PATCH request message targeting the corresponding "Individual MBS User Data Ingest Session Status Subscription" resource using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/status-subscriptions/{subscriptionId}", as shown in step 1 of figure 5.3.2.7.2-1, with the request body including the MBSUserDataIngStatSubsc data structure (for an HTTP PUT request) or the MBSUserDataIngStatSubscPatch (for an HTTP PATCH request).
If the MBSF determines that the received HTTP PUT or PATCH request message needs to be redirected, the MBSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall update/modify the corresponding "Individual MBS User Data Ingest Session Status Subscription" resource and respond to the NF service consumer with either:
a) an HTTP "200 OK" status code with the response body containing the updated representation of the "Individual MBS User Data Ingest Session Status Subscription" resource within the MBSUserDataIngStatSubsc data structure, as shown in step 2a of figure 5.3.2.7.2-1; or
b) an HTTP "204 No Content" status code, as shown in step 2b of figure 5.3.2.7.2-1.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.8 Nmbsf_MBSUserDataIngestSession_StatusUnsubscribe service operation
5.3.2.8.1 General
This service operation is used by an NF service consumer to request the deletion of an existing MBS User Data Ingest Session Status Subscription at the MBSF.
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_StatusUnsubscribe" service operation:
– MBS User Data Ingest Session Status Subscription Deletion.
5.3.2.8.2 MBS User Data Ingest Session Status Subscription Deletion
Figure 5.3.2.8.2-1 depicts a scenario where an NF service consumer requests the deletion of an existing MBS User Data Ingest Session Status Subscription at the MBSF.
Figure 5.3.2.8.2-1: MBS User Data Ingest Session Status Subscription Deletion procedure
1. In order to request the deletion of an existing MBS User Data Ingest Session Status Subscription, the NF service consumer shall send an HTTP DELETE request message targeting the corresponding "Individual MBS User Data Ingest Session Status Subscription" resource using the URI "{apiRoot}/nmbsf-mbs-ud-ingest/<apiVersion>/status-subscriptions/{subscriptionId}" as shown in step 1 of figure 5.3.2.8.2-1.
If the MBSF determines that the received HTTP DELETE request message needs to be redirected, the MBSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the MBSF shall:
– delete the corresponding "Individual MBS User Data Ingest Session Status Subscription" resource; and
– respond to the NF service consumer with an HTTP "204 No Content" status code, as shown in step 2 of figure 5.3.2.8.2-1.
On failure, the MBSF shall take proper error handling actions, as specified in clause 6.2.7, and respond to the NF service consumer with an appropriate error status code.
5.3.2.9 Nmbsf_MBSUserDataIngestSession_StatusNotify service operation
5.3.2.9.1 General
This service operation is used by the MBSF to notify a previously subscribed NF service consumer on MBS User Data Ingest Session Status event(s).
The following procedures are supported by the "Nmbsf_MBSUserDataIngestSession_StatusNotify" service operation:
– MBS User Data Ingest Session Status Notification.
5.3.2.9.2 MBS User Data Ingest Session Status Notification
Figure 5.3.2.9.2-1 depicts a scenario where the MBSF sends a notification request to a previously subscribed NF service consumer on MBS User Data Ingest Session Status event(s).
Figure 5.3.2.9.2-1: MBS User Data Ingest Session Status Notification procedure
1. In order to notify the NF service consumer on the occurrence of previously subscribed MBS User Data Ingest Session Status event(s), the MBSF shall send an HTTP POST request targeting the URI "{notifUri}", with the "notifUri" variable set to the notification URI received during the creation of the corresponding MBS User Data Ingest Session Status Subscription as specified in clause 5.3.2.6.2, and the request body including the MBSUserDataIngStatNotif data structure that shall include:
– the identifier of the MBS User Data Ingest Session to which the notification is related, within the "mbsIngSessionId" attribute; and
– the reported MBS User Data Ingest Session Status event(s), within the "eventNotifs" attribute.
If the NF service consumer determines that the received HTTP POST request message needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
2. Upon success, the NF Service Consumer shall respond to the MBSF with an HTTP "204 No Content" status code.
On failure, the NF service consumer shall take proper error handling actions, as specified in clause 6.2.7, and respond to the MBSF with an appropriate error status code.