5.8 GMD via MBMS related APIs

29.1223GPPRelease 18T8 reference point for Northbound APIsTS

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

5.8.1 Overview

There are two Group Message Delivery via MBMS related APIs defined:

– GMDviaMBMSbyMB2 API;

– GMDviaMBMSbyxMB API.

Both APIs are RESTful APIs that allow the SCS/AS to deliver the group message to the SCEF. They define a set of data models, resources and the related procedures for the creation and management of the group message delivery. The corresponding JSON schema for the representation of the resources and operations defined by the GMDviaMBMSbyMB2 API and GMDviaMBMSbyxMB API are provided in its complete form in Annex A.8.1 and Annex A.8.2, respectively.

5.8.2 GMDviaMBMSbyMB2 API

5.8.2.1 Data model

5.8.2.1.1 Resource data types

5.8.2.1.1.1 Introduction

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

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

Table 5.8.2.1.1.1-1: GMDviaMBMSbyMB2 API re-used Data Types

Data type	Reference	Comments
GeographicArea	3GPP TS 29.572 [42]	Identifies the geographical information of the user(s).
CivicAddress	3GPP TS 29.572 [42]	Identifies the civic address information of the user(s).
SupportedFeatures	3GPP TS 29.571 [45]	Used to negotiate the applicability of the optional features defined in table 5.8.2.3-1.

Table 5.8.2.1.1.1-2 specifies the data types defined for the GMDviaMBMSbyMB2 API.

Table 5.8.2.1.1.1-2: GMDviaMBMSbyMB2 API specific Data Types

Data type	Clause defined	Description	Applicability
GMDByMb2Notification	5.8.2.1.1.4	Represents a group message delivery notification.
GMDViaMBMSByMb2	5.8.2.1.1.3	Represents a group message delivery via MBMS by MB2.
GMDViaMBMSByMb2Patch	5.8.2.1.1.6	Represents a modification request of a group message delivery via MBMS by MB2.
MbmsLocArea	5.8.2.1.1.7	Represents a user location area whithin which is sent a group message delivery via MBMS request.
TMGIAllocation	5.8.2.1.1.2	Represents an individual TMGI Allocation resource.
TMGIAllocationPatch	5.8.2.1.1.5	Represents the parameters to request the modification of a TMGI Allocation resource.

5.8.2.1.1.2 Type: TMGIAllocation

This type represents TMGI Allocation request. The same structure is used in the request and response.

Table 5.8.2.1.1.2-1: Definition of type TMGIAllocation

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
self	Link	0..1	Link to the resource "Individual TMGI Allocation". This parameter shall be supplied by the SCEF in HTTP responses.
supportedFeatures	SupportedFeatures	0..1	Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation.
externalGroupId	ExternalGroupId	0..1	Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2].
mbmsLocArea	MbmsLocArea	0..1	Represents the location area within which the group message delivery via MBMS is allowed.
tmgiExpiration	DateTimeRo	0..1	Identifies the absolute time at which the TMGI is considered to expire.
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.8.2.1.1.3 Type: GMDViaMBMSByMb2

This type represents the group message delivery via MBMS by MB2.

Table 5.8.2.1.1.3-1: Definition of type GMDViaMBMSByMb2

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
self	Link	0..1	Link to the resource "Individual GMD via MBMS by MB". This parameter shall be supplied by the SCEF in HTTP responses.
notificationDestination	Link	1	A URI indicating the notification destination where T8 notification requests shall be delivered
requestTestNotification	boolean	0..1	Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.	Notification_test_event
websockNotifConfig	WebsockNotifConfig	0..1	Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4.	Notification_websocket
externalGroupId	ExternalGroupId	0..1	Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2].
mbmsLocArea	MbmsLocArea	0..1	Represents the location area within which the group message delivery via MBMS is allowed.
messageDeliveryStartTime	DateTime	0..1	Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately.
groupMessagePayload	Bytes	0..1	Indicates the payload the SCS/AS intends to deliver to the UEs.
scefMessageDeliveryIPv4	Ipv4AddrRo	0..1	Indicates the Ipv4 address where the SCEF wants to receive the data.
scefMessageDeliveryIPv6	Ipv6AddrRo	0..1	Indicates the Ipv6 address where the SCEF wants to receive the data.
scefMessageDeliveryPort	PortRo	0..1	Indicates the port number where the SCEF wants to receive the data.
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.8.2.1.1.4 Type: GMDByMb2Notification

This type represents the group message delivery notification.

Table 5.8.2.1.1.4-1: Definition of type GMDByMb2Notification

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
transaction	Link	1	Link to the transaction resource to which this notification is related.
deliveryTriggerStatus	boolean	1	Indicates whether delivery of group message payload corresponding to the TMGI was successful (TRUE) or not (FALSE).
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.8.2.1.1.5 Type: TMGIAllocationPatch

This type represents TMGI Allocation request. The structure is used for PATCH request.

Table 5.8.2.1.1.5-1: Definition of type TMGIAllocationPatch

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
externalGroupId	ExternalGroupId	0..1	Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2].
mbmsLocArea	MbmsLocArea	0..1	Represents the location area within which the group message delivery via MBMS is allowed.
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.8.2.1.1.6 Type: GMDViaMBMSByMb2Patch

This type represents group message delivery via MBMS request by MB2. The structure is used for PATCH request.

Table 5.8.2.1.1.6-1: Definition of the GMDViaMBMSByMb2Patch data type

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
externalGroupId	ExternalGroupId	0..1	Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2].
mbmsLocArea	MbmsLocArea	0..1	Represents the location area within which the group message delivery via MBMS is allowed.
messageDeliveryStartTime	DateTime	0..1	Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately.
groupMessagePayload	Bytes	0..1	Indicates the payload the SCS/AS intends to deliver to the UEs.
notificationDestination	Link	0..1	A URI indicating the notification destination where the notification requests shall be delivered.
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.8.2.1.1.7 Type: MbmsLocArea

This data type represents the user location area which is sent from the SCS/AS to the SCEF by group message delivery via MBMS request.

Table 5.8.2.1.1.7-1: Definition of the MbmsLocArea data type

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
cellId	array(string)	0..N	Indicates a Cell Global Identification of the user which identifies the cell the UE is registered.
enodeBId	array(string)	0..N	Indicates an eNodeB in which the UE is currently located.
geographicArea	array(GeographicArea)	0..N	Identifies a geographic area of the user where the UE is located.
mbmsServiceAreaId	array(string)	0..N	Identifies an MBMS Service Area Identity of the user where the UE is located.
civicAddress	array(CivicAddress)	0..N	Identifies a civic address of the user where the UE is located.
NOTE: Properties marked with a feature as defined in clause 5.8.2.3 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.8.2.2 Resource structure

5.8.2.2.1 General

All resource URIs of this API should have the following root:

{apiRoot}/3gpp-group-message-delivery-mb2/v1

"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp–group–message–delivery–mb2" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.

The following resources and HTTP methods are supported for this API:

Table 5.8.2.2.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method	HTTP initiator	Meaning
TMGI Allocation	/{scsAsId} /tmgi-allocation	GET	SCS/AS	Read all active TMGI resources for a given SCS/AS
TMGI Allocation	/{scsAsId} /tmgi-allocation	POST	SCS/AS	Create a new TMGI resource for a given SCS/AS
Individual TMGI Allocation	/{scsAsId} /tmgi-allocation/{tmgi}	PUT	SCS/AS	Replace an existing TMGI resource for a given SCS/AS and TMGI
		PATCH	SCS/AS	Modify an existing TMGI resource for a given SCS/AS and TMGI
		GET	SCS/AS	Read a TMGI allocation resource for a given SCS/AS and a TMGI
		DELETE	SCS/AS	Deallocate an existing TMGI resource for agiven SCS/AS and TMGI
GMD via MBMS by MB2	/{scsAsId} /tmgi-allocation/{tmgi}/delivery-via-mbms	GET	SCS/AS	Read all group message delivery resources for a given SCS/AS and TMGI.
GMD via MBMS by MB2	/{scsAsId} /tmgi-allocation/{tmgi}/delivery-via-mbms	POST	SCS/AS	Create a group message delivery resource for given SCS/AS and TMGI selected by the SCS/AS when MB2 is used as a southbound interface.
Individual GMD via MBMS by MB2	/{scsAsId} /tmgi-allocation/{tmgi}/delivery-via-mbms/ {transactionId}	PUT	SCS/AS	Replace a group message delivery resource
		PATCH	SCS/AS	Modify a group message delivery resource.
		GET	SCS/AS	Read a group message delivery resource.
		DELETE	SCS/AS	Delete a group message delivery resource.

5.8.2.2.2 Resource: TMGI Allocation

5.8.2.2.2.1 Introduction

This resource allows the SCS/AS to read all active TMGI or request a TMGI allocation.

5.8.2.2.2.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation

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

Table 5.8.2.2.2.2-1: Resource URI variables for resource "TMGI Allocation"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.

5.8.2.2.2.3 Resource methods

5.8.2.2.2.3.1 GET

The GET method read all TMGI Allocation resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.2.3.1-1.

Table 5.8.2.2.2.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	array(TMGIAllocation)	0..N	200 OK	The TMGI allocation for the SCS/AS in the request URI are returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.2.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.2.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.2.3.2 PUT

This HTTP method is not supported for the resource.

5.8.2.2.2.3.3 PATCH

This HTTP method is not supported for the resource.

5.8.2.2.2.3.4 POST

The POST method creates a new TMGI Allocation resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.2.3.4-1.

Table 5.8.2.2.2.3.4-1: Data structures supported by the POST request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	TMGIAllocation	1	Parameters to create a TMGI allocation resource
Response body	Data type	Cardinality	Response codes	Remarks
Response body	TMGIAllocation	1	201 Created	The creation of a TMGI allocation was created successfully. The SCEF shall return a data structure of type "TMGI Allocation" in the response payload body. On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the TMGI
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.2.3.4-2: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}

5.8.2.2.2.3.5 DELETE

This HTTP method is not supported for the resource.

5.8.2.2.3 Resource: Individual TMGI Allocation

5.8.2.2.3.1 Introduction

This resource allows the SCS/AS to read an active TMGI or renew an TMGI.

5.8.2.2.3.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}

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

Table 5.8.2.2.3.2-1: Resource URI variables for resource "Individual TMGI Allocation"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.
Tmgi	string	TMGI.

5.8.2.2.3.3 Resource methods

5.8.2.2.3.3.1 GET

The GET method reads a TMGI Allocation resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.1-1.

Table 5.8.2.2.3.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	TMGIAllocation	1	200 OK	A TMGI allocation for the SCS/AS in the request URI is returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.3.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.3.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.3.3.2 PUT

The PUT method replaces a TMGI Allocation resource for a given SCS/AS to renew a TMGI expiration time. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.2-1.

Table 5.8.2.2.3.3.2-1: Data structures supported by the PUT request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	TMGIAllocation	1	Parameters to replace a TMGI resource
Response body	Data type	Cardinality	Response codes	Remarks
	TMGIAllocation	1	200 OK	The replace of a TMGI allocation was created successfully.
	none		204 No Content	The TMGI expiration time renewal is successful, and no content is to be sent in the response message body.
	none		307 Temporary Redirect	Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.3.3.2-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.3.3.2-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.3.3.3 PATCH

The PATCH method modifies a TMGI Allocation resource for a given SCS/AS to renew a TMGI expiration time. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.3-1.

Table 5.8.2.2.3.3.3-1: Data structures supported by the PATCH request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	TMGIAllocationPatch	1	Parameters to modify a TMGI resource
Response body	Data type	Cardinality	Response codes	Remarks
	TMGIAllocation	1	200 OK	The modification of a TMGI allocation was created successfully.
	none		204 No Content	The TMGI expiration time renewal is successful, and no content is to be sent in the response message body.
	none		307 Temporary Redirect	Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.3.3.3-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.3.3.3-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.3.3.4 POST

This HTTP method is not supported for the resource.

5.8.2.2.3.3.5 DELETE

The DELETE method deletes a TMGI Allocation resource for a given SCS/AS to deallocate a TMGI. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.5-1.

Table 5.8.2.2.3.3.5-1: Data structures supported by the DELETE request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	none		204 No Content	The TMGI allocation resource was removed successfully.
	none		307 Temporary Redirect	Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.3.3.5-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.3.3.5-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.4 Resource: GMD via MBMS by MB2

5.8.2.2.4.1 Introduction

This resource allows the SCS/AS to read all active group message delivery resources or create a group message delivery when the MB2 is used as a southbound interface.

5.8.2.2.4.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms

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

Table 5.8.2.2.4.2-1: Resource URI variables for resource "GMD via MBMS by MB2"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.
Tmgi	string	TMGI

5.8.2.2.4.3 Resource methods

5.8.2.2.4.3.1 GET

The GET method reads all group message delivery via MBMS resources for a given SCS/AS and a TMGI. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.4.3.1-1.

Table 5.8.2.2.4.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	array(GMDViaMBMSByMb2)	0..N	200 OK	The TMGI allocation for the SCS/AS in the request URI are returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.4.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.4.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.4.3.2 PUT

This HTTP method is not supported for the resource.

5.8.2.2.4.3.3 PATCH

This HTTP method is not supported for the resource.

5.8.2.2.4.3.4 POST

The POST method creates a new group message delivery via MBMS resource for a given SCS/AS and TMGI selected by the SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. The SCEF shall construct the URI of the created resource using that URI.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.4.3.4-1.

Table 5.8.2.2.4.3.4-1: Data structures supported by the POST request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	GMDViaMBMSByMb2	1	Parameters to create and authorize a group message delivery via MBMS with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
Response body	GMDViaMBMSByMb2	1	201 Created	The creation of a group message delivery was created successfully. The SCEF shall return a data structure of type "GMDViaMBMSByMb2" in the response payload body. On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the Transaction Id.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.4.3.4-2: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms/{transactionId}

5.8.2.2.4.3.5 DELETE

This HTTP method is not supported for the resource.

5.8.2.2.5 Resource: Individual GMD via MBMS by MB2

5.8.2.2.5.1 Introduction

This resource allows the SCS/AS to modify or delete a group message delivery via MBMS by MB2 resource.

5.8.2.2.5.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms/{transactionId}

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

Table 5.8.2.2.5.2-1: Resource URI variables for resource "Individual GMD via MBMS by MB2"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.
transactionId	string	TransactionId selected by the SCEF. The transactionId corresponds to the stage 2 TLTRI.

5.8.2.2.5.3 Resource methods

5.8.2.2.5.3.1 GET

The GET method reads a group message delivery via MBMS by MB2 resource for a given SCS/AS, a TMGI and a transactionId. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.5.3.1-1.

Table 5.8.2.2.5.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	GMDViaMBMSbyMb2	0..1	200 OK	The group message delivery resource for the SCS/AS in the request URI is returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.5.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.5.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.5.3.2 PUT

Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.2.2.4.3.4, replace of its properties can be performed by the SCS/AS by using the HTTP PUT method on the "delivery_via_mbms" instance resource as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.8.2.2.5.3.2-1.

The content body of the group message delivery via MBMS update request shall contain updated full representation of the group message delivery resource. Only the properties "locationinfo", "accuracy", "messageDeliverystarttime" and "groupMessagepayload" can be modified.

The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in table 5.8.2.2.5.3.2-1.

Table 5.8.2.2.5.3.2-1: Data structures supported by the PUT request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	GMDViaMBMSByMb2	1	Parameters to replace group message delivery resource with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
	GMDViaMBMSByMb2	1	200 OK	The group message delivery was modified successfully. The SCEF shall return an updated data structure of type "GMDViaMBMSByMb2" in the response payload body.
	none		204 No Content	The group message delivery is replaced successfully, and no content is to be sent in the response message body.
	none		307 Temporary Redirect	Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.5.3.2-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.5.3.2-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.5.3.3 PATCH

Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.2.2.4.3.4, partial updating of its properties can be performed by the SCS/AS by using the HTTP PATCH method on the "delivery-via-mbms" instance resource.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.5.3.3-1.

Table 5.8.2.2.5.3.3-1: Data structures supported by the PATCH request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	GMDViaMBMSByMb2Patch	1	Parameters to partially update a group message delivery with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
	GMDViaMBMSByMb2	1	200 OK	The group message delivery was modified successfully. The SCEF shall return an updated data structure of type "GMDViaMBMSByMb2" in the response payload body.
	none		204 No Content	The group message delivery is modified successfully, and no content is to be sent in the response message body.
	none		307 Temporary Redirect	Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.5.3.3-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.5.3.3-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.5.3.4 POST

This HTTP method is not supported for the resource.

5.8.2.2.5.3.5 DELETE

To cancel a group message delivery, the SCS/AS shall use the HTTP DELETE method on the individual "delivery_via_mbms" resource which is indicated by the URI in the Location header of the HTTP POST response:

The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.8.2.2.5.3.5-1.

Table 5.8.2.2.5.3.5-1.: Data structures supported by the DELETE request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	none		204 No Content	The group message delivery subscription was cancelled successfully.
	none		307 Temporary Redirect	Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply.

Table 5.8.2.2.5.3.5-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2.5.3.5-3: Headers supported by the 308 Response Code on this resource

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

5.8.2.2.6 Void

5.8.2.2A Notifications

5.8.2.2A.1 General

The notifications provided by the GMDviaMBMSbyMB2 API are specified in this clause.

Table 5.8.2.2A.1-1: Notifications overview

Notification

Callback URI

HTTP method or custom operation

Description

(service operation)

GMD via MBMS by MB2 Notification

{notificationDestination}

POST

Report a specific group message delivery result to the SCS/AS for a given transaction Id selected by the SCEF.

5.8.2.2A.2 GMD via MBMS by MB2 Notification

5.8.2.2A.2.1 Description

The GMD via MBMS by MB2 Notification allows the SCEF report the delivery trigger status to the SCS/AS to indicate whether group message delivery was triggered successful.

5.8.2.2A.2.2 Target URI

The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.8.2.2A.2.2-1.

Table 5.8.2.2A.2.2-1: Callback URI variables

Name

Data type

Definition

notificationDestination

Link

A URI indicating the notification destination where T8 notification requests shall be delivered.

This URI shall be provided within the field "notificationDestination" in the GMDViaMBMSByMb2 type.

5.8.2.2A.2.3 Standard Methods

5.8.2.2A.2.3.1 Notification via POST

To report the status of the delivery trigger status to the SCS/AS, the SCEF shall use the HTTP POST method on the notification point as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.8.2.1.1.4-1.

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

Table 5.8.2.2A.2.3.1-1: Data structures supported by the POST Request Body

Data type	Cardinality	Description
GMDByMb2Notification	1	The delivery status notification.

Table 5.8.2.2A.2.3.1-2: Data structures supported by the POST Response Body

Data type	Cardinality	Response codes	Description
Acknowledgement	1	200 OK	The successful acknowledgement of the notification with a body.
(None)		204 No Content	The successful acknowledgement of the notification without a body.
none		307 Temporary Redirect	Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10.
none		308 Permanent Redirect	Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.8.2.2A.2.3.1-3: Headers supported by the 307 Response Code on this resource

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

Table 5.8.2.2A.2.3.1-4: Headers supported by the 308 Response Code on this resource

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

5.8.2.2A.2.3.2 Notification via Websocket

If supported by both SCS/AS and SCEF and successfully negotiated, the GMDByMb2Notification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.

5.8.2.3 Used Features

The table below defines the features applicable to the GMDviaMBMSbyMB2 API. Those features are negotiated as described in clause 5.2.7.

Table 5.8.2.3-1: Features used by GMDviaMBMSbyMB2 API

Feature Number	Feature	Description
1	Notification_websocket	The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event featute is also supported.
2	Notification_test_event	The testing of notification connection is supported according to clause 5.2.5.3.
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature.

5.8.2.4 Error handling

5.8.2.4.1 General

HTTP error handling shall be supported as specified in clause 5.2.6.

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

5.8.2.4.2 Protocol Errors

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

5.8.2.4.3 Application Errors

The application errors defined for GMDviaMBMSbyMB2 API are listed in table 5.8.2.4.3-1.

Table 5.8.2.4.3-1: Application errors

Application Error	HTTP status code	Description	Applicability

5.8.3 GMDviaMBMSbyxMB API

5.8.3.1 Data model

5.8.3.1.1 Resource data types

5.8.3.1.1.1 Introduction

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

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

Table 5.8.3.1.1.1-1: GMDviaMBMSbyxMB API re-used Data Types

Data type	Reference	Comments
GeographicArea	3GPP TS 29.572 [42]	Identifies the geographical information of the user(s).
CivicAddress	3GPP TS 29.572 [42]	Identifies the civic address information of the user(s).
SupportedFeatures	3GPP TS 29.571 [45]	Used to negotiate the applicability of the optional features defined in table 5.8.3.3-1.

Table 5.8.3.1.1.1-2 specifies the data types defined for the GMDviaMBMSbyxMB API.

Table 5.8.3.1.1.1-2: GMDviaMBMSbyxMB API specific Data Types

Data type	Clause defined	Description	Applicability
GMDByxMBNotification	5.8.3.1.1.4	Represents a group message delivery notification.
GMDViaMBMSByxMB	5.8.3.1.1.3	Represents a group message delivery via MBMS by xMB.
GMDViaMBMSByxMBPatch	5.8.3.1.1.5	Represents a modification request of a group message delivery via MBMS by xMB.
MbmsLocArea	5.8.3.1.1.6	Represents a user location area whithin which is sent a group message delivery via MBMS request.
ServiceAnnouncementMode	5.8.3.1.2.3	Represents the service annoucement mode.
ServiceCreation	5.8.3.1.1.2	Represents an individual xMB Service resource.

5.8.3.1.1.2 Type: ServiceCreation

This type represents the service resource.

Table 5.8.3.1.1.2-1: Definition of the ServiceCreation data type

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
self	Link	0..1	Link to the resource "Individual xMB Service". This parameter shall be supplied by the SCEF in HTTP responses.
supportedFeatures	SupportedFeatures	0..1	Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation.
externalGroupId	ExternalGroupId	0..1	Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2] supplied by the SCS/AS.
userServiceId	string	0..1	Identifies the MBMS User Service supplied by the SCEF.
serviceClass	string	0..1	The service class that service belongs to supplied by the SCEF.
serviceLanguages	array(string)	0..N	List of language of the service content supplied by the SCEF.
serviceNames	array(string)	0..N	List of Service Names supplied by the SCEF
receiveOnlyMode	boolean	0..1	When set to ‘true’, the Content Provider indicates that the service is a Receive Only Mode service. This parameter is supplied by the SCEF
serviceAnnouncementMode	ServiceAnnouncementMode	0..1	Enumeration of Service Announcement Mode supplied by the SCEF.
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.8.3.1.1.3 Type: GMDViaMBMSByxMB

This type represents the group message delivery via MBMS by xMB.

Table 5.8.3.1.1.3-1: Definition of type GMDViaMBMSByxMB

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
self	Link	0..1	Link to the resource "Individual GMD via MBMS by xMB". This parameter shall be supplied by the SCEF in HTTP responses.
notificationDestination	Link	1	A URI indicating the notification destination where T8 notification requests shall be delivered
requestTestNotification	boolean	0..1	Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.	Notification_test_event
websockNotifConfig	WebsockNotifConfig	0..1	Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4.	Notification_websocket
mbmsLocArea	MbmsLocArea	0..1	Represents the location area within which the group message delivery via MBMS is allowed.
messageDeliveryStartTime	DateTime	0..1	Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately.
messageDeliveryStopTime	DateTime	0..1	Identifies the absolute time at which the SCS/As is expected to stop distributing the data. If absent, configuration time will be used.
groupMessagePayload	Bytes	0..1	Indicates the payload the SCS/AS intends to deliver to the UEs.
scefMessageDeliveryIPv4	Ipv4AddrRo	0..1	Indicates the Ipv4 address where the SCEF wants to receive the data.
scefMessageDeliveryIPv6	Ipv6AddrRo	0..1	Indicates the Ipv6 address where the SCEF wants to receive the data.
scefMessageDeliveryPort	PortRo	0..1	Indicates the port number where the SCEF wants to receive the data.
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.8.3.1.1.4 Type: GMDByxMBNotification

This type represents the group message delivery notification.

Table 5.8.3.1.1.4-1: Definition of type GMDByxMbNotification

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
transaction	Link	1	Link to the transaction resource to which this notification is related.
deliveryTriggerStatus	boolean	1	Indicates whether delivery of group message payload was successful (TRUE) or not (FALSE)
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.8.3.1.1.5 Type: GMDViaMBMSByxMBPatch

This type represents group message delivery via MBMS request. The structure is used for PATCH request.

Table 5.8.3.1.1.5-1: Definition of the GMDViaMBMSByxMBPatch data type

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
mbmsLocArea	MbmsLocArea	0..1	Represents the location area within which the group message delivery via MBMS is allowed.
messageDeliveryStartTime	DateTime	0..1	Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately.
messageDeliveryStopTime	DateTime	0..1	Identifies the absolute time at which the SCS/As is expected to stop distributing the data. If absent, the configuration value will be used.
groupMessagePayload	Bytes	0..1	Indicates the payload the SCS/AS intends to deliver to the UEs.
notificationDestination	Link	0..1	A URI indicating the notification destination where the notification requests shall be delivered
NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.8.3.1.1.6 Type: MbmsLocArea

This data type represents the user location area which is sent from the SCS/AS to the SCEF by group message delivery via MBMS request.

Table 5.8.3.1.1.6-1: Definition of the MbmsLocArea data type

Attribute name	Data type	Cardinality	Description	Applicability (NOTE)
cellId	array(string)	0..N	Indicates a Cell Global Identification of the user which identifies the cell the UE is registered.
enodeBId	array(string)	0..N	Indicates an eNodeB in which the UE is currently located.
geographicArea	array(GeographicArea)	0..N	Identifies a geographic area of the user where the UE is located.
mbmsServiceAreaId	array(string)	0..N	Identifies an MBMS Service Area Identity of the user where the UE is located.
civicAddress	array(CivicAddress)	0..N	Identifies a civic address of the user where the UE is located.
NOTE: Properties marked with a feature as defined in clause 5.8.2.3 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.8.3.1.2 Referenced simple data types and enumerations

5.8.3.1.2.1 Introduction

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

5.8.3.1.2.2 Simple data types

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

Table 5.8.3.1.2.2-1: Simple data types

Type name	Description

5.8.3.1.2.3 Enumeration: ServiceAnnouncementMode

The enumeration ServiceAnnouncementMode represents the service annoucement mode

Table 5.8.3.1.2.3-1: Enumeration ServiceAnnouncementMode

Enumeration value	Description	Applicability (NOTE)
SACH	BM-SC performs the service announcement for the current service using the SACH channel.
CONTENT_PROVIDER	BM-SC provides the necessary service access information used by the Content Provider to create the service announcement information.
NOTE: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.8.3.2 Resource structure

5.8.3.2.1 General

All resource URIs of this API should have the following root:

{apiRoot}/3gpp-group-message-delivery-xmb/v1

"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-group-message-delivery-xmb" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.

The following resources and HTTP methods are supported for this API:

Table 5.8.3.2.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method	HTTP initiator	Meaning
xMB Services	/{scsAsId} /services	POST	SCS/AS	Create a service when xMB is used as a southbound interface.
xMB Services	/{scsAsId} /services	GET	SCS/AS	Read all active service resources for a given SCS/AS.
Individual xMB Service	/{scsAsId} /services/{serviceId}	GET	SCS/AS	Read an active service resource for a given SCS/AS and Service Id.
Individual xMB Service	/{scsAsId} /services/{serviceId}	DELETE	SCS/AS	Delete an existing service resource for agiven SCS/AS and Service Id.
GMD via MBMS by xMB	/{scsAsId} /services/{serviceId}/delivery-via-mbms	GET	SCS/AS	Read all group message delivery resources for a given SCS/AS and Service Id.
GMD via MBMS by xMB	/{scsAsId} /services/{serviceId}/delivery-via-mbms	POST	SCS/AS	Create a group message delivery resource for given SCS/AS and Service Id when xMB is used as a southbound interface.
Individual GMD via MBMS by xMB	/{scsAsId} /services/{serviceId}/delivery-via-mbms/{transactionId}	PUT	SCS/AS	Replace a group message delivery resource
		PATCH	SCS/AS	Modify a group message delivery resource.
		GET	SCS/AS	Read a group message delivery resource.
		DELETE	SCS/AS	Delete a group message delivery resource.

5.8.3.2.2 Resource: xMB Services

5.8.3.2.2.1 Introduction

This resource allows the SCS/AS to create service resource when the xMB is used as a southbound interface.

5.8.3.2.2.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services

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

Table 5.8.3.2.2.2-1: Resource URI variables for resource "GMD via MBMS by xMB"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.

5.8.3.2.2.3 Resource methods

5.8.3.2.2.3.1 GET

The GET method allows the SCS/AS read all active service resources for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.2.3.1-1.

Table 5.8.3.2.2.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none.
Response body	Data type	Cardinality	Response codes	Remarks
	array(ServiceCreation)	0..N	200 OK	The service resource for the SCS/AS in the request URI is returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.2.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.2.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.2.3.2 PUT

This HTTP method is not supported for the resource.

5.8.3.2.2.3.3 PATCH

This HTTP method is not supported for the resource.

5.8.3.2.2.3.4 POST

The POST method creates a new service resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.2.3.4-1.

Table 5.8.3.2.2.3.4-1: Data structures supported by the POST request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	ServiceCreation	1	Parameters to create and authorize a service with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
Response body	ServiceCreation	1	201 Created	The resource of a service was created successfully. The SCEF shall return a data structure of type "ServiceCreation" in the response payload body. On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the ServiceId.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.2.3.4-2: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}

5.8.3.2.2.3.5 DELETE

This HTTP method is not supported for the resource.

5.8.3.2.3 Resource: Individual xMB Service

5.8.3.2.3.1 Introduction

This resource allows the SCS/AS to delete a service resource.

5.8.3.2.3.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}

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

Table 5.8.3.2.3.2-1: Resource URI variables for resource "Individual Service Creation"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.
serviceId	string	Identifier of the service.

5.8.3.2.3.3 Resource methods

5.8.3.2.3.3.1 GET

The GET method reads a active service resource for a given SCS/AS and a service Id. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.3.3.1-1.

Table 5.8.3.2.3.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	ServiceCreation	0..1	200 OK	The service resource for the SCS/AS and Service Id in the request URI is returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.3.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.3.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.3.3.2 PUT

This HTTP method is not supported for the resource.

5.8.3.2.3.3.3 PATCH

This HTTP method is not supported for the resource.

5.8.3.2.3.3.4 POST

This HTTP method is not supported for the resource.

5.8.3.2.3.3.5 DELETE

To delete a service resource, the SCS/AS shall use the HTTP DELETE method on the "ServiceCreation" resource which is indicated by the URI in the Location header of the HTTP POST response:

The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.8.3.2.3.3.5-1.

Table 5.8.3.2.3.3.5-1.: Data structures supported by the DELETE request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	none		204 No Content	The group message delivery subscription was cancelled successfully.
	none		307 Temporary Redirect	Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply

Table 5.8.3.2.3.3.5-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.3.3.5-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.4 Resource: GMD via MBMS by xMB

5.8.3.2.4.1 Introduction

This resource allows the SCS/AS to:

– read all of the group message delivery via MBMS by xMB resources for a given SCS/AS and a service identifier; or

– create a group message delivery when the xMB is used as a southbound interface.

5.8.3.2.4.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}/delivery-via-mbms

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

Table 5.8.3.2.4.2-1: Resource URI variables for resource "GMD via MBMS by xMB"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.
ServiceId	string	Identifier of the service

5.8.3.2.4.3 Resource methods

5.8.3.2.4.3.1 GET

The GET method reads all of the group message delivery via MBMS by xMB resources for a given SCS/AS and a service identifier. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.4.3.1-1.

Table 5.8.3.2.4.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	None
Response body	Data type	Cardinality	Response codes	Remarks
	array(GMDViaMBMSByxMB)	0..N	200 OK	The list of "GMDViaMBMSByxMB" data for the SCS/AS and the service identifier are returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.4.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.4.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.4.3.2 PUT

This HTTP method is not supported for the resource.

5.8.3.2.4.3.3 PATCH

This HTTP method is not supported for the resource.

5.8.3.2.4.3.4 POST

The POST method creates a new group message delivery via MBMS resource for a given SCS/AS and service Id selected by the SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.4.3.4-1.

Table 5.8.3.2.4.3.4-1: Data structures supported by the POST request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	GMDViaMBMSByxMB	1	Parameters to create and authorize a group message delivery via MBMS with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
Response body	GMDViaMBMSByxMB	1	201 Created	The creation of a group message delivery was created successfully. The SCEF shall return a data structure of type "GMDViaMBMSByxMB" in the response payload body. On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the Transaction Id
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.4.3.4-2: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}/delivery-via-mbms/{transactionId}

5.8.3.2.4.3.5 DELETE

This HTTP method is not supported for the resource.

5.8.3.2.5 Resource: Individual GMD via MBMS by xMB

5.8.3.2.5.1 Introduction

This resource allows the SCS/AS to modify or delete a group message delivery via MBMS resource.

5.8.3.2.5.2 Resource definition

Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}/delivery-via-mbms/{transactionId}

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

Table 5.8.3.2.5.2-1: Resource URI variables for resource "Individual GMD via MBMS by xMB"

Name	Data type	Definition
apiRoot	string	See clause 5.2.4.
scsAsId	string	Identifier of the SCS/AS.
serviceIdId	string	Identifier of the service selected by the SCEF. The transactionId corresponds to the stage 2 TLTRI.

5.8.3.2.5.3 Resource methods

5.8.3.2.5.3.1 GET

The GET method reads a group message delivery via MBMS resource for a given SCS/AS, a service Id and a transactionId. It is initiated by the SCS/AS and answered by the SCEF.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.3.3.1-1.

Table 5.8.3.2.5.3.1-1: Data structures supported by the GET request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	GMDViaMBMSByxMB	0..1	200 OK	The group message delivery resource for the SCS/AS in the request URI is returned.
	none		307 Temporary Redirect	Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.5.3.1-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.5.3.1-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.5.3.2 PUT

Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.3.2.4.3.4, replace of its properties can be performed by the SCS/AS by using the HTTP PUT method on the "delivery-via-mbms" instance resource as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.8.3.1.1.3-1.

The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in table 5.8.3.2.5.3.2-1.

Table 5.8.3.2.5.3.2-1: Data structures supported by the PUT request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	GMDViaMBMSByxMB	1	Parameters to replace group message delivery resource with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
	GMDViaMBMSByxMB	1	200 OK	The group message delivery was modified successfully. The SCEF shall return an updated data structure of type "GMDViaMBMSByxMB" in the response payload body.
	none		204 No Content	The group message delivery was modified successfully, and no content is to be sent in the response message body.
	none		307 Temporary Redirect	Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.5.3.2-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.5.3.2-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.5.3.3 PATCH

Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.3.2.4.3.4, partial updating of its properties can be performed by the SCS/AS by using the HTTP PATCH method on the "delivery-via-mbms" instance resource.

This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.5.3.3-1.

Table 5.8.3.2.5.3.3-1: Data structures supported by the PATCH request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	GMDViaMBMSByxMB Patch	1	Parameters to partially update a group message delivery with the SCEF.
Response body	Data type	Cardinality	Response codes	Remarks
	GMDViaMBMSByxMB	1	200 OK	The group message delivery was modified successfully. The SCEF shall return an updated data structure of type "GMDViaMBMSByxMB" in the response payload body.
	none		204 No Content	The group message delivery was modified successfully, and no content is to be sent in the response message body.
	none		307 Temporary Redirect	Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.5.3.3-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.5.3.3-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.5.3.4 POST

This HTTP method is not supported for the resource.

5.8.3.2.5.3.5 DELETE

The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.8.3.2.5.3.5-1.

Table 5.8.3.2.5.3.5-1: Data structures supported by the DELETE request/response by the resource

Request body	Data type	Cardinality	Remarks
Request body	none
Response body	Data type	Cardinality	Response codes	Remarks
	none		204 No Content	The group message delivery subscription was cancelled successfully.
	none		307 Temporary Redirect	Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
	none		308 Permanent Redirect	Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply.

Table 5.8.3.2.5.3.5-2: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2.5.3.5-3: Headers supported by the 308 Response Code on this resource

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

5.8.3.2.6 Void

5.8.3.2A Notifications

5.8.3.2A.1 General

The notifications provided by the GMDviaMBMSbyxMB API are specified in this clause.

Table 5.8.3.2A.1-1: Notifications overview

Notification

Callback URI

HTTP method or custom operation

Description

(service operation)

GMD via MBMS by xMB Notification

{notificationDestination}

POST

Report a specific group message delivery result to the SCS/AS for a given Transaction Id selected by the SCEF.

5.8.3.2A.2 GMD via MBMS by xMB Notification

5.8.3.2A.2.1 Description

The GMD via MBMS by xMB Notification allows the SCEF report the delivery trigger status to the SCS/AS to indicate whether group message delivery was triggered successful.

5.8.3.2A.2.2 Target URI

The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.8.3.2A.2.2-1.

Table 5.8.3.2A.2.2-1: Callback URI variables

Name

Data type

Definition

notificationDestination

Link

A URI indicating the notification destination where T8 notification requests shall be delivered.

This URI shall be provided within the field "notificationDestination" in the GMDViaMBMSByxMB type.

5.8.3.2A.2.3 Standard Methods

5.8.3.2A.2.3.1 Notification via POST

To report the status of the delivery trigger status to the SCS/AS, the SCEF shall use the HTTP POST method on the notification point as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.8.3.1.1.4-1.

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

Table 5.8.3.2A.2.3.1-1: Data structures supported by the POST Request Body

Data type	Cardinality	Description
GMDByxMBNotification	1	The delivery status notification.

Table 5.8.3.2A.2.3.1-2: Data structures supported by the POST Response Body

Data type	Cardinality	Response codes	Description
Acknowledgement	1	200 OK	The successful acknowledgement of the notification with a body.
(None)		204 No Content	The successful acknowledgement of the notification without a body.
none		307 Temporary Redirect	Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10.
none		308 Permanent Redirect	Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Table 5.8.3.2A.2.3.1-3: Headers supported by the 307 Response Code on this resource

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

Table 5.8.3.2A.2.3.1-4: Headers supported by the 308 Response Code on this resource

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

5.8.3.2a.2.3.2 Notification via Websocket

If supported by both SCS/AS and SCEF and successfully negotiated, the GMDByxMBNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.

5.8.3.3 Used Features

The table below defines the features applicable to the GMDviaMBMSbyxMB API. Those features are negotiated as described in clause 5.2.7.

Table 5.8.3.3-1: Features used by GMDviaMBMSbyxMB API

Feature Number	Feature	Description
1	Notification_websocket	The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event featute is also supported.
2	Notification_test_event	The testing of notification connection is supported according to clause 5.2.5.3.
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature.

5.8.3.4 Error handling

5.8.3.4.1 General

HTTP error handling shall be supported as specified in clause 5.2.6.

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

5.8.3.4.2 Protocol Errors

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

5.8.3.4.3 Application Errors

The application errors defined for GMDviaMBMSbyxMB API are listed in table 5.8.3.4.3-1.

Table 5.8.3.4.3-1: Application errors

Application Error	HTTP status code	Description	Applicability