C.2 Resource representation and APIs for group management
24.5443GPPGroup Management - Service Enabler Architecture Layer for Verticals (SEAL)Protocol specificationRelease 17TS
C.2.1 SU_GroupManagement API
C.2.1.1 API URI
The CoAP URIs used in CoAP requests from SGM-C towards the SGM-S shall have the Resource URI structure as defined in clause C.1.1 of 3GPP TS 24.546 [23] with the following clarifications:
– The <apiName> shall be "su-gm".
– The <apiVersion> shall be "v1".
– The <apiSpecificSuffixes> shall be set as described in clause C.2.1.2
C.2.1.2 Resources
C.2.1.2.1 Overview
Figure C.2.1.2.1-1: Resource URI structure of the SU_GroupManagement API
Table C.2.1.2.1-1 provides an overview of the resources and applicable CoAP methods.
Table C.2.1.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
CoAP method |
Description |
|
VAL Group Documents |
/group-documents |
POST |
Create a new VAL group document. |
|
GET |
Retrieve VAL group documents according to the query parameters. If there are no query parameters, do not fetch any VAL group document. |
||
|
Individual VAL Group Document |
/group-documents/{groupDocId} |
GET (NOTE) |
Retrieve an individual VAL group’s membership and configuration information according to query parameter on the resource identified by {groupDocId}. If there are no query parameter, fetch the whole VAL group document resource identified by {groupDocId}. |
|
PUT |
Update an individual VAL group’s membership and configuration information identified by {groupDocId}. |
||
|
DELETE |
Delete a VAL group document. |
||
|
Individual VAL Group Member Information |
/group-documents/{groupDocId}/members/{memberId} |
GET (NOTE) |
Retrieve VAL group member information according to the query parameters. |
|
PUT |
Create or update VAL group member information. |
||
|
DELETE |
Delete VAL group member information. |
||
|
VAL Group Membership |
/group-membership/{valTargetUe} |
GET (NOTE) |
Retrieve a list of VAL groups in which the VAL user or VAL UE is a member according to the query parameters. |
|
NOTE: The GET method can also be used to observe this resource. |
|||
Editor’s note: Whether any changes required in the API along with its data model based on limitations of constrained devices is FFS.
C.2.1.2.2 Resource: VAL Group Documents
C.2.1.2.2.1 Description
The VAL Group Documents resource represents all the VAL group documents that are created at a given SGM-S, or allows to create a new VAL group.
C.2.1.2.2.2 Resource Definition
Resource URI: {apiRoot}/su-gm/<apiVersion>/group-documents
This resource shall support the resource URI variables defined in the table C.2.1.2.2.2-1.
Table C.2.1.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause C.1.1 of 3GPP TS 24.546 [23] |
|
apiVersion |
string |
See clause C.2.1.1 |
C.2.1.2.2.3 Resource Standard Methods
C.2.1.2.2.3.1 POST
This operation creates a VAL group at the SGM-S.
This method shall support the request data structures specified in table C.2.1.2.2.3.1-1 and the response data structures and response codes specified in table C.2.1.2.2.3.1-2, and the response options specified in table C.2.1.2.2.3.1-3.
Table C.2.1.2.2.3.1-1: Data structures supported by the POST Request payload on this resource
|
Data type |
P |
Cardinality |
Description |
|
VALGroupDocument |
M |
1 |
Details of the VAL group that needs to be created, |
Table C.2.1.2.2.3.1-2: Data structures supported by the POST Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
VALGroupDocument |
M |
1 |
2.01 Created |
VAL group created successfully. The "groupDocId" of the created resource shall be returned in the "Location-Path" option. |
|
NOTE: The mandatory CoAP error status codes for the GET Request listed in table C.1.3-1 of 3GPP TS 24.546 [23] shall also apply.. |
||||
Table C.2.1.2.2.3.1-3: Options supported by the 2.01 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location-Path |
string |
M |
1 |
Contains the location path of the newly created resource relative to the request URI. It contains the groupDocId segment of the complete resource URI according to the structure: {apiRoot}/su-gm/<apiVersion>/group-documents/{groupDocId} |
C.2.1.2.2.3.2 GET
This operation retrieves VAL group documents satisfying filter criteria.
This method shall support the URI query parameters specified in table C.2.1.2.2.3.2-1.
Table C.2.1.2.2.3.2-1: URI query parameters supported by the GET Request on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
val-group-id |
string |
O |
0..1 |
Identifies a VAL group. |
|
val-service-id |
string |
O |
0..1 |
Identifies a VAL service. |
|
member-id |
ValTargetUe |
O |
0..1 |
Identifies a VAL user or VAL UE to match a group member. |
|
time-period |
array(DateTime) |
O |
2..2 |
Identifies the time period within which the group was created. The first element is the start time, followed by the end time of the time period. |
This method shall support the request options specified in table C.2.1.2.2.3.2-2, the response data structures and response codes specified in table C.2.1.2.2.3.2-3, and the response options specified in table C.2.1.2.2.3.2-4.
Table C.2.1.2.2.3.2-2: Options supported by the GET Request on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
When set to 0 (Register) it extends the GET request to subscribe to the changes of this resource. When set to 1 (Deregister) it cancels the subscription. |
|
NOTE: Other request options also apply in accordance with normal CoAP procedures. |
||||
This method shall support the response data structures and response codes specified in table C.2.1.2.2.3.2 -3.
Table C.2.1.2.2.3.2-3: Data structures supported by the GET Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(VALGroupDocument) |
M |
0..N |
2.05 Content |
List of VAL group documents. This response shall include VAL group documents matching all the query parameters provided in the request. |
|
NOTE: The mandatory CoAP error status codes for the GET method listed in table C.1.3-1 of 3GPP TS 24.546 [23] also apply. |
||||
Table C.2.1.2.2.3.2-4: Options supported by the 2.05 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
Sequence number of the notification. |
|
NOTE: Other response options also apply in accordance with normal CoAP procedures. |
||||
C.2.1.2.3 Resource: Individual VAL Group Document
C.2.1.2.3.1 Description
The Individual VAL Group Document resource represents an individual group document that is created at the SGM-S.
C.2.1.2.3.2 Resource Definition
Resource URI: {apiRoot}/su-gm/<apiVersion>/group-documents/{groupDocId}
This resource shall support the resource URI variables defined in the table C.2.1.2.3.2-1.
Table C.2.1.2.3.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause C.1.1 of 3GPP TS 24.546 [23] |
|
apiVersion |
string |
See clause C.2.1.1 |
|
groupDocId |
string |
Represents an individual group document resource. |
C.2.1.2.3.3 Resource Standard Methods
C.2.1.2.3.3.1 GET
This operation retrieves VAL group information satisfying filter criteria.
This method shall support the URI query parameters specified in table C.2.1.2.3.3.1-1.
Table C.2.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
group-members |
boolean |
O |
0..1 |
This is a content filtering flag. When set to "true", it indicates to the SGM-S to include the members list information of the VAL group. Set to "false" or omitted otherwise. |
|
group-member-details |
boolean |
O |
0..1 |
This is a content filtering flag. When set to "true", it indicates to the SGM-S to include the details of all the members of the VAL group. Set to "false" or omitted otherwise. |
|
group-configuration |
boolean |
O |
0..1 |
This is a content filtering flag. When set to "true", it indicates to the SGM-S to include the configuration information of the VAL group. Set to "false" or omitted otherwise. |
This method shall support the request options specified in table C.2.1.2.3.3.1-2, the response data structures and response codes specified in table C.2.1.2.3.3.1-3, and the response options specified in table C.2.1.2.3.3.1-4.
Table C.2.1.2.3.3.1-2: Options supported by the GET Request on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
When set to 0 (Register) it extends the GET request to subscribe to the changes of this resource. When set to 1 (Deregister) it cancels the subscription. |
|
NOTE: Other request options also apply in accordance with normal CoAP procedures. |
||||
Table C.2.1.2.3.3.1-3: Data structures supported by the GET Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
VALGroupDocument |
M |
1 |
2.05 Content |
The VAL group information based on the request from the VAL server. This response shall include VAL group members list if group-members flag is set to "true" in the request, VAL group member details if group-member-details flag is set to "true" in the request, VAL group configuration information if the group-configuration flag is set to "true" in the request, VAL group identifier, the whole VAL group document resource if all the flags are omitted/set to "false" in the request. |
|
NOTE: The mandatory CoAP error status codes for the GET method listed in table C.1.3-1 of 3GPP TS 24.546 [23] also apply. |
||||
Table C.2.1.2.3.3.1-4: Options supported by the 2.05 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
Sequence number of the notification. |
|
NOTE: Other response options also apply in accordance with normal CoAP procedures. |
||||
C.2.1.2.3.3.2 PUT
This operation updates the VAL group document.
This method shall support the request data structures specified in table C.2.1.2.3.3.2-1 and the response data structures and response codes specified in table C.2.1.2.3.3.2-2.
Table C.2.1.2.3.3.2-1: Data structures supported by the PUT Request payload on this resource
|
Data type |
P |
Cardinality |
Description |
|
VALGroupDocument |
M |
1 |
Updated details of the VAL group document. |
Table C.2.1.2.3.3.2-2: Data structures supported by the PUT Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
VALGroupDocument |
O |
0..1 |
2.04 Changed |
The VAL group document updated successfully, and the updated VAL group document may be returned in the response. |
|
NOTE: The mandatory CoAP error status codes for the PUT method listed in table C.1.3-1 of 3GPP TS 24.546 [23] shall also apply. |
||||
C.2.1.2.3.3.3 DELETE
This operation deletes the VAL group document.
This method shall support the response data structures and response codes specified in table C.2.1.2.3.3.3-1.
Table C.2.1.2.3.3.3-1: Data structures supported by the DELETE Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
2.02 Deleted |
The individual VAL group document matching the groupDocId is deleted. |
||
|
NOTE: The mandatory CoAP error status codes for the DELETE method listed in table C.1.3-1 1 of 3GPP TS 24.546 [23] shall also apply. |
||||
C.2.1.2.4 Resource: Individual VAL Group Member
C.2.1.2.4.1 Description
The Individual VAL Group Member resource represents an individual group member information that is maintained at the SGM-S.
C.2.1.2.4.2 Resource Definition
Resource URI: {apiRoot}/su-gm/<apiVersion>/group-documents/{groupDocId}/members/{memberId}
This resource shall support the resource URI variables defined in the table C.2.1.2.4.2-1.
Table C.2.1.2.3.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause C.1.1 of 3GPP TS 24.546 [23] |
|
apiVersion |
string |
See clause C.2.1.1 |
|
groupDocId |
string |
Represents an individual group document resource. |
|
memberId |
ValTargetUe |
Identifies an individual VAL group member. |
C.2.1.2.4.3 Resource Standard Methods
C.2.1.2.4.3.1 GET
This operation retrieves the individual VAL group member’s information.
This method shall support the request options specified in table C.2.1.2.4.3.1-1, the response data structures and response codes specified in table C.2.1.2.4.3.1-2, and the response options specified in table C.2.1.2.4.3.1-3.
Table C.2.1.2.4.3.1-1: Options supported by the GET Request on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
When set to 0 (Register) it extends the GET request to subscribe to the changes of this resource. When set to 1 (Deregister) it cancels the subscription |
|
NOTE: Other request options also apply in accordance with normal CoAP procedures. |
||||
Table C.2.1.2.4.3.1-2: Data structures supported by the GET Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
GroupMember |
M |
1 |
2.05 Content |
The VAL group member information. |
|
NOTE: The mandatory CoAP error status codes for the GET method listed in table C.1.3-1 of 3GPP TS 24.546 [23] also apply. |
||||
Table C.2.1.2.4.3.1-4: Options supported by the 2.05 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
Sequence number of the notification |
|
NOTE: Other response options also apply in accordance with normal CoAP procedures. |
||||
C.2.1.2.4.3.2 PUT
This operation creates or updates the VAL group member information.
This method shall support the request data structures specified in table C.2.1.2.4.3.2-1 and the response data structures and response codes specified in table C.2.1.2.4.3.2-2.
Table C.2.1.2.4.3.2-1: Data structures supported by the PUT Request payload on this resource
|
Data type |
P |
Cardinality |
Description |
|
GroupMember |
M |
1 |
New or updated details of the VAL group member. |
Table C.2.1.2.4.3.2-2: Data structures supported by the PUT Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
GroupMember |
O |
0..1 |
2.01 Created |
The VAL group member resource was created successfully, and the created resource may be returned in the response. |
|
GroupMember |
O |
0..1 |
2.04 Changed |
The VAL group member resource was updated successfully, and the updated resource may be returned in the response. |
|
NOTE: The mandatory CoAP error status codes for the PUT method listed in table C.1.3-1 of 3GPP TS 24.546 [23] shall also apply. |
||||
C.2.1.2.4.3.3 DELETE
This operation deletes the VAL group member information.
This method shall support the response data structures and response codes specified in table C.2.1.2.4.3.3-1.
Table C.2.1.2.4.3.3-1: Data structures supported by the DELETE Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
2.02 Deleted |
The VAL group member resource matching the groupDocId and memberId is deleted. |
||
|
NOTE: The mandatory CoAP error status codes for the DELETE method listed in table C.1.3-1 1 of 3GPP TS 24.546 [23] shall also apply. |
||||
C.2.1.3 Data Model
C.2.1.3.1 General
This clause specifies the application data model supported by the API. Data types listed in clause C.1.X of TS 24.546 [23] apply to this API.
Table C.2.1.3.1-1 specifies the data types defined specifically for the SU_GroupManagement API service.
Table C.2.1.3.1-1: SU_GroupManagement API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
VALGroupDocument |
C.2.1.3.2.2 |
VAL group document details. |
|
|
GroupCategory |
C.2.1.3.3.3 |
Represents the category of the VAL group. |
|
|
GroupMember |
C.2.1.3.2.3 |
Represents membership and configuration details of the VAL group member. |
|
|
MembershipType |
C.2.1.3.3.2 |
Represents the type of membership of the VAL group member. |
|
|
MembershipState |
C.2.1.3.2.4 |
Represents the state of the member in the group. E.g., an explicit member will register in the group by setting its "registered" attribute to "true", or will set that attribute to "false" when leaving the group. |
|
|
MessageFilter |
C.2.1.3.2.5 |
The message filter information applicable to member VAL UEs or VAL users of the VAL group. |
Table C.2.1.3.1-2 specifies data types re-used by the SU_GroupManagement API service.
Table C.2.1.3.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
ExternalGroupId |
3GPP TS 24.546 [23] |
External group identifier. |
|
|
ScheduledCommunicationTime |
3GPP TS 24.546 [23] |
Represents a scheduled communication time. |
|
|
Uri |
3GPP TS 24.546 [23] |
Unified resource identifier. |
|
|
ValTargetUe |
3GPP TS 24.546 [23] |
Used to identify either a VAL User or a VAL UE. |
C.2.1.3.2 Structured data types
C.2.1.3.2.1 Introduction
C.2.1.3.2.2 Type: VALGroupDocument
Table C.2.1.3.2.2-1: Definition of type VALGroupDocument
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
valGroupId |
string |
M |
1 |
This is VAL group identity (VAL group ID) as per TS 23.434 [2], which is a unique identifier within the VAL service that represents a VAL group, set of VAL users or VAL UEs according to the VAL service. |
|
|
category |
GroupCategory |
M |
1 |
Indicates the category of the group, e.g. "NORMAL" or "LOCATION_BASED". |
|
|
groupName |
string |
O |
0..1 |
A human readable name of the VAL group. |
|
|
grpDesc |
string |
O |
0..1 |
Text description of the VAL group. |
|
|
members |
array(ValTrgetUe) |
O |
1..N |
List of VAL User IDs or VAL UE IDs, which are members of the VAL group. |
|
|
memberDetails |
array(GroupMember) |
O |
1..N |
List of detailed member information for each member of the VAL group. |
|
|
valGrpConf |
string |
O |
0..1 |
Configuration data for the VAL group, provided by the VAL client. |
|
|
inclValGroupIds |
array(string) |
O |
1..N |
List of VAL group IDs constituting the VAL group. |
|
|
valServiceIds |
array(string) |
O |
1..N |
List of VAL services whose communications are enabled on the group. |
|
|
resUri |
Uri |
O |
0..1 |
The URI for individual VAL group document resource. (NOTE) |
|
|
extGrpId |
ExternalGroupId |
O |
0..1 |
The external group identifier, identifying the member UEs of the VAL group at the 3GPP core network. |
|
|
com5GLanType |
Com5GLanType |
O |
0..1 |
Identifies the 5G LAN-Type communication. |
|
|
geoIds |
array(GeographicalAreaId) |
O |
1..N |
List of geographical area ids addressed by the VAL group. |
|
|
priority |
GroupPriority |
O |
0..1 |
Indicates VAL group priority among different VAL groups within VAL service. |
|
|
NOTE: The "resUri" attribute is set by the SGM-S and is not modifiable by the SGM-C. |
|||||
C.2.1.3.2.3 Type: GroupMember
Table C.2.1.3.2.3-1: Definition of type GroupMember
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
memberId |
ValTargetUe |
M |
1 |
This is a VAL group member identity (VAL user ID or VAL UE ID) as per TS 23.434 [2]. |
|
|
membershipType |
MembershipType |
M |
1 |
Indicates the type of membership applicable for the group member, e.g. "ADMINISTRATOR", "EXPLICIT" or "IMPLICIT". |
|
|
membershipState |
MembershipTState |
O |
0..1 |
Indicates the current state of the member in the group, e.g. it may indicate that an "EXPLICIT" member is registered (joined) the group. When absent the state is unknown. |
|
|
messageFilter |
MessageFilter |
O |
0..1 |
The message filter applicable to traffic sent to the group member in the context of the group. |
|
|
memberConfig |
string |
O |
0..1 |
VAL service specific configuration. |
|
|
resUri |
Uri |
O |
0..1 |
The URI for individual VAL group member resource. (NOTE) |
|
|
NOTE: The "resUri" attribute is set by the SGM-S and is not modifiable by the SGM-C. |
|||||
C.2.1.3.2.4 Type: MembershipState
Table C.2.1.3.2.3-1: Definition of type MembershipState
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
registered |
boolean |
O |
0..1 |
Indicates if the member is registered in the group. It is set to "true" that an "EXPLICIT" member is registered (joined) the group. When absent or "false" the member is not unregistered. |
|
|
NOTE: TBD |
|||||
C.2.1.3.2.5 Type: MessageFilter
Table C.2.1.3.2.5-1: Definition of type MessageFilter
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tgtUe |
array(ValTargetUe) |
O |
1..N |
List of VAL USER or UE IDs whose messages will be sent to the owner of this message filter (VAL User or VAL UE). |
|
|
maxMsgs |
Uinteger |
O |
0..1 |
Total number of messages allowed to be sent to the owner of this message filter in the given time frame defined in the filter. |
|
|
scheds |
array(ScheduledCommunicationTime) |
O |
1..N |
Time frame associated to the total number of messages in maxMsgs attribute. |
|
|
msgTypes |
array(string) |
O |
1..N |
List of message types allowed to be sent to the owner of this message filter. Message types may be VAL service specific and are not defined by this specification. |
C.2.1.3.3 Simple data types and enumerations
C.2.1.3.3.1 Simple data types
Table C.2.1.3.3.1-1 Simple data types
|
Type name |
Description |
|
GeographicalAreaId |
String identifying a geographical area. |
|
GroupPriority |
Integer between and including 0 and 255 which provides VAL group priority among different VAL groups within VAL service. |
C.2.1.3.3.2 Enumeration: MembershipType
Table C.2.1.3.3.2-1: Enumeration MembershipType
|
Enumeration value |
Description |
Applicability |
|
ADMINISTRATOR |
This type of group membership indicates that the group member is an administrator of the group and has special authorities as defined by VAL service to manage the group. The administrator is not required to perform explicit registration to join the group. |
|
|
EXPLICIT |
This type of group membership indicates that the group member is an explicit member who is not an administrator of the group and who is required to perform explicit registration to join the group. |
|
|
IMPLICIT |
This type of group membership indicates that the group member is an implicit member who is not an administrator of the group and who is not required to perform explicit registration to join the group. |
C.2.1.3.3.3 Enumeration: GroupCategory
Table C.2.1.3.3.3-1: Enumeration GroupCategory
|
Enumeration value |
Description |
Applicability |
|
NORMAL |
Indicates a "normal" group category. |
|
|
LOCATION_BASED |
Indicates a "location based" group category. |
|
|
REGROUP |
Indicates a "regroup" group category. |
|
|
TEMPORARY |
Indicates a "temporary" group category. |
C.2.1.3.3.4 Enumeration: Com5GLanType
Table C.2.1.3.3.4-1: Enumeration Com5GLanType
|
Enumeration value |
Description |
Applicability |
|
IPV4 |
IPv4 |
|
|
IPV6 |
IPv6 |
|
|
IPV4V6 |
IPv4 and IPv6 |
|
|
ETHERNET |
Ethernet |
C.2.1.4 Error Handling
General error responses are defined in clause C.1.3 of 3GPP TS 24.546 [23].
C.2.1.5 CDDL Specification
C.2.1.5.1 Introduction
The data model described in clause C.2.1.3 shall be binary encoded in the CBOR format as described in IETF RFC 8949 [19].
Clause C.2.1.5.2 uses the Concise Data Definition Language described in IETF RFC 8610 [21] and provides corresponding representation of the SU_GroupManagement API data model.
C.2.1.5.2 CDDL document
;;; VALGroupDocument
;;+ Represents details of the VAL group document information.
VALGroupDocument = {
valGroupId: text ; The VAL group idenitity.
category: GroupCategory
? groupName: text ; A human readable name of the VAL group.
? grpDesc: text ; The text description of the VAL group.
? members: [+ ValTargetUe] ; The list of VAL User IDs or VAL UE IDs, which are members of the VAL group.
? memberDetails: [+ GroupMember]; The list of detailed information of members of the VAL group.
? valGrpConf: text ; Configuration data for the VAL group.
? inclValGroupIds: [+ text] ; The list of VAL group IDs constituting the VAL group.
? valServiceIds: [+ text] ; The list of VAL services enabled on the group.
? resUri: Uri
? extGrpId: ExternalGroupId
? com5GLanType: Com5GLanType
? geoIds: [+ GeographicalAreaId]; The list of geographical area ids addressed by the VAL group.
? priority: GroupPriority
}
;;; GroupCategory
;;+ The category of the VAL group.
GroupCategory = "NORMAL" / "LOCATION_BASED" / "REGROUP" / "TEMPORARY" / text ; text value provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
;;; GroupMember
;;+ Represents details of the VAL group member.
GroupMember = {
memberId: ValTargetUe ; Identifies the member of the VAL group. Once set, this information cannot be updated.
membershipType: MembershipType
? membershipState: MembershipState
? messageFilter: MessageFilter
? memberConfig: text
? resUri: Uri
}
;;; GroupPriority
;;+ VAL group priority a positive integer which provides VAL group priority among different VAL groups within VAL service.
GroupPriority = 0..255
;;; GeographicalAreaId
;;+ Identifies a geographical area.
GeographicalAreaId = text
;;; MembershipType
;;+ Indicates the type of group membership.
MembershipType = "ADMINISTRATOR" / "EXPLICIT" / "IMPLICIT" / text ; text value provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
;;; MembershipState
;;+ Represents the state of the member in the group.
MembershipState = {
? registered: bool
}
;;; MessageFilter
;;+ Represents the message filters applicable to a VAL User ID or VAL UE ID.
MessageFilter = {
? tgtUe: [+ ValTargetUe] ; List of VAL User or UE IDs whose message to be sent.
? maxMsgs: Uinteger
? scheds: [+ ScheduledCommunicationTime]; Time frame associated with total number of messages.
? msgTypes: [+ text] ; List of message types to be sent to VAL UE.
}
;;; ScheduledCommunicationTime
;;+ Represents an offered scheduled communication time.
ScheduledCommunicationTime = {
? daysOfWeek: [1*6 DayOfWeek] ; Identifies the day(s) of the week. If absent, it indicates every day of the week.
? timeOfDayStart: TimeOfDay
? timeOfDayEnd: TimeOfDay
}
;;; ValTargetUe
;;+ Represents information identifying a VAL user ID or a VAL UE ID.
ValTargetUe = {
(
valUserId: text ; Unique identifier of a VAL user.
//
valUeId: text ; Unique identifier of a VAL UE.
)
}
;;; ExternalGroupId
;;+ string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 for more information.
ExternalGroupId = text
;;; Com5GLanType
;;+ Communication type for a 5GVN-based group communication
Com5GLanType = "IPV4" / "IPV6" / "IPV4V6" / "ETHERNET" / text
;;; DayOfWeek
;;+ integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, and the subsequent weekdays shall be indicated with the next higher numbers. 7 shall indicate Sunday.
DayOfWeek = 1..7
;;; TimeOfDay
;;+ String with format partial-time or full-time as defined in subclause 5.6 of IETF RFC 3339. Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC).
TimeOfDay = text
;;; Uinteger
;;+ Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.
Uinteger = int .ge 0
;;; Uri
;;+ string providing an URI formatted according to IETF RFC 3986.
Uri = text
C.2.1.6 Media Type
The media type for a VAL group document shall be "application/vnd.3gpp.seal-group-doc+cbor".
The media type for a VAL group member information shall be "application/vnd.3gpp.seal-group-member-info+cbor".
Editor’s Note: It is possible to specify other payload format for CoAP than CBOR, and the details about other payload format is FFS.
C.2.1.7 Media Type registration for application/vnd.3gpp.seal-group-doc+cbor
Type name: application
Subtype name: vnd.3gpp.seal-group-doc+cbor
Required parameters: none
Optional parameters: none
Encoding considerations: Must be encoded as using IETF RFC 8949 [17]. See "VALGroupDocument" data type in 3GPP TS 24.544 clause C.2.1.3.2.2 for details.
Security considerations: See Section 10 of IETF RFC 8949 [17] and Section 11 of IETF RFC 7252 [12].
Interoperability considerations: Applications must ignore any key-value pairs that they do not understand. This allows backwards-compatible extensions to this specification.
Published specification: 3GPP TS 24.544 "Group Management – Service Enabler Architecture Layer for Verticals (SEAL); Protocol specification", available via http://www.3gpp.org/specs/numbering.htm.
Applications that use this media type: Applications supporting the SEAL group management procedures as described in the published specification.
Fragment identifier considerations: Fragment identification is the same as specified for "application/cbor" media type in IETF RFC 8949 [17]. Note that currently that RFC does not define fragmentation identification syntax for "application/cbor".
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): none
Macintosh file type code(s): none
Person & email address to contact for further information: <MCC name>, <MCC email address>
Intended usage: COMMON
Restrictions on usage: None
Author: 3GPP CT1 Working Group/3GPP_TSG_CT_WG1@LIST.ETSI.ORG
Change controller: <MCC name>/<MCC email address>
C.2.1.8 Media Type registration for application/vnd.3gpp.seal-group-member-info+cbor
Type name: application
Subtype name: vnd.3gpp.seal-group-member-info+cbor
Required parameters: none
Optional parameters: none
Encoding considerations: Must be encoded as using IETF RFC 8949 [17]. See "GroupMember" data type in 3GPP TS 24.544 clause C.2.1.3.2.3 for details.
Security considerations: See Section 10 of IETF RFC 8949 [17]and Section 11 of IETF RFC 7252 [12].
Interoperability considerations: Applications must ignore any key-value pairs that they do not understand. This allows backwards-compatible extensions to this specification.
Published specification: 3GPP TS 24.544 "Group Management – Service Enabler Architecture Layer for Verticals (SEAL); Protocol specification", available via http://www.3gpp.org/specs/numbering.htm.
Applications that use this media type: Applications supporting the SEAL group management procedures as described in the published specification.
Fragment identifier considerations: Fragment identification is the same as specified for "application/cbor" media type in IETF RFC 8949 [17]. Note that currently that RFC does not define fragmentation identification syntax for "application/cbor".
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): none
Macintosh file type code(s): none
Person & email address to contact for further information: <MCC name>, <MCC email address>
Intended usage: COMMON
Restrictions on usage: None
Author: 3GPP CT1 Working Group/3GPP_TSG_CT_WG1@LIST.ETSI.ORG
Change controller: <MCC name>/<MCC email address>
Annex D (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-09 |
CT1#120 |
C1-196115 |
Draft skeleton provided by the rapporteur. |
0.0.0 |
|||
|
2019-10 |
CT1#120 |
Implementing the following p-CR agreed by CT1: C1-196603, C1-196605, C1-196851, C1-196852 |
0.1.0 |
||||
|
2019-11 |
CT1#121 |
Implementing the following p-CR agreed by CT1: C1-198615, C1-198811, C1-198812, C1-198813, C1-198814 |
0.2.0 |
||||
|
2019-12 |
CT-86 |
CP-193152 |
Presentation for information at TSG CT |
1.0.0 |
|||
|
2020-03 |
CT1#122-e |
Implementing the following p-CR agreed by CT1: C1-201004, C1-200634, C1-200635, C1-200636, C1-200637, C1-200887, C1-200888, C1-200640, C1-200884, C1-200885, C1-200822, C1-200644 |
1.1.0 |
||||
|
2020-03 |
CT-87e |
CP-200168 |
Presentation for approval at TSG CT |
2.0.0 |
|||
|
2020-03 |
CT-87e |
Version 16.0.0 created after approval |
16.0.0 |
||||
|
2020-06 |
CT-88e |
CP-201129 |
0001 |
B |
SIP based subscribe/notify procedures for SEAL group management |
16.1.0 |
|
|
2020-06 |
CT-88e |
CP-201129 |
0002 |
1 |
F |
Removal of Editor’s notes |
16.1.0 |
|
2020-06 |
CT-88e |
CP-201129 |
0003 |
F |
Indication from SGM-S to SGM-C about group join required |
16.1.0 |
|
|
2020-06 |
CT-88e |
CP-201129 |
0004 |
F |
Corrections in HTTP request-uri value |
16.1.0 |
|
|
2020-06 |
CT-88e |
CP-201129 |
0005 |
1 |
B |
Adding IANA registration template for SEAL group document |
16.1.0 |
|
2020-06 |
CT-88e |
CP-201129 |
0006 |
F |
Adding VAL user id in subscription parameter |
16.1.0 |
|
|
2020-09 |
CT-89e |
CP-202163 |
0007 |
D |
Removing Heading level-7 as per drafting rules |
16.2.0 |
|
|
2020-12 |
CT-90e |
CP-203210 |
0009 |
F |
Corrections to group creation procedure |
16.3.0 |
|
|
2020-12 |
CT-90e |
CP-203210 |
0010 |
2 |
F |
Adding Identity List notification and corrections to group announcement procedure |
16.3.0 |
|
2020-12 |
CT-90e |
CP-203210 |
0011 |
F |
Corrections to group modification procedure |
16.3.0 |
|
|
2020-12 |
CT-90e |
CP-203210 |
0012 |
1 |
F |
Updates to configure VAL group request |
16.3.0 |
|
2021-09 |
CT-93e |
CP-212138 |
0013 |
1 |
C |
Enhancement to add VAL service specific information |
17.0.0 |
|
2021-09 |
CT-93e |
CP-212138 |
0014 |
1 |
C |
Enable 5G CN capabilities for SEAL groups |
17.0.0 |
|
2021-09 |
CT-93e |
CP-212138 |
0015 |
1 |
C |
Group management enhancements to add message filters |
17.0.0 |
|
2021-09 |
CT-93e |
CP-212138 |
0016 |
1 |
B |
Group list fetch procedure |
17.0.0 |
|
2021-09 |
CT-93e |
CP-212118 |
0018 |
1 |
A |
Corrections to group modify notification |
17.0.0 |
|
2021-12 |
CT-94e |
CP-213052 |
0019 |
1 |
C |
Group management support for 5G-VN groups |
17.1.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0020 |
– |
F |
Group management boot up procedure and fix in group list fetch procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0021 |
1 |
B |
Client side of temporary groups procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0022 |
1 |
B |
Server side of temporary groups procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0023 |
– |
B |
Addition of functional entity requirements for CoAP support |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0024 |
– |
B |
Authenticated identity in CoAP request |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0025 |
– |
B |
Addition of CoAP Group creation procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0026 |
– |
B |
Addition of CoAP Group information query procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0027 |
– |
B |
Addition of CoAP Group membership procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0028 |
– |
B |
Addition of CoAP Group configuration management procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0029 |
– |
B |
Addition of CoAP Location-based group creation procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0030 |
– |
B |
Addition of CoAP Group subscription and notification procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0031 |
– |
B |
Addition of CoAP Group member leave procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0032 |
1 |
B |
Addition of CoAP Group list fetch procedure |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0033 |
– |
B |
Addition of CoAP resource representation and encoding |
17.2.0 |
|
2022-03 |
CT-95e |
CP-220255 |
0045 |
– |
B |
Addition of CoAP Group announcement and join procedure |
17.2.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0046 |
– |
F |
Minor corrections |
17.3.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0047 |
1 |
B |
Addition of CoAP Update group configuration procedures |
17.3.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0048 |
– |
B |
Addition of CoAP Location-based group creation procedures |
17.3.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0049 |
– |
B |
Addition of CoAP Group announcement and join procedures |
17.3.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0050 |
– |
B |
Addition of CoAP Temporary groups procedures |
17.3.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0052 |
2 |
F |
Missing references to authenticated identity in CoAP request |
17.4.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0053 |
2 |
F |
Update reference in group registration and temporary group creation procedures |
17.4.0 |