CivicAddress

3GPP TS 29.572 [42]

Civic address.

CodeWord

3GPP TS 29.515 [65]

Code word.

DlDataDeliveryStatus

3GPP TS 29.571 [45]

Traffic Descriptor of source of downlink data notifications.

DddTrafficDescriptor

3GPP TS 29.571 [45]

Traffic Descriptor of source of downlink data.

Dnn

3GPP TS 29.571 [45]

Identifies a DNN.

GeographicArea

3GPP TS 29.572 [42]

Identifies the geographical information of the user(s).

IpAddr

3GPP TS 29.571 [45]

UE IP Address.

LocationQoS

3GPP TS 29.572 [42]

Requested location QoS.

LdrType

3GPP TS 29.572 [42]

Location deferred requested event type.

MinorLocationQoS

3GPP TS 29.572 [42]

Minor Location QoS.

VelocityRequested

3GPP TS 29.572 [42]

Velocity of the target UE requested.

AgeOfLocationEstimate

3GPP TS 29.572 [42]

Age of the location estimate for change of location type or motion type of Location deferred report.

AccuracyFulfilmentIndicator

3GPP TS 29.572 [42]

The indication whether the obtained location estimate satisfies the requested QoS or not.

VelocityEstimate

3GPP TS 29.572 [42]

UE velocity, if requested and available.

LinearDistance

3GPP TS 29.572 [42]

This IE shall be present and set to true if a location estimate is required for motion event report.

NetworkAreaInfo

3GPP TS 29.554 [50]

Identifies a network area information.

PatchItem

3GPP TS 29.571 [45]

Contains the list of changes to be made to a resource according to the JSON PATCH format specified in IETF RFC 6902 [67].

PositioningMethod

3GPP TS 29.572 [42]

Identifies the positioning method used to obtain the location estimate of the UE.

SACEventStatus

3GPP TS 29.571 [45]

Contains the network slice status information related to network slice admission control.

SACInfo

3GPP TS 29.571 [45]

Represents network slice admission control information to control the triggering of notifications or convey network slice status information.

Snssai

3GPP TS 29.571 [45]

Contains a S-NSSAI.

SupportedFeatures

3GPP TS 29.571 [45]

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

ServiceIdentiy

3GPP TS 29.515 [65]

Service identity.

SupportedGADShapes

3GPP TS 29.572 [42]

Supported Geographical Area Description shapes.

MacAddr48

3GPP TS 29.571 [45]

MAC Address.

UcPurpose

3GPP TS 29.503 [63]

Represents the purpose of a user consent.

Uri

Clause 5.2.1.3.2

Represents a URI.

Accuracy

5.3.2.4.7

Represents a desired granularity of accuracy for the requested location information.

Location_notification,

eLCS, EDGEAPP

ApiCapabilityInfo

5.3.2.3.9

Represents the availability information of supported API.

API_support_capability_notification

AppliedParameterConfiguration

5.3.2.3.8

Represents the parameter configuration applied in the network.

Enhanced_param_config

AssociationType

5.3.2.4.6

Represents an IMEI or IMEISV to IMSI association.

Change_of_IMSI_IMEI_association_notification

ConsentRevocNotif

5.3.2.3.12

Represents the user consent revocation information conveyed in a user consent revocation notification.

UserConsentRevocation

ConsentRevoked

5.3.2.3.13

Represents the information related to revoked user consent(s).

UserConsentRevocation

FailureCause

5.3.2.3.6

Represents the reason of communication failure.

Communication_failure_notification

IdleStatusInfo

5.3.2.3.3

Represents the information relevant to when the UE transitions into idle mode.

Ue-reachability_notification,

Availability_after_DDN_failure_notification

InterfaceIndication

5.3.2.4.10

Represents the network entity used for data delivery towards the SCS/AS.

Pdn_connectivity_status

LocationFailureCause

5.3.2.4.11

Represents the cause of location/positioning failure.

Location_notification, eLCS

LocationInfo

5.3.2.3.5

Represents the user location information.

Location_notification, eLCS

LocationType

5.3.2.4.5

Represents a location type.

Location_notification, Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G,

eLCS

MonitoringEventReport

5.3.2.3.2

Represents an event monitoring report.

MonitoringEventReports

5.3.2.3.10

Represents one or multiple event monitoring report(s).

enNB

MonitoringEventSubscription

5.3.2.1.2

Represents a subscription to event(s) monitoring.

MonitoringNotification

5.3.2.2.2

Represents an event monitoring notification.

MonitoringType

5.3.2.4.3

Represents a monitoring event type.

PdnConnectionInformation

5.3.2.3.7

Represents the PDN connection information of the UE.

Pdn_connectivity_status

PdnConnectionStatus

5.3.2.4.8

Represents the PDN connection status.

Pdn_connectivity_status

PdnType

5.3.2.4.9

Represents a PDN connection type.

ReachabilityType

5.3.2.4.4

Represents a reachability type.

Ue-reachability_notification

SACRepFormat

5.3.2.4.13

Represents the NSAC reporting format.

NSAC

SubType

5.3.2.4.12

Represents a subscription type.

UAV

UavPolicy

5.3.2.3.11

Represents the policy information included in the UAV presence monitoring request.

UAV

UePerLocationReport

5.3.2.3.4

Represents the number of UEs found at the indicated location.

Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G

self

Link

0..1

Link to the resource "Individual Monitoring Event Subscription". 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.

mtcProviderId

string

0..1

Identifies the MTC Service Provider and/or MTC Application. (NOTE 7)

externalId

ExternalId

0..1

Identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

This attribute may also be present in a monitoring event subscription response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "ueIpAddr" attribute or the "ueMacAddr" attribute.

(NOTE 1)

(NOTE 5)

msisdn

Msisdn

0..1

Identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE 1)

(NOTE 5)

addedExternalIds

array(ExternalId)

0..N

Indicates addition of the external Identifier(s) within the active group.

Partial_group_modification

addedMsisdns

array(Msisdn)

0..N

Indicates addition of the MSISDN(s) within the active group.

Partial_group_modification

excludedExternalIds

array(ExternalId)

0..N

Indicates cancellation of the external Identifier(s) within the active group.

Partial_group_modification

excludedMsisdns

array(Msisdn)

0..N

Indicates cancellation of the MSISDN(s) within the active group.

Partial_group_modification

externalGroupId

ExternalGroupId

0..1

Identifies a user group as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE 1) (NOTE 6)

addExtGroupIds

array(ExternalGroupId)

0..N

Identifies user groups as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE 1) (NOTE 6)

Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G

ipv4Addr

Ipv4Addr

0..1

Identifies the Ipv4 address.

(NOTE 1)

Location_notification,

Communication_failure_notification

ipv6Addr

Ipv6Addr

0..1

Identifies the Ipv6 address.

(NOTE 1)

Location_notification,

Communication_failure_notification

dnn

Dnn

0..1

Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 8)

Session_Management_Enhancement, UEId_retrieval

notificationDestination

Link

1

An URI of a notification destination that T8 message shall be delivered to.

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

monitoringType

MonitoringType

1

Enumeration of monitoring type. Refer to clause 5.3.2.4.3.

maximumNumberOfReports

integer

0..1

Identifies the maximum number of event reports to be generated by the HSS, MME/SGSN as specified in clause 5.6.0 of 3GPP TS 23.682 [2].

(NOTE 2, NOTE 9, NOTE 13)

If "monitoringType" is "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this attribute may also be provided with a value of 1 to indicate that one-time reporting of the network slice status information is requested by the AF.

monitorExpireTime

DateTime

0..1

Identifies the absolute time at which the related monitoring event request is considered to expire, as specified in clause 5.6.0 of 3GPP TS 23.682 [2].

When the "monitoringType" is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this attribute shall be absent in the response to a one-time reporting monitoring subscription request.

(NOTE 2)

repPeriod

DurationSec

0..1

Identifies the periodic time for the event reports. (NOTE 8, NOTE 9, NOTE 13)

If "monitoringType" is "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this attribute may be provided. When provided, it also indicates that periodic reporting of the network slice status information is requested by the AF.

groupReportGuardTime

DurationSec

0..1

Identifies the time for which the SCEF can aggregate the monitoring event reports detected by the UEs in a group and report them together to the SCS/AS, as specified in clause 5.6.0 of 3GPP TS 23.682 [2].

maximumDetectionTime

DurationSec

0..1

If "monitoringType" is "LOSS_OF_CONNECTIVITY", this parameter may be included to identify the maximum period of time after which the UE is considered to be unreachable.

Loss_of_connectivity_notification

reachabilityType

ReachabilityType

0..1

If "monitoringType" is "UE_REACHABILITY", this parameter shall be included to identify whether the request is for "Reachability for SMS" or "Reachability for Data".

Ue-reachability_notification

maximumLatency

DurationSec

0..1

If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify the maximum delay acceptable for downlink data transfers.

Ue-reachability_notification

maximumResponseTime

DurationSec

0..1

If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data.

Ue-reachability_notification

suggestedNumberOfDlPackets

integer

0..1

If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable.

Ue-reachability-notification

idleStatusIndication

boolean

0..1

If "monitoringType" is set to "UE_REACHABILITY" or "AVAILABILITY_AFTER_DDN_FAILURE", this parameter may be included to indicate the notification of when a UE, for which PSM is enabled, transitions into idle mode.

– "true": indicate enabling of notification

– "false": indicate no need to notify

Default: "false".

Ue-reachability_notification,

Availability_after_DDN_failure_notification,

Availability_after_DDN_failure_notification_enhancement

locationType

LocationType

0..1

If "monitoringType" is "LOCATION_REPORTING" or "NUMBER_OF_UES_IN_AN_AREA", this parameter shall be included to identify whether the request is for Current Location, Initial Location or Last known Location.

(NOTE 4)

Location_notification, Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G,

eLCS

accuracy

Accuracy

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to identify the desired level of accuracy of the requested location information, as described in clause 4.9.2 of 3GPP TS 23.682 [2]. (NOTE 10, NOTE 11)

For 5G, if the eLCS feature is not supported, the default value is "TA_RA".

Location_notification,

eLCS

minimumReportInterval

DurationSec

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to identify a minimum time interval between Location Reporting notifications.

If the "ldrType" attribute is present and set to "ENTERING_INTO_AREA". "LEAVING_FROM_AREA", "BEING_INSIDE_AREA" or "MOTION", this attribute shall not be included if the maximumNumberOfReports attribute is present and set to one time event.

Location_notification,

eLCS

maxRptExpireIntvl

DurationSec

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to identify a maximum time interval between Location Reporting notifications.

If the "ldrType" attribute is present and set to "ENTERING_INTO_AREA". "LEAVING_FROM_AREA", "BEING_INSIDE_AREA" or "MOTION", this attribute shall not be included if the maximumNumberOfReports attribute is present and set to one time event.

eLCS

samplingInterval

DurationSec

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to identify the maximum time interval between consecutive evaluations by a UE of a trigger event.

eLCS

reportingLocEstInd

boolean

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate whether event reporting requires the location information. If set to true, the location estimation information shall be included in event reporting.

Default: "false" if omitted.

eLCS

linearDistance

LinearDistance

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate the linear(straight line) distance threshold for motion event reporting.

eLCS

locQoS

LocationQoS

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate the expected location QoS requirement for an immediate MT-LR or deferred MT-LR.

The "Multiple QoS Class" (i.e. the "lcsQosClass" attribute within the LocationQoS data structure is set to "MULTIPLE_QOS") shall only be used when the "MUTIQOS" feature is supported.

(NOTE 10)

eLCS, MULTIQOS

svcId

ServiceIdentity

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate the service identity of AF.

eLCS

ldrType

LdrType

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate the event type for a deferred MT-LR.

eLCS

velocityRequested

VelocityRequested

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate if the velocity of the target UE is requested or not.

eLCS

maxAgeOfLocEst

AgeOfLocationEstimate

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate acceptable maximum age of location estimate.

eLCS

locTimeWindow

TimeWindow

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate the starting time and ending time for a deferred MT-LR.

eLCS

supportedGADShapes

array(SupportedGADShapes)

0..N

Supported Geographical Area Description shapes.

eLCS

codeWord

CodeWord

0..1

Code word.

eLCS

associationType

AssociationType

0..1

If "monitoringType" is "CHANGE_OF_IMSI_IMEI_ASSOCIATION", this parameter shall be included to identify whether the change of IMSI-IMEI or IMSI-IMEISV association shall be detected.

Change_of_IMSI_IMEI_association_notification

plmnIndication

boolean

0..1

If "monitoringType" is "ROAMING_STATUS", this parameter may be included to indicate the notification of UE’s Serving PLMN ID.

– "true": The value shall be used to indicate enabling of notification;

– "false": The value shall be used to indicate disabling of notification.

Default: "false".

Roaming_status_notification

locationArea

LocationArea

0..1

If "monitoringType" is "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included to indicate the area within which the SCS/AS requests the number of UEs.

If "monitoringType" is "AREA_OF_INTEREST", this parameter shall be included to indicate the area within which the SCS/AS requests the presence status of a specific UAV.

Number_of_UEs_in_an_area_notification, UAV

locationArea5G

LocationArea5G

0..1

If "monitoringType" is "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included to indicate the area within which the AF requests the number of UEs.

If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate the area within which the AF requests the area event of the target UE. (NOTE 12)

If "monitoringType" is "AREA_OF_INTEREST", this parameter shall be included to indicate the area within which the AF requests the presence status of a specific UAV.

Number_of_UEs_in_an_area_notification_5G, eLCS, UAV

dddTraDescriptors

array(DddTrafficDescriptor)

0..N

The traffic descriptor(s) of the downlink data source. May be included for event "DOWNLINK_DATA_DELIVERY_STATUS" or "AVAILABILITY_AFTER_DDN_FAILURE".

Downlink_data_delivery_status_5G,

Availability_after_DDN_failure_notification_enhancement

dddStati

array(DlDataDeliveryStatus)

0..N

May be included for event "DOWNLINK_DATA_DELIVERY_STATUS". The subscribed stati (delivered, transmitted, buffered) for the event. If omitted all stati are subscribed.

Downlink_data_delivery_status_5G

monitoringEventReport

MonitoringEventReport

0..1

Identifies a monitoring event report which is sent from the SCEF to the SCS/AS.

apiNames

array(string)

0..N

If "monitoringType" is "API_SUPPORT_CAPABILITY", this parameter may be included. Each element identifies the name of an API.

It shall set as {apiName} part of the URI structure for each T8 or N33 API as defined in the present specification or 3GPP TS 29.522 [62], respectively.

This allows the SCS/AS to request the capability change for its interested APIs. If it is omitted, the SCS/AS requests to be notified for capability change for all APIs the SCEF+NEF supports.

API_support_capability_notification

tgtNsThreshold

SACInfo

0..1

Indicates the monitoring threshold value, for the network slice identified by the "snssai" attirbute, upon which event notification(s) are triggered.

This attribute may be provided if the "monitoringType" attribute is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS". When provided, it also indicates that threshold based reporting of the network slice status information is requested by the AF.

(NOTE 13)

NSAC

nsRepFormat

SACRepFormat

0..1

Indicates the requested NSAC reporting format, i.e. "PERCENTAGE" or "NUMERICAL".

It shall be provided only if the "monitoringType" attribute is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS" and the reporting type is periodic, i.e. the "repPeriod" attribute is provided instead of the "tgtNsThreshold" attribute.

NSAC

afServiceId

string

0..1

Contains the identifier of a service on behalf of which the AF is sending the request.

It may be provided by an untrusted AF and only if the "monitoringType" attribute is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS".

(NOTE 15)

NSAC

snssai

Snssai

0..1

Indicates the S-NSSAI that the event monitoring subscription is targeting.

This attribute may be provided if the "monitoringType" attribute is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS".

This attribute may also be provided if the "monitoringType" attribute is set to "PDN_CONNECTIVITY_STATUS" or "DOWNLINK_DATA_DELIVERY_STATUS".

(NOTE 8, NOTE 15)

NSAC, Session_Management_Enhancement, UEId_retrieval

immediateRep

boolean

0..1

Indicates whether an immediate reporting is requested or not.

It may be included if the "monitoringType" is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS".

(NOTE 13)

Default value: "false".

NSAC

uavPolicy

UavPolicy

0..1

If "monitoringType" is "AREA_OF_INTEREST", this parameter may be included to indicate the 3GPP network to take corresponding action.

UAV

subType

SubType

0..1

If "monitoringType" is "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included to indicate the subscription type to be listed in the Event report.

(NOTE 14)

UAV

sesEstInd

boolean

0..1

If "monitoringType" is "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included. If set to “true”, it indicates that only UE’s with “PDU session established for DNN(s) subject to aerial service” are to be listed in the Event report.

Default: "false" if omitted.

(NOTE 14)

UAV

addnMonTypes

array(MonitoringType)

0..N

Additional monitoring types.

enNB

addnMonEventReports

array(MonitoringEventReport)

0..N

Additional monitoring event reports.

enNB

ueIpAddr

IpAddr

0..1

UE IP address.

UEId_retrieval

ueMacAddr

MacAddr48

0..1

UE MAC address.

UEId_retrieval

revocationNotifUri

Uri

0..1

Contains the URI via which the AF desires to receive user consent revocation notifications.

This attribute shall be present if the "UserConsentRevocation" feature is supported by the AF.

UserConsentRevocation

NOTE 1: One of the properties "externalId", "msisdn", "ipv4Addr", "ipv6Addr" or "externalGroupId" shall be included for features "Location_notification" and "Communication_failure_notification";. One of the properties "externalId", "msisdn" or "externalGroupId" shall be included for feature "eLCS". "ipv4Addr" or "ipv6Addr" is required for monitoring via the PCRF for an individual UE. One of the properties "externalId", "msisdn" or "externalGroupId" shall be included for features "Pdn_connectivity_status", "Loss_of_connectivity_notification", "Ue-reachability_notification", "Change_of_IMSI_IMEI_association_notification", "Roaming_status_notification", "Availability_after_DDN_failure_notification" and "Availability_after_DDN_failure_notification_enhancement".

NOTE 2: Inclusion of either "maximumNumberOfReports" (with a value higher than 1) or "monitorExpireTime" makes the Monitoring Request a Continuous Monitoring Request, where the SCEF sends Notifications until either the maximum number of reports or the monitoring duration indicated by the property "monitorExpireTime" is exceeded. The "maximumNumberOfReports" with a value 1 makes the Monitoring Request a One-time Monitoring Request. At least one of "maximumNumberOfReports" or "monitorExpireTime" shall be provided.

NOTE 3: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 4: In this release, for features "Number_of_UEs_in_an_area_notification" and "Number_of_UEs_in_an_area_notification_5G", locationType shall be set to "LAST_KNOWN_LOCATION". For 5G, if the "locationType" attribute sets to "LAST_KNOWN_LOCATION", the "maximumNumberOfReports" attribute shall set to 1 as a One-time Monitoring Request.

NOTE 5: The property does not apply for the features "Number_of_UEs_in_an_area_notification" and "Number_of_UEs_in_an_area_notification_5G".

NOTE 6: For the features "Number_of_UEs_in_an_area_notification" and "Number_of_UEs_in_an_area_notification_5G", the property "externalGroupId" may be included for single group and "addExtGroupIds" may be included for multiple groups but not both.

NOTE 7: The SCEF should check received MTC provider identifier and then the SCEF may:
– override it with local configured value and send it to HSS;
– send it directly to the HSS; or
– reject the monitoring configuration request.

NOTE 8: This property is only applicable for the NEF.

NOTE 9: The value of the "maximumNumberOfReports" attribute sets to 1 and the "repPeriod" attribute are mutually exclusive.

NOTE 10: If the eLCS feature is supported, the "accuracy" attribute and "locQoS" attribute are mutually exclusive, and only the "GEO_AREA" value is applicable for the"accuracy" attribute.

NOTE 11: The value of "TWAN_ID" is only applicable when the monitoring subscription is via the PCRF as described in clause 4.4.2.2.4.

NOTE 12: If the eLCS feature is supported, only the "geographicAreas" attribute within the "locationArea5G" attribute is applicable.

NOTE 13: For the "NSAC" feature, if the "maximumNumberOfReports" attribute is provided with a value of 1, the "repPeriod" attribute and the "tgtNsThreshold" attributeshall not be provided and the "immediateRep" attribute shall be provided and set to true; otherwise, either the "repPeriod" attribute or the "tgtNsThreshold" attribute shall be provided, and if immediate reporting is requested, the "immediateRep" attribute shall be provided and set to true.

NOTE 14: For the feature UAV, the event "Number of UEs present in a geographical area" is used, where "subType" indication and/or "sesEstInd" may be used as event filters.

NOTE 15: For the NSAC feature, the "snssai" and "afServiceId" attributes are mutually exclusive.

subscription

Link

1

Link to the subscription resource to which this notification is related.

configResults

array(ConfigResult)

0..N

Each element identifies a notification of grouping configuration result.

monitoringEventReports

array(MonitoringEventReport)

0..N

Each element identifies a monitoring event report.

addedExternalIds

array(ExternalId)

0..N

Identifies the added external Identifier(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data type.

Partial_group_modification

addedMsisdns

array(Msisdn)

0..N

Identifies the added MSISDN(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data type.

Partial_group_modification

cancelExternalIds

array(ExternalId)

0..N

Identifies the cancelled external Identifier(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data type.

Partial_group_modification

cancelInd

Boolean

0..1

Indicates whether to request to cancel the corresponding monitoring subscription. Set to false or omitted otherwise.

cancelMsisdns

array(Msisdn)

0..N

Identifies the cancelled MSISDN(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data.

Partial_group_modification

appliedParam

AppliedParameterConfiguration

0..1

Indicates the applied parameter configuration in the network. For the attributes included in AppliedParameterConfiguration data type, the "maximumLatency" and "maximumResponseTime" attributes require the "Ue-reachability_notification" feature support, and the "maximumDetectionTime" attribute requires the "Loss_of_connectivity_notification" feature support.

Enhanced_param_config

NOTE: Properties marked with a feature as defined in subclause 5.3.4 are applicable as described in subclause 5.2.7. If no features are indicated, the related property applies for all the features.

imeiChange

AssociationType

0..1

If "monitoringType" is "CHANGE_OF_IMSI_IMEI_ASSOCIATION", this parameter shall be included to identify the event of change of IMSI-IMEI or IMSI-IMEISV association is detected.

Refer to 3GPP TS 29.336 [11] Clause 8.4.22.

Change_of_IMSI_IMEI_association_notification

externalId

ExternalId

0..1

External identifier.

This attribute may also be present in the monitoring event subscription one-time response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "ueIpAddr" attribute or the "ueMacAddr" attribute.

(NOTE 2)

idleStatusInfo

IdleStatusInfo

0..1

If "idleStatusIndication" in the "MonitoringEventSubscription"sets to "true", this parameter shall be included to indicate the information when the UE transitions into idle mode.

Ue-reachability_notification,

Availability_after_DDN_failure_notification

locationInfo

LocationInfo

0..1

If "monitoringType" is "LOCATION_REPORTING", this parameter shall be included to indicate the user location related information.

Location_notification, eLCS

locFailureCause

LocationFailureCause

0..1

Indicates the location positioning failure cause.

Location_notification, eLCS

lossOfConnectReason

integer

0..1

If "monitoringType" is "LOSS_OF_CONNECTIVITY", this parameter shall be included if available to identify the reason why loss of connectivity is reported.

Refer to 3GPP TS 29.336 [11] Clause 8.4.58.

Loss_of_connectivity_notification

maxUEAvailabilityTime

DateTime

0..1

If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify the timestamp until which a UE using a power saving mechanism is expected to be reachable for SM delivery.

Refer to Clause 5.3.3.22 of 3GPP TS 29.338 [34].

Ue-reachability_notification

msisdn

Msisdn

0..1

Identifies the MS internal PSTN/ISDN number

(NOTE 2)

monitoringType

MonitoringType

1

Identifies the type of monitoring type as defined in clause 5.3.2.4.3.

uePerLocationReport

UePerLocationReport

0..1

If "monitoringType" is "NUMBER_OF_UES_IN_AN_AREA", this parameter shall be included to indicate the number of UEs found at the location.

If "subType" indicates "AERIAL_UE" subscription type, this parameter shall be included to indicate the number of UAV’s found at the location.

Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G

plmnId

PlmnId

0..1

If "monitoringType" is "ROAMING_STATUS" and "plmnIIndication" in the "MonitoringEventSubscription" sets to "true", this parameter shall be included to indicate the UE’s serving PLMN.

Roaming_status_notification

reachabilityType

ReachabilityType

0..1

If "monitoringType" is "UE_REACHABILITY", this parameter shall be included to identify the reachability of the UE.

Refer to 3GPP TS 29.336 [11] Clause 8.4.20.

Ue-reachability_notification

roamingStatus

boolean

0..1

If "monitoringType" is "ROAMING_STATUS", this parameter shall be set to "true" if the UE is on roaming status. Set to false or omitted otherwise.

Roaming_status_notification

failureCause

FailureCause

0..1

If "monitoringType" is "COMMUNICATION_FAILURE", this parameter shall be included to indicate the reason of communication failure.

Communication_failure_notification

eventTime

DateTime

0..1

Identifies when the event is detected or received.

Shall be included for each group of UEs.

pdnConnInfoList

array(PdnConnectionInformation)

0..N

If "monitoringType" is "PDN_CONNECTIVITY_STATUS", this parameter shall be included to indicate the PDN connection details.

Pdn_connectivity_status

dddStatus

DlDataDeliveryStatus

0..1

If "monitoringType" is "DOWNLINK_DATA_DELIVERY_STATUS", this parameter shall be included to identify the downlink data delivery status detected by the network.

Downlink_data_delivery_status_5G

dddTrafDescriptor

DddTrafficDescriptor

0..1

If "monitoringType" is "DOWNLINK_DATA_DELIVERY_STATUS", this parameter shall be included to identify the downlink data descriptor impacted by the downlink data delivery status change.

Downlink_data_delivery_status_5G

maxWaitTime

DateTime

0..1

If "monitoringType" is "DOWNLINK_DATA_DELIVERY_STATUS", this parameter may be included to identify the time before which the data will be buffered.

Downlink_data_delivery_status_5G

apiCaps

array(ApiCapabilityInfo)

0..N

If "monitoringType" is "API_SUPPORT_CAPABILITY", this parameter shall be included to indicate the availability of all APIs supported by the serving network or the availability of interested APIs, indicated by the "apiNames" attribute in "MonitoringEventSubscription", supported by the serving network.

If no API is supported by the serving network, an empty apiCaps shall be provided.

API_support_capability_notification

nSStatusInfo

SACEventStatus

0..1

If the "monitoringType" attribute is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this parameter shall be included to indicate the current network slice status information for the concerned network slice.

NSAC

afServiceId

string

0..1

Contains the identifier of the service to which the NSAC reporting is related.

It shall be provided only if it is present in the related NSAC subscription request and the "monitoringType" attribute is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS".

NSAC

servLevelDevId

string

0..1

If "monitoringType" is "AREA_OF_INTEREST" or "NUMBER_OF_UES_IN_AN_AREA" and "subType" indicate "AERIAL_UE", this parameter may be included to identify the UAV.

UAV

uavPresInd

boolean

0..1

If "monitoringType" is "AREA_OF_INTEREST", this parameter shall be set to true if the specified UAV is in the monitoring area. Set to false or omitted otherwise.

UAV

NOTE 1: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: Identifies the user for which the event occurred. At least one of the properties shall be included.

activeTime

DurationSec

0..1

Identifies the active time granted to the UE. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true".

edrxCycleLength

number

0..1

Identifies the power saving interval in unit of seconds. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true".

suggestedNumberOfDlPackets

integer

0..1

Identifies the number of packets shall be buffered in the serving gateway. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true".

idleStatusTimestamp

DateTime

0..1

Identifies the timestamp at which the UE transitions into idle mode. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true".

periodicAUTimer

DurationSec

0..1

Identifies the subscribed periodic RAU/TAU timer value. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true".

ueCount

integer

1

Identifies the number of UEs.

externalIds

array(ExternalId)

0..N

Each element uniquely identifies a user.

(NOTE)

msisdns

array(Msisdn)

0..N

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE)

servLevelDevIds

array(string)

0..N

Each element uniquely identifies a UAV.

NOTE: The property shall be included if received from the MME(s)/SGSN(s).

ageOfLocationInfo

DurationMin

0..1

Indicates the elapsed time since the last network contact of the UE.

Refer to the Age-Of-Location-Information AVP as defined in clause 7.3.126 of 3GPP TS 29.272 [33].

cellId

string

0..1

Indicates the Cell Global Identification of the user which identifies the cell the UE is registered.

Refer to the Cell-Global-Identity AVP or E-UTRAN-Cell-Global-Identity AVP as defined in clause 7.3.119 or clause 7.3.117 of 3GPP TS 29.272 [33]. (NOTE 2)

enodeBId

string

0..1

Indicates the eNodeB in which the UE is currently located.

Refer to the eNodeB-ID AVP or Extended-eNodeB-ID AVP as defined in clause 7.3.198 or clause 7.3.218 of 3GPP TS 29.272 [33].

routingAreaId

string

0..1

Identifies the Routing Area Identity of the user where the UE is located.

Refer to the Routing-Area-Identity AVP as defined in clause 7.3.120 of 3GPP TS 29.272 [33].

trackingAreaId

string

0..1

Identifies the Tracking Area Identity of the user where the UE is located.

Refer to the Tracking-Area-Identity AVP as defined in clause 7.3.118 of 3GPP TS 29.272 [33]. (NOTE 3)

plmnId

string

0..1

Identifies the PLMN Identity of the user where the UE is located.

Refer to the Visited-PLMN-Id AVP as defined in clause 7.3.9 of 3GPP TS 29.272 [33].

twanId

string

0..1

Identifies the TWAN Identity of the user where the UE is located.

geographicArea

GeographicArea

0..1

Identifies a geographic area of the user where the UE is located.

civicAddress

CivicAddress

0..1

The civic address of the target UE.

eLCS

positionMethod

PositioningMethod

0..1

Identifies the positioning method used to obtain the location estimate of the UE, if it is available at the LCS server and if needed.

eLCS

qosFulfilInd

AccuracyFulfilmentIndicator

0..1

Represents whether the requested accuracy is fulfilled or not.

(NOTE 1)

eLCS

ueVelocity

VelocityEstimate

0..1

UE velocity, if requested and available

eLCS

ldrType

LdrType

0..1

The IE may be included to indicate the type of event that triggers event notification.

eLCS

achievedQos

MinorLocationQoS

0..1

When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received.

MULTIQOS

NOTE 1: For the eLCS feature, if "reportingLocEstInd" attribute is set to false or omitted during the monitoring event request, the location estimation information shall not be included. Otherwise, if the "reportingLocEstInd" attribute is set to true, and

– if the "qosFulfilInd" attribute is set to "REQUESTED_ACCURACY_FULFILLED", the location estimate information may be included if the "lcsQosClass" attribute within the "locQoS" attribute is set to "BEST_EFFORT"; or

– if the "qosFulfilInd" attribute is set to "REQUESTED_ACCURACY_NOT_FULFILLED", the location estimate shall not be included if the "lcsQosClass" attribute within "locQoS" attribute is set to "ASSURED".

NOTE 2: For NEF, the context of the property shall refer to the Ecgi or Ncgi data type as defined in clause 5.4.4.5 or clause 5.4.4.6 of 3GPP TS 29.571 [45].

NOTE 3: For NEF, the context of the property shall refer to the Tai data type as defined in clause 5.4.4 of 3GPP TS 29.571 [45]].

bssgpCause

integer

0..1

Identifies a non-transparent copy of the BSSGP cause code.

Refer to 3GPP TS 29.128 [12].

causeType

integer

0..1

Identify the type of the S1AP-Cause.

Refer to 3GPP TS 29.128 [12].

gmmCause

integer

0..1

Identifies a non-transparent copy of the GMM cause code.

Refer to 3GPP TS 29.128 [12].

ranapCause

integer

0..1

Identifies a non-transparent copy of the RANAP cause code.

Refer to 3GPP TS 29.128 [12].

ranNasCause

string

0..1

Indicates RAN and/or NAS release cause code information, TWAN release cause code information or untrusted WLAN release cause code information.

Refer to 3GPP TS 29.214 [10].

(NOTE)

s1ApCause

integer

0..1

Identifies a non-transparent copy of the S1AP cause code.

Refer to 3GPP TS 29.128 [12].

smCause

integer

0..1

Identifies a non-transparent copy of the SM cause code.

Refer to 3GPP TS 29.128 [12].

NOTE: If this property is provided in the "FailureCause" type, then other properties shall not be provided.

status

PdnConnectionStatus

1

Identifies the PDN connection status.

apn

string

0..1

Identifies the APN, it is depending on the SCEF local configuration whether or not this attribute is sent to the SCS/AS.

pdnType

PdnType

1

PDN type

interfaceInd

InterfaceIndication

0..1

Identifies the 3GPP network function used to communicate with the SCS/AS for non-IP PDN type.

ipv4Addr

Ipv4Addr

0..1

Identifies the UE Ipv4 address.

ipv6Addrs

array(Ipv6Addr)

0..N

Identifies the UE Ipv6 address.

(NOTE 2)

macAddrs

array(MacAddr48)

0..N

Identifies the UE MAC address(es) which is only available for the immediate report.

NOTE 1: Properties marked with a feature as defined in clause 5.5.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: ipv6 prefix is included in this attribute if ipv6 full address is not available.

externalIds

array(ExternalId)

0..N

Each element uniquely identifies a user. (NOTE)

msisdns

array(Msisdn)

0..N

Each element identifies the MS internal PSTN/ISDN number allocated for a UE. (NOTE)

maximumLatency

DurationSec

0..1

This parameter may be included to identify the maximum delay acceptable for downlink data transfers, which is applied in the network.

maximumResponseTime

DurationSec

0..1

This parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data, which is applied in the network.

maximumDetectionTime

DurationSec

0..1

This parameter may be included to identify the maximum period of time after which the UE is considered to be unreachable, which is applied in the network.

NOTE: If both are omitted, it means the change applies for the whole configuration (i.e. a single UE or a group of UEs).

apiName

string

1

Identifies the name of an available API provided by the SCEF+NEF.

It shall set as {apiName} part of the URI structure for each T8 or N33 API as defined in the present specification or 3GPP TS 29.522 [62], respectively.

suppFeat

SupportedFeatures

1

Indicates all the features supported by the API in the serving network, which provided by the SCEF+NEF.

monitoringEventReports

array(MonitoringEventReport)

1..N

Contains a set of event monitoring reports.

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

uavMoveInd

boolean

1

Indicates the UAV moves in or moves out of the Area of Interest. Set to true if the UAV moves in the Area of Interest. Set to false if the UAV moves out of the Area of Interest.

revokeInd

boolean

1

Indicates whether the connectivity between UAV and UAV controller shall be revoked. If set to true, the connectivity between UAV and UAV controller shall be revoked. Set to false otherwise.

subscriptionId

string

1

Contains the identifier of the subscription to which the notification is related.

consentsRevoked

array(ConsentRevoked)

1..N

Indicates the revoked user consents.

ucPurpose

UcPurpose

1

Identifies the purpose of the revoked user consent.

externalId

ExternalId

0..1

Indicates the user(s) for which user consent was revoked.

(NOTE)

msisdn

Msisdn

0..1

Indicates the MSISDN(s) of the users for which user consent was revoked.

(NOTE)

NOTE: One of the "externalId", or "msisdn" attributes shall be present.

LOSS_OF_CONNECTIVITY

The SCS/AS requests to be notified when the 3GPP network detects that the UE is no longer reachable for signalling or user plane communication

Loss_of_connectivity_notification

UE_REACHABILITY

The SCS/AS requests to be notified when the UE becomes reachable for sending either SMS or downlink data to the UE

Ue-reachability_notification

LOCATION_REPORTING

The SCS/AS requests to be notified of the current location or the last known location of the UE

Location_notification, eLCS

CHANGE_OF_IMSI_IMEI_ASSOCIATION

The SCS/AS requests to be notified when the association of an ME (IMEI(SV)) that uses a specific subscription (IMSI) is changed

Change_of_IMSI_IMEI_association_notification

ROAMING_STATUS

The SCS/AS queries the UE’s current roaming status and requests to get notified when the status changes

Roaming_status_notification

COMMUNICATION_FAILURE

The SCS/AS requests to be notified of communication failure events

Communication_failure_notification

AVAILABILITY_AFTER_DDN_FAILURE

The SCS/AS requests to be notified when the UE has become available after a DDN failure

Availability_after_DDN_failure_notification, Availability_after_DDN_failure_notification_enhancement

NUMBER_OF_UES_IN_AN_AREA

The SCS/AS requests to be notified the number of UEs in a given geographic area

Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G

PDN_CONNECTIVITY_STATUS

The SCS/AS requests to be notified when the 3GPP network detects that the UE’s PDN connection is set up or torn down.

Pdn_connectivity_status

DOWNLINK_DATA_DELIVERY_STATUS

The AF requests to be notified when the 3GPP network detects that the downlink data delivery status is changed.

Downlink_data_delivery_status_5G

API_SUPPORT_CAPABILITY

The SCS/AS requests to be notified of the availability of support of service APIs.

API_support_capability_notification

NUM_OF_REGD_UES

The AF requests to be notified of the current number of registered UEs for a network slice.

NSAC

NUM_OF_ESTD_PDU_SESSIONS

The AF requests to be notified of the current number of established PDU Sessions for a network slice.

NSAC

AREA_OF_INTEREST

The SCS/AS requests to be notified when the UAV moves in or out of the geographic area.

UAV

NOTE 1: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: More monitoring types can be added in the future based on stage 2.

SMS

The SCS/AS requests to be notified when the UE becomes reachable for sending SMS to the UE

Ue-reachability_notification

DATA

The SCS/AS requests to be notified when the UE becomes reachable for sending downlink data to the UE

Ue-reachability_notification

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

CURRENT_LOCATION

The SCS/AS requests to be notified for current location

Location_notification, eLCS

LAST_KNOWN_LOCATION

The SCS/AS requests to be notified for last known location

Location_notification, Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G

CURRENT_OR_LAST_KNOWN_LOCATION

The AF requests the current or last known location.

eLCS

INITIAL_LOCATION

The AF requests the initial location.

eLCS

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

IMEI

The value shall be used when the change of IMSI-IMEI association shall be detected

Change_of_IMSI_IMEI_association_notification

IMEISV

The value shall be used when the change of IMSI-IMEISV association shall be detected

Change_of_IMSI_IMEI_association_notification

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

CGI_ECGI

The SCS/AS requests to be notified using cell level location accuracy.

ENODEB

The SCS/AS requests to be notified using eNodeB level location accuracy.

TA_RA

The SCS/AS requests to be notified using TA/RA level location accuracy.

PLMN

The SCS/AS requests to be notified using PLMN level location accuracy.

TWAN_ID

The SCS/AS requests to be notified using TWAN identifier level location accuracy.

GEO_AREA

The SCS/AS requests to be notified using the geographical area accuracy.

CIVIC_ADDR

The SCS/AS requests to be notified using the civic address accuracy.

EDGEAPP

NOTE 1: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

CREATED

The PDN connection is created.

Pdn_connectivity_status

RELEASED

The PDN connection is released.

Pdn_connectivity_status

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

IPV4

PDN connection of IPv4 type

IPV6

PDN connection of IPv6 type

IPV4V6

PDN connection of IPv4v6 type

NON_IP

PDN connection of non-IP type

ETHERNET

PDN connection of Ethernet type

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

EXPOSURE_FUNCTION

SCEF is used for the PDN connection towards the SCS/AS.

Pdn_connectivity_status

PDN_GATEWAY

PDN gateway is used for the PDN connection towards the SCS/AS.

Pdn_connectivity_status

NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

"POSITIONING_DENIED"

Positioning is denied.

"UNSUPPORTED_BY_UE"

Positioning is not supported by UE.

"NOT_REGISTED_UE"

UE is not registered.

"UNSPECIFIED"

Unspecified.

AERIAL_UE

The UE has Aerial subscription.

UAV

"NUMERICAL"

Indicates that the NSAC reporting should be done in numerical format.

"PERCENTAGE"

Indicates that the NSAC reporting should be done in the format of a percentage.

Monitoring Event Subscriptions

/{scsAsId}/subscriptions

GET

Read all or queried subscriptions for a given SCS/AS

POST

Create a new subscription of monitoring event

Individual Monitoring Event Subscription

/{scsAsId}/subscriptions/{subscriptionId}

PUT

Modify an existing subscription of monitoring event

PATCH

Modifies an existing subscription of monitoring event.

GET

Read a subscription of monitoring event

DELETE

Delete a subscription of monitoring event

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

ip-addrs

array(IpAddr)

0..N

The IP address(es) of the requested UE(s). (NOTE)

enNB

ip-domain

string

0..1

The IPv4 address domain identifier.

The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter.

enNB

mac-addrs

array(MacAddr48)

0..N

The MAC address(es) of the requested UE(s). (NOTE)

enNB

NOTE: Either the "ip-addrs" parameter or the "mac-addrs" parameter may be provided at the same time. If multiple elements are provided in the array data structure, then each element shall be treated as a separate query parameter.

none

Response body

Data type

Cardinality

Response

codes

Remarks

array(MonitoringEventSubscription)

0..N

200 OK

The subscription information for the SCS/AS in the request URI are returned.

none

307 Temporary Redirect

Temporary redirection, during subscription 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 subscription 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.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

none specified

MonitoringEventSubscription

1

Parameters to register a subscription to notifications about monitoring event with the SCEF.

Response body

Data type

Cardinality

Response

codes

Remarks

MonitoringEventSubscription

1

201 Created

The subscription resource was created successfully.

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

MonitoringEventReport

1

200 OK

The operation is successful, and corresponding monitoring event report is included.

This is only applicable for the one-time monitoring request if report is available in the response.

MonitoringEventReports

1

200 OK

The operation is successful and the corresponding monitoring event report(s) are included in the response body.

This is only applicable when the enNB feature is supported, the monitoring request is a one-time reporting request and the event reports are available in the response.

ProblemDetails

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

0..1

403 Forbidden

(NOTE 2)

ProblemDetails

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

NOTE 2: Failure cases are described in clause 5.3.5.3.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions/{subscriptionId}

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

subscriptionId

string

Identifier of the subscription resource. The subscriptionId corresponds to the stage 2 TLTRI.

none specified

none

Response body

Data type

Cardinality

Response

codes

Remarks

MonitoringEventSubscription

1

200 OK

The subscription information related to the request URI is returned.

none

307 Temporary Redirect

Temporary redirection, during subscription 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 subscription 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.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

none specified

MonitoringEventSubscription

1

Parameters to update a subscription to notifications about monitoring event with the SCEF.

Response body

Data type

Cardinality

Response

codes

Remarks

MonitoringEventSubscription

1

200 OK

The subscription was updated successfully and the representation of the subscription is returned.

none

204 No Content

The subscription was updated successfully.

none

307 Temporary Redirect

Temporary redirection, during subscription 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 subscription 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.

ProblemDetails

0..1

403 Forbidden

(NOTE 2, NOTE 3)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply.

NOTE 2: The error case is only applicable for monitoring event configuration via PCRF.

NOTE 3: Failure cases are described in clause 5.3.5.3.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

array(PatchItem)

1..N

Contains the list of changes to be made to an individual subscription resource, according to the JSON PATCH format specified in IETF RFC 6902 [67].

Response body

Data type

Cardinality

Response

codes

Remarks

none

204 No Content

The resource was modified successfully.

none

307 Temporary Redirect

Temporary redirection, during subscription 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 subscription 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.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

none specified

none

Response body

Data type

Cardinality

Response

codes

Remarks

none

204 No Content

The subscription was terminated successfully.

array(MonitoringEventReport)

1..N

200 OK

The subscription was terminated successfully, the monitoring event report(s) shall be included if received.

none

307 Temporary Redirect

Temporary redirection, during subscription 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 subscription 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.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Monitoring Notification

{notificationDestination}

POST

Sent from the SCEF to the SCS/AS about the notification of grouping configuration result, detected monitoring event report(s) or notify the SCS/AS to cancel a monitoring subscription

User Consent Revocation Notification

{revocationNotifUri}

POST

The user consent revocation notification from the NEF to the AF to inform about the revocation of user consent for one or several UE(s).

notificationDestination

Link

Callback reference provided by the SCS/AS during creation or modification of the monitoring event subscription.

MonitoringNotification

1

The monitoring notification provided by the SCEF.

none

204 No Content

The monitoring notification is received successfully.

none

307 Temporary Redirect

Temporary redirection, during event 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 event 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.

Location

string

M

1

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

Location

string

M

1

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

revocationNotifUri

Uri

Callback reference provided by the AF during creation/modification of the subscription within the TrafficInfluSub data type as defined in Table 5.4.3.3.2-1.

ConsentRevocNotif

1

Contains the user consent revocation information.

n/a

204 No Content

Successful case. The user consent revocation notification is successfully received.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

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

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

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

Location

string

1

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

Location

string

1

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

1

Loss_of_connectivity_notification

The SCS/AS is notified when the 3GPP network detects that the UE is no longer reachable for signalling or user plane communication

2

Ue-reachability_notification

The SCS/AS is notified when the UE becomes reachable for sending either SMS or downlink data to the UE

3

Location_notification

The SCS/AS is notified of the current location or the last known location of the UE

4

Change_of_IMSI_IMEI_association_notification

The SCS/AS is notified when the association of an ME (IMEI(SV)) that uses a specific subscription (IMSI) is changed

5

Roaming_status_notification

The SCS/AS is notified when the UE’s roaming status changes

6

Communication_failure_notification

The SCS/AS is notified of communication failure events

7

Availability_after_DDN_failure_notification

The SCS/AS is notified when the UE has become available after a DDN failure

8

Number_of_UEs_in_an_area_notification

The SCS/AS is notified the number of UEs present in a given geographic area

The feature supports pre-5G (e.g. 4G) requirement.

9

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.

10

Notification_test_event

The testing of notification connection is supported according to clause 5.2.5.3.

11

Subscription_modification

Modifications of an individual subscription resource.

12

Number_of_UEs_in_an_area_notification_5G

The AF is notified the number of UEs present in a given geographic area.

The feature supports the 5G requirement. This feature may only be supported in 5G.

13

Pdn_connectivity_status

The SCS/AS requests to be notified when the 3GPP network detects that the UE’s PDN connection is set up or torn down.

14

Downlink_data_delivery_status_5G

The AF requests to be notified when the 3GPP network detects that the downlink data delivery status is changed. The feature is not applicable to pre-5G.

15

Availability_after_DDN_failure_notification_enhancement

The AF is notified when the UE has become available after a DDN failure and the traffic matches the packet filter provided by the AF. The feature is not applicable to pre-5G.

16

Enhanced_param_config

This feature supports the co-existence of multiple event configurations for target UE(s) if there are parameters affecting periodic RAU/TAU timer and/or Active Time. Supporting this feature also requires the support of feature number 1 or 2.

17

API_support_capability_notification

The SCS/AS is notified of the availability of support of service APIs. This feature is only applicable in interworking SCEF+NEF scenario.

18

eLCS

This feature supports the enhanced location exposure service (e.g. location information preciser than cell level).

The feature is not applicable to pre-5G (e.g. 4G).

19

NSAC

This feature controls the support of the Network Slice Admission Control (NSAC) functionalities.

The feature is not applicable to pre-5G (e.g. 4G).

20

Partial_group_modification

This feature supports the partial cancellation and/or partial addition to the group member(s) within the grouped event monitoring subscription.

21

UAV

The SCS/AS requests to be notified of the UAV presence status in a specific geographic area. This feature is only applicable in interworking SCEF+NEF scenario, or standalone 5G scenario.

This feature requires that Number_of_UEs_in_an_area_notification and Number_of_UEs_in_an_area_notification_5G features are also supported.

22

MULTIQOS

This feature indicates the support for "Multiple QoS Class" which enables to support more than one Location QoS during LCS procedures.

This feature requires that the eLCS feature is also supported.

23

Session_Management_Enhancement

This feature supports Session Management enhancement with requested DNN and/or S-NSSAI. This feature requires that the Pdn_connectivity_status feature or Downlink_data_delivery_status_5G feature is also supported.

24

enNB

Indicates the support of enhancements to the northbound interfaces.

25

EDGEAPP

This feature controls the support of EDGE applications related functionalities (e.g. support the civic address as a possible location granularity).

The feature is not applicable to pre-5G (e.g. 4G).

26

UEId_retrieval

This feature supports AF specific UE ID retrieval which is not applicable to pre-5G (e.g. 4G).

27

UserConsentRevocation

This feature indicates the support of user consent revocation management and enforcement (e.g. stop data processing) for EDGE applications.

28

Subscription_Patch

This feature indicates the support of the PATCH method for partial modification of an existing event monitoring subscription.

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.

EVENT_FEATURE_MISMATCH

400 Bad Request

Indicates the resource creation is not allowed since the supported feature corresponding to the monitoring event is not supported by the client.

DUPLICATE_REQUEST

400 Bad Request

Indicates that a duplicate subscription already exists for this client.

enNB

PARAMETER_OUT_OF_RANGE

403 Forbidden

Indicates that the resource is not allowed to be created since one or more of the received parameter are out of range defined by operator policies.

IDLE_STATUS_UNSUPPORTED

403 Forbidden

Indicates that the resource is not allowed to be created since the Idle Status Indication is received in the request but not supported by the network.

OPERATION_PROHIBITED

403 Forbidden

Indicates the HTTP method is not supported.

CONSENT_REVOCATION_NOT_ SUPPORTED

403 Forbidden

Indicates that the request is rejected because user consent management and enforcement is not supported by the client.

UserConsentRevocation

USER_CONSENT_NOT_GRANTED

403 Forbidden

Indicates that the request is rejected because user consent is not granted.

UserConsentRevocation

RESOURCES_EXCEEDED

403 Forbidden

Indicates that no more subscriptions are allowed for this client.

enNB

EVENT_UNSUPPORTED

500 Internal Server Error

Indicates the required monitoring event is not supported by the server.

REQUEST_NOT_AUTHORIZED

403 Forbidden

Indicates that the AF specific UE ID retrieval request is not authorized.

UEId_retrieval

UE_ID_NOT_AVAILABLE

404 Not Found

Indicates that the AF specific UE ID is not available.

UEId_retrieval

UE_NOT_FOUND

404 Not Found

Indicates that the requested UE address is not found.

UEId_retrieval