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

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

PATCH

Partially update an individual VAL group’s membership and configuration information identified by {groupDocId}

DELETE

Deletes an individual VAL group’s membership and configuration information identified by {groupDocId}.

apiRoot

string

See clause 6.5

n/a

VALGroupDocument

M

1

Details of the VAL group that needs to be created,

VALGroupDocument

M

1

201 Created

VAL group created successfully.

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

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-gm/<apiVersion>/group-documents/{groupDocId}

val-group-id

string

O

0..1

String identifying the VAL group.

val-service-id

string

O

0..1

String identifying the VAL service.

n/a

array(VALGroupDocument)

M

0..N

200 OK

List of VAL group documents. This response shall include VAL group documents matching the query parameters provided in the request.

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

apiRoot

string

See clause 6.5

groupDocId

string

Represents an individual group document resource.

group-members

boolean

O

0..1

When set to ‘true’, it indicates the group management server to send the members list information of the VAL group. Set to false or omitted otherwise.

group-configuration

boolean

O

0..1

When set to ‘true’, it indicates the group management server to send the configuration information of the VAL group. Set to false or omitted otherwise.

n/a

VALGroupDocument

M

1

200 OK

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 configuration information if the group-configuration flag is set to true in the request, VAL group identifier, whole VAL group document resource if both group-members and group-configuration flags are omitted/set to false in the request.

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

n/a

VALGroupDocument

M

1

Updated details of the VAL group document.

VALGroupDocument

M

1

200 OK

The VAL group document updated successfully and the updated VAL group document returned in the response.

n/a

204 No Content

The VAL group document updated successfully.

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

n/a

n/a

n/a

204 No Content

The individual VAL group document matching the groupDocId is deleted.

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

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 group management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

Location

string

M

1

An alternative URI of the resource located in an alternative group management server.

n/a

VALGroupDocumentPatch

M

1

Contains the modifications to be applied to the Individual VAL Group Document resource.

VALGroupDocument

M

1

200 OK

Individual VAL Group Document resource is modified successfully and representation of the modified VAL Group Document resource is returned.

n/a

204 No Content

The Individual VAL Group Document resource is updated successfully.

n/a

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SEAL server.

Location

string

M

1

An alternative URI of the resource located in an alternative SEAL server.

VALGroupDocument

7.2.1.4.2.2

Represents details of the VAL group document information.

VALGroupDocumentPatch

7.2.1.4.2.3

Represent details of the partial update of VAL group document information.

PatchUpdate

ExternalGroupId

3GPP TS 29.122 [3]

Used to represent the the external group identifier related to the member UEs of the group.

LocationArea5G

3GPP TS 29.122 [3]

Represents location information.

LocationInfo

3GPP TS 29.122 [3]

The location information related to VAL group.

PduSessionType

3GPP TS 29.571 [21]

Identifies PDU Session Type.

SupportedFeatures

3GPP TS 29.571 [21]

Used to negotiate the applicability of optional features defined in table 7.2.1.6-1.

ValTargetUe

Clause 7.3.1.4.2.3

Used to indicate either VAL User ID or VAL UE ID, to which location reporting applies.

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.

grpDesc

string

O

0..1

Text description of the VAL group.

members

array(ValTargetUe)

O

1..N

List of VAL User IDs or VAL UE IDs, which are members of the VAL group.

valGrpConf

string

O

0..1

Configuration data for the VAL group.

Shall be present in HTTP POST request message from VAL server to Group Management server.

valServiceIds

array(string)

O

1..N

List of VAL services whose communications enabled on the group.

suppFeat

SupportedFeatures

O

0..1

Used to negotiate the supported optional features of the API as described in clause 6.8.

This attribute shall be provided in the HTTP POST request and in the response of successful resource creation.

resUri

Uri

O

0..1

The URI for individual VAL group document resource. (NOTE 1)

locInfo

LocationInfo

O

0..1

The location information related to the VAL group. This information is used to determine the members of the group.

addLocInfo

LocationArea5G

O

0..1

The additional location information related to the VAL group. This information is used to determing the members of the group.

extGrpId

ExternalGroupId

O

0..1

The external group identifier, identifying the member UEs of the VAL group at the 3GPP core network.

com5GLanType

PduSessionType

O

0..1

Identifies the 5G LAN-Type communication. (NOTE 2)

valSvcInf

string

O

0..1

VAL service specific information that may be present during group membership update and in the notification of the events "GM_GROUP_INFO_CHANGE" and "GM_GROUP_CREATE".

NOTE 1: The "resUri" attribute is not modifiable by the VAL server.

NOTE 2: The enumeration value "UNSTRUCTURED" in data type "PduSessionType" is not applicable.

grpDesc

string

O

0..1

Text description of the VAL group.

members

array(ValTargetUe)

O

1..N

List of VAL User IDs or VAL UE IDs, which are members of the VAL group.

valGrpConf

string

O

0..1

Configuration data for the VAL group.

valServiceIds

array(string)

O

1..N

List of VAL services whose communications enabled on the group.

locInfo

LocationInfo

O

0..1

The location information related to the VAL group. This information is used to determine the members of the group.

addLocInfo

LocationArea5G

O

0..1

The additional location information related to the VAL group. This information is used to determining the members of the group.

extGrpId

ExternalGroupId

O

0..1

The external group identifier, identifying the member UEs of the VAL group at the 3GPP core network.

com5GLanType

PduSessionType

O

0..1

Identifies the 5G LAN-Type communication. (NOTE 1)

NOTE 1: The enumeration value "UNSTRUCTURED" in data type "PduSessionType" is not applicable.

1

PatchUpdate

Indicates the support of the PATCH method for updating an Individual VAL Group Document resource.