SEAL Events Subscriptions

/subscriptions

POST

Creates a new individual SEAL Event Subscription.

Individual SEAL Events Subscription

/subscriptions/{subscriptionId}

DELETE

Deletes an individual SEAL Event Subscription identified by the subscriptionId.

PATCH

Modifies an individual SEAL Event subscription identified by the subscriptionId.

PUT

Updates an individual SEAL Event subscription identified by the subscriptionId.

apiRoot

string

See clause 6.5

n/a

SEALEventSubscription

M

1

Create a new individual SEAL Events Subscription resource.

SEALEventSubscription

M

1

201 Created

SEAL Events Subscription resource 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-events/<apiVersion>/subscriptions/{subscriptionId}

apiRoot

string

See clause 6.5

subscriptionId

string

Identifies an Individual Events Subscription

n/a

n/a

n/a

204 No Content

The individual SEAL Events Subscription matching the subscriptionId 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 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 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 SEAL server.

Location

string

M

1

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

n/a

SEALEventSubscriptionPatch

M

1

Contains the modifications to be applied to the SEAL Event subscription resource.

SEALEventSubscription

M

1

200 OK

SEAL Events Subscription resource is modified successfully and representation of the modified SEAL Event subscription is returned.

n/a

204 No Content

The SEAL Events Subscription 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.

n/a

SEALEventSubscription

M

1

Contains the SEAL Event subscription to be updated.

SEALEventSubscription

M

1

200 OK

SEAL Event Subscription resource is updated successfully and representation of the modified SEAL Event subscription is returned.

n/a

204 No Content

The SEAL Events Subscription 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.

SEAL Event Notification

{notificationDestination}

POST

Notifies subscriber of a SEAL Event

n/a

SEALEventNotification

M

1

Notification information of a SEAL Event

n/a

204 No Content

The receipt of the Notification is acknowledged.

n/a

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 notification destination where the notification should be sent.

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

n/a

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 notification destination where the notification should be sent.

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

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

An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected.

EventSubscription

7.5.1.4.2.4

Represents the subscription to a single SEAL event.

IdentityFilter

7.5.1.4.2.7

Represents a filter of VAL User / UE identities belonging to a VAL service.

LMInformation

7.5.1.4.2.8

The location information for a VAL User ID or a VAL UE ID.

LocationAreaMonReport

7.5.1.4.2.20

Represents the event report to notify the VAL UEs moving in or moving out from a given location.

LocationDevMonReport

7.5.1.4.2.15

Represents the event report to notify the VAL UE/User’s location deviation from a given location.

LocationInfoCriteria

7.5.1.4.2.18

Represents the location information to be monitored.

It includes the geographic location information or a reference UE along with the application defined proximity range from the reference UE.

LocDevNotification

7.5.1.4.3.4

Enumeration of location deviation notification reports.

MessageFilter

7.5.1.4.2.9

The message filter information applicable to member VAL UEs or Users of the VAL group in the group change notification.

MonitorEvents

7.5.1.4.2.11

Represents the details of the monitoring and analytics events.

NRM_EventMonitor

MonitorEventsReport

7.5.1.4.2.12

Represents the monitoring and analytics events information related to VAL UE or User.

NRM_EventMonitor

MonitorFilter

7.5.1.4.2.10

Represents the filter information VAL User or UEs and the related events to be monitored.

NRM_EventMonitor

MonitorLocationInterestFilter

7.5.1.4.2.14

Filter information to subscribe for monitoring the VAL UE/User location in a given area of interest.

MonLocAreaInterestFltr

7.5.1.4.2.17

Filter information to subscribe for location area monitoring information for a given area of interest.

MonLocTriggerEvent

7.5.1.4.3.5

Identifies the triggering event in the location area monitor filtering.

MoveInOutUEDetails

7.5.1.4.2.21

Represents the list of UEs either moved into the location area or moved out of the location area.

ReferenceUEDetail

7.5.1.4.2.19

Represents the reference UE details

SEALEvent

7.5.1.4.3.3

Represents the type of SEAL events that can be subscribed.

SEALEventDetail

7.5.1.4.2.5

Represents the SEAL event detail.

SEALEventNotification

7.5.1.4.2.3

Represents an individual SEAL Event Subscription Notification.

SEALEventSubscription

7.5.1.4.2.2

Represents an individual SEAL Event Subscription resource.

SEALEventSubscriptionPatch

7.5.1.4.2.22

Represents the parameters to request the modification of a SEAL Event subscription resource.

SubscUpdate

TempGroupInfo

7.5.1.4.2.16

Represents the created temporary VAL group information.

GM_TempGroup

VALGroupFilter

7.5.1.4.2.6

Represents a filter of VAL group identifiers belonging to a VAL service.

ValidityConditions

7.5.1.4.2.13

Represents the temporal and/or spatial conditions applied for the events to be monitored.

NRM_EventMonitor

AnalyticsEvent

3GPP TS 29.522 [28]

Analytics event in NWDAF.

NRM_EventMonitor

DateTime

3GPP TS 29.571 [21]

Used to indicate a timestamp.

DurationSec

3GPP TS 29.571 [21]

Used to indicate the notification interval in the location monitoring filter.

Float

3GPP TS 29.571 [21]

Used to represent the fractional part of the proximity range in the reference UE details.

GeographicArea

3GPP TS 29.572 [31]

Identifies the geographical information of the user(s).

LocationArea5G

3GPP TS 29.122 [3]

User location area when the UE is attached to 5G.

NRM_EventMonitor

LocationInfo

3GPP TS 29.122 [3]

Location information

MonitoringType

3GPP TS 29.122 [3]

Monitoring event type in 3GPP system core network.

NRM_EventMonitor

ProfileDoc

Clause 7.3.1.4.2.2

Used to send VAL User or VAL UE profile information as part of event detail in the event notification.

ReportingInformation

3GPP TS 29.523 [20]

Used to indicate the reporting requirement, only the following information are applicable for SEAL:

– immRep

– notifMethod

– maxReportNbr

– monDur

– repPeriod

ScheduledCommunicationTime

3GPP TS 29.122 [3]

Used to define the time frame for message filters.

SupportedFeatures

3GPP TS 29.571 [21]

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

TestNotification

3GPP TS 29.122 [3]

Following differences apply:

– The SCEF is the SEAL server; and

– The SCS/AS is the subscribing VAL server.

TimeWindow

3GPP TS 29.122 [3]

Time window identified by a start time and a stop time.

NRM_EventMonitor

Uinteger

3GPP TS 29.571 [21]

Used to represent maximum number of messages in MesageFilter data type.

Uri

3GPP TS 29.122 [3]

Used to indicate a notification URI.

VALGroupDocument

Clause 7.2.1.4.2.2

Used to send VAL group document as part of event detail in the event notification.

ValTargetUe

7.3.1.4.2.3

Used to identify a VAL user ID or a VAL UE ID.

WebsockNotifConfig

3GPP TS 29.122 [3]

Following differences apply:

– The SCEF is the CAPIF core function; and

– The SCS/AS is the Subscribing functional entity.

subscriberId

string

M

1

String identifying the subscriber of the event.

eventSubs

array(EventSubscription)

M

1..N

Subscribed events.

eventReq

ReportingInformation

M

1

Represents the reporting requirements of the event subscription.

notificationDestination

Uri

M

1

URI where the notification should be delivered to.

requestTestNotification

boolean

O

0..1

Set to true by Subscriber to request the SEAL server to send a test notification as defined in clause 6.6. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.6.

Notification_websocket

eventDetails

array(SEALEventDetail)

C

1..N

Detailed information of individual Events.

Shall only be present in the response from the server if the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute is set to true, and the reports are available.

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.

subscriptionId

string

M

1

Identifier of the subscription resource to which the notification is related – SEAL resource identifier

eventDetails

array(SEALEventDetail)

M

1..N

Detailed notifications of individual Events.

eventId

SEALEvent

M

1

Subscribed event

valGroups

array(VALGroupFilter)

C

1..N

Each element of the array represents the VAL group identifier(s) of a VAL service that the subscriber wants to know in the interested event.

This parameter shall be present only if the event subscribed is "GM_GROUP_INFO_CHANGE".

GM_GroupInfoChange

Identities

array(IdentityFilter)

C

1..N

Each element of the array represents the VAL User / UE IDs of a VAL service that the event subscriber wants to know in the interested event.

This parameter shall be present only if the event subscribed is "CM_USER_PROFILE_CHANGE" or "LM_LOCATION_INFO_CHANGE". (NOTE)

CM_UserProfileChange, LM_LocationInfoChange

monFltr

array(MonitorFilter)

C

1..N

Each element of the array represents the event monitoring request details that the subscriber wishes to monitor the events related to a set of VAL UEs, VAL group and/or VAL service.

This parameter shall be present only if the event subscribed is "NRM_MONITOR_UE_USER_EVENTS"

NRM_EventMonitor

areaInt

array(MonitorLocationInterestFilter)

C

1..N

Each element represent the list of VAL User / UE IDs and the area of interest information for which the subscriber wishes to monitor the location deviation of the VAL User / UEs.

This parameter shall be present only if the subscribed event is "LM_LOCATION_DEVIATION_MONITOR".

LM_LocationDeviation

locAreaMon

array(MonLocAreaInterestFltr)

C

1..N

Each element represent the location area monitoring details that the subscriber wishes to monitor for the VAL UEs moving in or moving out of the provided location area.

This parameter shall be present only if the subscribed event is "LM_LOCATION_AREA_MONITOR".

LM_LocationAreaMonitor

NOTE: The "valSvcId" attribute within IdentityFilter is not applicable for the event "LM_LOCATION_INFO_CHANGE".

eventId

SEALEvent

M

1

Event that is notified

lmInfos

array(LMInformation)

C

1..N

The location information for the interested VAL User IDs or VAL UE IDs.

This parameter shall be present only if the event in event notification is "LM_LOCATION_INFO_CHANGE".

LM_LocationInfoChange

valGroupDocuments

array(VALGroupDocument)

C

1..N

Newly created VAL group documents or the VAL groups documents with modified membership and configuration information. This parameter shall be present only if the event in event notification is "GM_GROUP_INFO_CHANGE" or "GM_GROUP_CREATE".

GM_GroupInfoChange, GM_GroupCreate

profileDocs

array(ProfileDoc)

C

1..N

Updated profile information associated with VAL Users or VAL UEs.

This parameter shall be present only if the event in event notification is "CM_USER_PROFILE_CHANGE".

CM_UserProfileChange

msgFltrs

array(MessageFilter)

C

1..N

The message filters applicable to various member VAL User or UEs of the VAL group. This parameter may be present only if the event in the even notification is "GM_GROUP_INFO_CHANGE"

GM_MessageFilter

monRep

array(MonitorEventsReport)

C

1..N

The events report with details of the events related to VAL UE(s). This parameter shall be present only if the event in the event notification is "NRM_MONITOR_UE_USER_EVENTS"

NRM_EventMonitor

locAdhr

array(LocationDevMonReport)

C

1..N

The location deviation information for the interested VAL User IDs or VAL UE IDs in a given location.

This parameter shall be present only if the event in event notification is "LM_LOCATION_DEVIATION_MONITOR".

LM_LocationDeviation

tempGroupInfo

TempGroupInfo

C

0..1

Contains the created temporary VAL group information.

This attribute shall be present only if the "eventId" attribute is set to the value "GM_TEMP_GROUP_FORMATION".

GM_TempGroup

locAreaMonRep

array(LocationAreaMonReport)

C

1..N

The location area monitoring information of the given area of interest.

This parameter shall be present only if the event in event notification is "LM_LOCATION_AREA_MONITOR".

LM_LocationAreaMonitor

valSvcId

string

O

0..1

Identity of the VAL Service that the subscriber is interested in.

valGrpIds

array(string)

M

1..N

VAL Group identifiers that the event subscriber wants to know in the interested event.

valSvcId

string

O

0..1

Identity of the VAL Service that the subscriber is interested in.

valTgtUes

array(ValTargetUe)

C

1..N

VAL User IDs or VAL UE IDs that the event subscriber wants to know in the interested event. This parameter shall be present if the event subscribed is "CM_USER_PROFILE_CHANGE" or "LM_LOCATION_INFO_CHANGE".

suppLoc

boolean

O

0..1

Indication to request for supplementary location information of the VAL UE IDs.

Set to true by Subscriber to request the SEAL server to send supplementary location information from the 3GPP core network. Set to false or omitted otherwise.

LM_SuppLoc

valTgtUe

ValTargetUe

M

1

VAL User ID or UE ID that the event subscriber wants to know in the interested event.

locInfo

LocationInfo

M

1

The location information associated with the valTgtUe.

timeStamp

DateTime

O

0..1

Timestamp of the location report

valSvcId

string

O

0..1

The VAL service ID of the VAL application for which the location information is subscribed.

reqUe

ValTargetUe

M

1

Identity of the VAL User ID or UE ID that the message filter information is related to.

tgtUe

array(ValTargetUe)

O

1..N

List of VAL USER or UE IDs whose messages will be sent to the VAL User or UE in reqUe attribute.

maxMsgs

Uinteger

O

0..1

Total number of messages allowed to be sent to the VAL User or UE in the given time frame in the filter.

scheds

array(ScheduledCommunicationTime)

O

1..N

Time frame associated to the total number of messages in mxMsgs attribute.

msgTypes

array(string)

O

1..N

List of message types be sent to VAL UE.

idnts

array(ValTargetUe)

C

1..N

Identities of the VAL Users or UEs whose events monitoring is requested. (NOTE 1)

valSvcId

string

O

0..1

Identity of the VAL service.

valGrpId

string

C

0..1

Identity of the VAL group of the target UEs whose events monitoring is requested. (NOTE 1)

profId

string

C

0..1

The monitoring profile ID identifying a list of monitoring and/or analytics events. (NOTE 2)

valCnds

array(ValidityConditions)

O

1..N

The temporal and/or spatial conditions applied for the events to be considered as valid.

evntDets

array(MonitorEvents)

C

1..N

List of monitoring and/or analytics events that the VAL server is interested in. (NOTE 2)

NOTE 1: Either VAL users/UEs or a VAL group identifying VAL UEs shall be present.

NOTE 2: Either event details or monitoring profile ID shall be present in the subscription request. The monitoring profile ID shall present in the subscription response when event details are provided in the subscription request.

cnEvnts

array(MonitoringType)

O

1..N

List of monitoring events related to VAL UE.

anlEvnts

array(AnalyticsEvent)

O

1..N

List of analytics events related to VAL UE.

tgtUe

ValTargetUe

M

1

VAL UE for which the events are related.

evnts

array(MonitorEvents)

M

1..N

List of monitoring and analytics events related to VAL UE.

locArea

LocationArea5G

O

0..1

Spatial validity conditions.

tmWdws

array(TimeWindow)

O

1..N

Time window validity conditions

tgtUes

array(ValTargetUe)

M

1..N

List of VAL User(s) or UE ID(s) for which location monitoring is requested for the given location information.

locInt

LocationInfo

M

1

Location information where the VAL server wishes to monitor the target VAL UE(s) location deviation.

notInt

DurationSec

M

1

Periodic time interval in which the LM server needs to notify the VAL UE’s location information.

tgtUes

array(ValTargetUe)

M

1..N

VAL User ID(s) or UE ID(s) to which the report is related.

locInfo

LocationInfo

M

1

The location information associated with the valTgtUe.

notifType

LocDevNotification

M

1

Notification about the deviation of the VAL UE(s) in "valTgtUe" attribute to the location in "locInfo" attribute.

valGrpIds

array(string)

M

1..N

Contains a list of the identifiers of the VAL groups constituting the created temporary VAL group.

tempValGrpId

string

M

1

Contains the identifier of the created temporary VAL group.

valServIds

array(string)

O

1..N

Contains a list of the identifiers of the VAL services for which communications are to be enabled on the created temporary VAL group.

locInfoCri

LocationInfoCriteria

M

1

Location area information where the VAL server wishes to monitor the VAL UE(s) moving in or moving out

trigEvnts

array(MonLocTriggerEvent)

O

1..N

Identifies the triggering events when to send the notification.

geoArea

GeographicArea

C

0..1

Geographic location information where the VAL server wishes to monitor the VAL UE(s) moving in or moving out.

refUe

ReferenceUEDetail

C

0..1

Reference UE details with proximity range where the VAL server wishes to monitor the VAL UE(s) moving in or moving out.

NOTE: Either "geoArea" or "refUe" shall be provided.

valTgtUe

ValTargetUe

M

1

VAL User ID or UE ID that the event subscriber wants to know in the interested event.

proxRange

Uinteger

M

1

Proximity range of the area around the VAL target UE in meters. This attribure represents the integer part of the proximity range value.

proxRangeFrac

Float

O

0..1

The fractional part of the proximity range value in meters. The minimum value of this attribute is 0. The maximum value of this attribute is 1.

curPreUEs

array(ValTargetUe)

O

1..N

List of the identities of all VAL UEs who are currently present in the given location area.

moveInOutUEs

MoveInOutUEDetails

O

0..1

List of UEs either moved in to the location area or moved out of the location area.

trigEvnt

MonLocTriggerEvent

O

0..1

Event that triggered the sending of the notification.

NOTE: For first notification report "curPreUEs" shall be provided, for next notification report either "curPreUEs" or "moveInOutUEs" shall be present.

moveInUEs

array(ValTargetUe)

O

1..N

List of the identities of the VAL UEs who moved in to the given location area since previous notification.

moveOutUEs

array(ValTargetUe)

O

1..N

List of the identities of the VAL UEs who moved out of the given location area since previous notification.

eventSubs

array(EventSubscription)

O

1..N

Subscribed events.

eventReq

ReportingInformation

O

0..1

Represents the reporting requirements of the event subscription.

notificationDestination

Uri

O

0..1

URI where the notification should be delivered to.

LM_LOCATION_INFO_CHANGE

Events related to the location information of VAL Users or VAL UEs from the Location Management Server.

LM_LocationInfoChange

GM_GROUP_INFO_CHANGE

Events related to the modification of VAL group membership and configuration information from the Group Management Server.

GM_GroupInfoChange

CM_USER_PROFILE_CHANGE

Events related to update of user profile information from the Configuration Management Server.

CM_UserProfileChange

GM_GROUP_CREATE

Events related to creation of new VAL groups from the Group Management Server.

GM_GroupCreate

NRM_MONITOR_UE_USER_EVENTS

Monitoring and analytic events related to VAL UEs, users or VAL group from the Network Resource Management Server.

NRM_EventMonitor

LM_LOCATION_DEVIATION_MONITOR

Events from Location Management Server, related to the deviation of the VAL User(s) / UE(s) location from an area of interest.

LM_LocationDeviation

GM_TEMP_GROUP_FORMATION

Events related to the formation of new temporary VAL groups from the Group Management Server.

GM_TempGroup

LM_LOCATION_AREA_MONITOR

Events from Location Management Server, related to the list of UEs moving in or moving out of the specific location.

LM_LocationAreaMonitor

NOTIFY_MISMATCH_LOCATION

This value indicates that the location information of the VAL UE(s) from the SEAL LM client and the core network are not matching.

NOTIFY_ABSENCE

This value indicates that the current location information of the VAL UE(s) is deviating from the VAL server’s area of interest.

NOTIFY_PRESENCE

This value indicates that the current location information of the VAL UE(s) is within the VAL server’s area of interest.

DISTANCE_TRAVELLED

Trigger event for the location area monitoring based on the distance travelled by the reference UE.

1

Notification_test_event

Testing of notification connection is supported according to clause 6.6.

2

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 6.6. This feature requires that the Notification_test_event feature is also supported.

3

LM_LocationInfoChange

This feature supports the location information change event.

4

GM_GroupInfoChange

This feature supports the group information change event.

5

CM_UserProfileChange

This feature supports the user profile change event.

6

GM_GroupCreate

This feature supports the group creation event.

7

GM_MessageFilter

This feature supports the message filter information in group information change event.

8

NRM_EventMonitor

This feature supports the monitoring of events related to VAL UEs or Users.

9

LM_LocationDeviation

This feature supports the monitoring of VAL UE / User’s deviation from a given area of interest.

10

GM_TempGroup

This feature supports the functionality of temporary VAL group formation within a VAL system.

11

LM_LocationAreaMonitor

This feature supports the monitoring of VAL UEs which are moving in or moving out from a given area of interest.

12

SubscUpdate

Indicates the support for updating an SEAL event subscription resource.

13

LM_SuppLoc

Indicates the support of supplementary location information.