5.18 AMInfluence API
29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS
5.18.1 Resources
5.18.1.1 Overview
All resource URIs of this API should have the following root:
{apiRoot}/3gpp-am-influence/v1
"apiRoot" is set as described in clause 5.2.4 in 3GPP TS 29.122 [4]. "apiName" shall be set to "3gpp-am-influence" and "apiVersion" shall be set to "v1" for the current version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.
This clause describes the structure for the Resource URIs as shown in figure 5.18.1.1-1 and the resources and HTTP methods used for the AMInfluence API.
Figure 5.18.1.1-1: Resource URI structure of the AMInfluence API
Table 5.18.1.1-1 provides an overview of the resources and HTTP methods applicable for the AMInfluence API.
Table 5.18.1.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method |
Description |
AM Influence Subscription |
/{afId}/subscriptions |
GET |
Read all subscriptions for a given AF. |
POST |
Create a new subscription to AM influence. |
||
Individual AM Influence Subscription |
/{afId}/subscriptions/{subscriptionId} |
GET |
Read a subscription to AM influence. |
PUT |
Modify all of the properties of an existing subscription to AM influence. |
||
PATCH |
Modify part of the properties of an existing subscription to AM influence. |
||
DELETE |
Delete a subscription to AM influence. |
5.18.1.2 Resource: AM Influence Subscription
5.18.1.2.1 Introduction
This resource allows an AF to read all active AM influence subscribtions and create a new subscription resource for a given AF.
5.18.1.2.2 Resource Definition
Resource URI: {apiRoot}/3gpp-am-influence/v1/{afId}/subscriptions
This resource shall support the resource URI variables defined in table 5.18.1.2.2-1.
Table 5.18.1.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
Clause 5.2.4 of 3GPP TS 29.122 [4]. |
afId |
string |
Identifier of the AF. |
5.18.1.2.3 Resource Methods
5.18.1.2.3.1 General
The following clauses specify the resource methods supported by the resource as described in clause 5.18.1.2.2.
5.18.1.2.3.2 GET
The GET method allows to read all active subscriptions for a given AF. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.18.1.2.3.2-1.
Table 5.18.1.2.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
N/A |
This method shall support the request data structures specified in table 5.18.1.2.3.2-2 and the response data structures and response codes specified in table 5.18.1.2.3.2-3.
Table 5.18.1.2.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
N/A |
Table 5.18.1.2.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
array(AmInfluSub) |
M |
0..N |
200 OK |
The subscription information for the AF in the request URI are returned. |
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.18.1.2.3.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
Table 5.18.1.2.3.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
5.18.1.2.3.3 POST
The POST method creates a new subscription resource to AM influence subscription for a given AF. The AF shall initiate the HTTP POST request message and the NEF shall respond to the message. The NEF shall construct the URI of the created resource.
This method shall support the request data structures specified in table 5.18.1.2.3.3-1 and the response data structures and response codes specified in table 5.18.1.2.3.3-2.
Table 5.18.1.2.3.3-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
AmInfluSub |
M |
1 |
Parameters to create a resource for the AM Influence and/or notification about service area coverage outcome events with the NEF. |
Table 5.18.1.2.3.3-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AmInfluSub |
M |
1 |
201 Created |
The subscription was 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 [4] also apply. |
Table 5.18.1.2.3.3-3: Headers supported by the 201 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-am-Influence/v1/{afId}/subscriptions/{subscriptionId} |
5.18.1.3 Resource: Individual AM Influence Subscription
5.18.1.3.1 Introduction
This resource allows an AF to read, update or delete an existing AM Influence subscription.
5.18.1.3.2 Resource Definition
Resource URI: {apiRoot}/3gpp-am-influence/v1/{afId}/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 5.18.1.3.2-1.
Table 5.18.1.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
Clause 5.2.4 of 3GPP TS 29.122 [4]. |
afId |
string |
Identifier of the AF. |
subscriptionId |
string |
Identifier of the subscription. |
5.18.1.3.3 Resource Methods
5.18.1.3.3.1 General
The following clauses specify the resource methods supported by the resource as described in clause 5.18.1.3.2.
5.18.1.3.3.2 GET
The GET method allows to read the active subscription for a given AF and subscription Id. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.18.1.3.3.2-1.
Table 5.18.1.3.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
N/A |
This method shall support the request data structures specified in table 5.18.1.3.3.2-2 and the response data structures and response codes specified in table 5.18.1.3.3.2-3.
Table 5.18.1.3.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
N/A |
Table 5.18.1.3.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AmInfluSub |
M |
1 |
200 OK |
The subscription information for the AF in the request URI are returned. |
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.18.1.3.3.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
Table 5.18.1.3.3.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
5.18.1.3.3.3 PUT
The PUT method is used to replace an existing subscription resource to update a subscription. The AF shall initiate the HTTP PUT request message and the NEF shall respond to the message.
This method shall support the request data structures specified in table 5.18.1.3.3.3-1 and the response data structures and response codes specified in table 5.18.1.3.3.3-2.
Table 5.18.1.3.3.3-1: Data structures supported by the PUT Request Body on this resource
Data type |
P |
Cardinality |
Description |
AmInfluSub |
M |
1 |
Modify an existing AM Influence subscription. |
Table 5.18.1.3.3.3-2: Data structures supported by the PUT Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AmInfluSub |
M |
1 |
200 OK |
The subscription was replaced successfully and a representation is returned. |
N/A |
204 No Content |
The subscription was replaced successfully. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.18.1.3.3.3-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
Table 5.18.1.3.3.3-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
5.18.1.3.3.4 PATCH
The PATCH method allows to change some properties of an existing AM influence subscription. The AF shall initiate the HTTP PATCH request message and the NEF shall respond to the message.
This method shall support the request data structures specified in table 5.18.1.3.3.4-1 and the response data structures and response codes specified in table 5.18.1.3.3.4-2.
Table 5.18.1.3.3.4-1: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
AmInfluSubPatch |
M |
1 |
Partial update of a subscription to AM influence and/or notifications about service area coverage outcome events with the NEF. |
Table 5.18.1.3.3.4-2: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AmInfluSub |
M |
1 |
200 OK |
The subscription was partial modified successfully and a representation is returned. |
N/A |
204 No Content |
The subscription was partial modified successfully. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.18.1.3.3.4-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
Table 5.18.1.3.3.4-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
5.18.1.3.3.5 DELETE
The DELETE method deletes an existing individual AM influence subscription for a given AF. The AF shall initiate the HTTP DELETE request message and the NEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.18.1.3.3.5-1.
Table 5.18.1.3.3.5-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
P |
Cardinality |
Description |
N/A |
This method shall support the request data structures specified in table 5.18.1.3.3.5-2 and the response data structures and response codes specified in table 5.18.1.3.3.5-3.
Table 5.18.1.3.3.5-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
N/A |
Table 5.18.1.3.3.5-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
N/A |
204 No Content |
The subscription was terminated successfully. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
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 NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.18.1.3.3.5-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
Table 5.18.1.3.3.5-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF. |
5.18.2 Notifications
5.18.2.1 Introduction
Upon receipt of a service area coverage outcome event from the PCF, the NEF shall send an HTTP POST message including the notified event to the AF.The NEF and the AF shall support the notification mechanism as described in clause 5.2.5 of 3GPP TS 29.122 [4].
Table 5.18.2.1-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
Event Notification |
{notificationDestination} |
POST |
The service area coverage outcome event from the NEF to the AF. |
5.18.2.2 Event Notification
5.18.2.2.1 Description
The Event Notification is used by the NEF to report notification of the service area coverage outcome event from the PCF to the AF.
5.18.2.2.2 Target URI
The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.18.2.2.2-1.
Table 5.18.2.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notificationDestination |
Link |
Callback reference provided by the AF during creation/modification of the subscription within the AmInfluSub data type as defined in Table 5.18.3.3.2-1 or the AmInfluSubPatch data type as defined in Table 5.18.3.3.3-1. |
5.18.2.2.3 Operation Definition
5.18.2.2.3.1 Notification via HTTP POST
This method shall support the request data structures specified in table 5.18.2.2.3.1-1 and the response data structures and response codes specified in table 5.18.2.2.3.1-2.
Table 5.18.2.2.3.1-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
AmInfluEventNotif |
M |
1 |
The service area coverage outcome event notification is provided by the NEF to the AF. |
Table 5.18.2.2.3.1-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
N/A |
204 No Content |
The event notification is received successfully. |
||
N/A |
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 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, during event notification. 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]. |
||
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.18.2.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative AF towards which the notification should be redirected. |
Table 5.18.2.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative AF towards which the notification should be redirected. |
5.18.2.2.3.2 Notification via Websocket
If supported by both AF and NEF and successfully negotiated, the AmInfluEventNotif may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4 of 3GPP TS 29.122 [4].
5.18.3 Data Model
5.18.3.1 General
This clause specifies the application data model supported by the AMInfluence API.
Table 5.18.3.1-1 specifies the data types defined for the AMInfluence API.
Table 5.18.3.1-1: AMInfluence API specific Data Types
Data type |
Clause defined |
Description |
Applicability |
AmInfluEvent |
5.18.3.4.3 |
Represents the service area coverage outcome event. |
|
AmInfluEventNotif |
5.18.3.3.4 |
Represents an AM influence event notification. |
|
AmInfluSub |
5.18.3.3.2 |
Represents an AM influence subscription. |
|
AmInfluSubPatch |
5.18.3.3.3 |
Represents parameters to request the modification of an AM influence subscription resource. |
|
DnnSnssaiInformation |
5.18.3.3.5 |
Represents a (DNN, SNSSAI) combination. |
5.18.3.2 Reused data types
The data types reused by the AMInfluence API from other specifications are listed in table 5.18.3.2-1.
Table 5.18.3.2-1: Re-used Data Types
Data type |
Reference |
Comments |
Dnn |
3GPP TS 29.571 [8] |
Identifies a DNN. |
DurationSec |
3GPP TS 29.122 [4] |
Indicates the time duration. |
DurationSecRm |
3GPP TS 29.122 [4] |
Indicates the time duration, same as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. |
ExternalGroupId |
3GPP TS 29.122 [4] |
External Group Identifier for a user group. |
GeographicalArea |
5.17.3.3.4 |
Identifies the geographical area information. |
Gpsi |
3GPP TS 29.571 [8] |
Identifies a GPSI. |
LinkRm |
3GPP TS 29.122 [4] |
Indicates a referenced resource, same as the "Link" data type, but with the OpenAPI "nullable: true" property. |
Link |
3GPP TS 29.122 [4] |
Identifies a referenced resource. |
Snssai |
3GPP TS 29.571 [8] |
Identifies the S-NSSAI. |
SupportedFeatures |
3GPP TS 29.571 [8] |
Used to negotiate the applicability of the optional features defined in table 5.18.4-1. |
WebsockNotifConfig |
3GPP TS 29.122 [4] |
Contains the configuration parameters to set up notification delivery over Websocket protocol. |
5.18.3.3 Structured data types
5.18.3.3.1 Introduction
This clause defines the structured data types to be used in resource representations.
5.18.3.3.2 Type: AmInfluSub
This type represents an AM influence subscription. The same structure is used in the subscription request and subscription response.
Table 5.18.3.3.2-1: Definition of type AMInfluSub
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability (NOTE 1) |
afTransId |
string |
M |
1 |
Identifies an NEF Northbound interface transaction request, generated by the AF. |
|
gpsi |
Gpsi |
O |
0..1 |
Identifies a user with GPSI. (NOTE 3) |
|
externalGroupId |
ExternalGroupId |
O |
0..1 |
Identifies a group of users. (NOTE 3) |
|
anyUeInd |
boolean |
O |
0..1 |
Identifies whether the AF request applies to any UE (i.e. all UEs). This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE 2) (NOTE 3) |
|
dnnSnssaiInfos |
array(DnnSnssaiInformation) |
O |
1..N |
Each of the element identifies a combination of (DNN, S-NSSAI). |
|
afAppIds |
array(string) |
O |
1..N |
Identifies application(s). |
|
highThruInd |
boolean |
C |
0..1 |
Indicates whether high throughput is desired for UE traffic. Set to "true" if high throughput is desired; otherwise set to "false". Default value is "false" if omitted. (NOTE 4) |
|
geoAreas |
array(GeographicalArea) |
C |
1..N |
Identifies geographical areas of the user where the request is applicable. (NOTE 4) |
|
policyDuration |
DurationSec |
O |
0..1 |
Indicates the time duration that the policy shall last. |
|
self |
Link |
C |
0..1 |
Link to the created resource. This parameter shall be supplied by the NEF in HTTP responses that include an object of AmInfluSub type. |
|
subscribedEvents |
array(AmInfluEvent) |
O |
1..N |
Identifies the requirement to be notified of the event(s). |
|
notificationDestination |
Link |
C |
0..1 |
Contains the Callback URL to receive the notification from the NEF. It shall be present if the "subscribedEvents" is present. |
|
requestTestNotification |
boolean |
O |
0..1 |
Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122 [4]. Set to false or omitted otherwise. |
Notification_test_event |
websockNotifConfig |
WebsockNotifConfig |
O |
0..1 |
Configuration parameters to set up notification delivery over Websocket protocol. |
Notification_websocket |
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the list of Supported features used as described in clause 5.18.4. This attribute shall be provided in the POST request and in the response of successful resource creation. |
|
NOTE 1: Properties marked with a feature as defined in clause 5.18.4 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [4]. If no feature is indicated, the related property applies for all the features. NOTE 2: If target to any UE, then "anyUeInd" attribute together with "dnnSnssaiInfos" attribute shall be included. NOTE 3: One of individual UE identifier (i.e. "gpsi" attribute), External Group Identifier (i.e. "externalGroupId") or any UE indication "anyUeInd" shall be included. "anyUeInd" attribute is applicable only if an Application ID is also provided. NOTE 4: Any of the "highThruInd" attribute or "geoAreas" attribute shall be included. |
5.18.3.3.3 Type: AmInfluSubPatch
This type represents AM influence subscription parameters provided by the AF to the NEF. The structure is used for HTTP PATCH request.
Table 5.18.3.3.3-1: Definition of type AmInfluSubPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
highThruInd |
boolean |
O |
0..1 |
Indicates whether high throughput is desired for UE traffic. Set to "true" if high throughput is desired; otherwise set to "false". |
|
geoAreas |
array(GeographicalArea) |
O |
1..N |
Identifies geographical areas of the user where the UE is located. (NOTE 1) |
|
policyDuration |
DurationSecRm |
O |
0..1 |
Indicates the time duration that the policy shall last. (NOTE 1) |
|
dnnSnssaiInfos |
array(DnnSnssaiInformation) |
O |
1..N |
Each of the element identifies a combination of (DNN, S-NSSAI). (NOTE 1) |
|
subscribedEvents |
array(AmInfluEvent) |
O |
1..N |
Identifies the requirement to be notified of the event(s). (NOTE 1) |
|
notificationDestination |
LinkRm |
O |
0..1 |
Contains the Callback URL to receive the notification from the NEF. (NOTE 1, NOTE 2) |
|
afAppIds |
array(string) |
O |
1..N |
Identifies application(s). (NOTE 1) |
|
NOTE 1: The value of the property shall be set to NULL for removal. NOTE 2: The notificationDestination attribute set to NULL may be included only if the subscribedEvents attribute is included and set to NULL. |
5.18.3.3.4 Type: AmInfluEventNotif
Table 5.18.3.3.4-1: Definition of type AmInfluEventNotif
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability (NOTE 1) |
afTransId |
string |
M |
1 |
Identifies the AF request for AM policy influence that the event report is related to. |
|
event |
AmInfluEvent |
M |
1 |
Notified event. |
|
geoAreas |
array(GeographicalArea) |
C |
1..N |
Identifies geographical areas of the user where the UE is located. |
5.18.3.3.5 Type: DnnSnssaiInformation
Table 5.18.3.3.5-1: Definition of type DnnSnssaiInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
dnn |
Dnn |
O |
0..1 |
Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. |
|
snssai |
Snssai |
O |
0..1 |
Identifies an S-NSSAI. |
5.18.3.4 Simple data types and enumerations
5.18.3.4.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
5.18.3.4.2 Simple data types
The simple data types defined in table 5.18.3.4.2-1 shall be supported.
Table 5.18.3.4.2-1: Simple data types
Type Name |
Type Definition |
Description |
Applicability |
5.18.3.4.3 Enumeration: AmInfluEvent
The enumeration AmInfluEvent represents the service area coverage outcome event. It shall comply with the provisions defined in table 5.18.3.4.3-1.
Table 5.18.3.4.3-1: Enumeration AmInfluEvent
Enumeration value |
Description |
SERVICE_AREA_COVRG_OUTCOME |
Indicates the service area coverage outcome. |
5.18.4 Used Features
The table below defines the features applicable to the AMInfluence API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].
Table 5.18.4-1: Features used by AMInfluence API
Feature number |
Feature Name |
Description |
1 |
Notification_websocket |
The delivery of notifications over Websocket is supported as described in 3GPP TS 29.122 [4]. This feature requires that the Notification_test_event feature is also supported. |
2 |
Notification_test_event |
The testing of notification connection is supported as described in 3GPP TS 29.122 [4]. |
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature. |
5.18.5 Error handling
5.18.5.1 General
HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].
In addition, the requirements in the following clauses shall apply.
5.18.5.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the AMInfluence API.
5.18.5.3 Application Errors
The application errors defined for AMInfluence API are listed in table 5.18.5.3-1.
Table 5.18.5.3-1: Application errors
Application Error |
HTTP status code |
Description |
Applicability |